particle-api-js 10.4.0 → 10.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +528 -528
- package/package.json +1 -1
- package/src/Particle.js +3 -3
- package/test/Particle.spec.js +6 -3
package/docs/api.md
CHANGED
|
@@ -529,7 +529,7 @@
|
|
|
529
529
|
|
|
530
530
|
## Particle
|
|
531
531
|
|
|
532
|
-
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/
|
|
532
|
+
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L26-L2761 "Source code on GitHub")
|
|
533
533
|
|
|
534
534
|
**Parameters**
|
|
535
535
|
|
|
@@ -537,7 +537,7 @@
|
|
|
537
537
|
|
|
538
538
|
### constructor
|
|
539
539
|
|
|
540
|
-
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/
|
|
540
|
+
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L39-L48 "Source code on GitHub")
|
|
541
541
|
|
|
542
542
|
Contructor for the Cloud API wrapper.
|
|
543
543
|
|
|
@@ -554,7 +554,7 @@ Create a new Particle object and call methods below on it.
|
|
|
554
554
|
|
|
555
555
|
### login
|
|
556
556
|
|
|
557
|
-
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/
|
|
557
|
+
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L85-L102 "Source code on GitHub")
|
|
558
558
|
|
|
559
559
|
Login to Particle Cloud using an existing Particle acccount.
|
|
560
560
|
|
|
@@ -571,7 +571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
571
571
|
|
|
572
572
|
### sendOtp
|
|
573
573
|
|
|
574
|
-
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/
|
|
574
|
+
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L113-L129 "Source code on GitHub")
|
|
575
575
|
|
|
576
576
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
577
577
|
|
|
@@ -587,7 +587,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
587
587
|
|
|
588
588
|
### enableMfa
|
|
589
589
|
|
|
590
|
-
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/
|
|
590
|
+
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L139-L141 "Source code on GitHub")
|
|
591
591
|
|
|
592
592
|
Enable MFA on the currently logged in user
|
|
593
593
|
|
|
@@ -602,7 +602,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
602
602
|
|
|
603
603
|
### confirmMfa
|
|
604
604
|
|
|
605
|
-
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/
|
|
605
|
+
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L154-L168 "Source code on GitHub")
|
|
606
606
|
|
|
607
607
|
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.
|
|
608
608
|
|
|
@@ -620,7 +620,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
620
620
|
|
|
621
621
|
### disableMfa
|
|
622
622
|
|
|
623
|
-
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/
|
|
623
|
+
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L179-L187 "Source code on GitHub")
|
|
624
624
|
|
|
625
625
|
Disable MFA for the user.
|
|
626
626
|
|
|
@@ -636,7 +636,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
636
636
|
|
|
637
637
|
### createCustomer
|
|
638
638
|
|
|
639
|
-
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/
|
|
639
|
+
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L199-L215 "Source code on GitHub")
|
|
640
640
|
|
|
641
641
|
Create Customer for Product.
|
|
642
642
|
|
|
@@ -653,7 +653,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
653
653
|
|
|
654
654
|
### loginAsClientOwner
|
|
655
655
|
|
|
656
|
-
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/
|
|
656
|
+
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L224-L238 "Source code on GitHub")
|
|
657
657
|
|
|
658
658
|
Login to Particle Cloud using an OAuth client.
|
|
659
659
|
|
|
@@ -667,7 +667,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
667
667
|
|
|
668
668
|
### createUser
|
|
669
669
|
|
|
670
|
-
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/
|
|
670
|
+
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L250-L261 "Source code on GitHub")
|
|
671
671
|
|
|
672
672
|
Create a user account for the Particle Cloud
|
|
673
673
|
|
|
@@ -684,7 +684,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
684
684
|
|
|
685
685
|
### verifyUser
|
|
686
686
|
|
|
687
|
-
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/
|
|
687
|
+
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L271-L278 "Source code on GitHub")
|
|
688
688
|
|
|
689
689
|
Verify new user account via verification email
|
|
690
690
|
|
|
@@ -699,7 +699,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
699
699
|
|
|
700
700
|
### resetPassword
|
|
701
701
|
|
|
702
|
-
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/
|
|
702
|
+
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L288-L295 "Source code on GitHub")
|
|
703
703
|
|
|
704
704
|
Send reset password email for a Particle Cloud user account
|
|
705
705
|
|
|
@@ -714,7 +714,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
714
714
|
|
|
715
715
|
### deleteAccessToken
|
|
716
716
|
|
|
717
|
-
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/
|
|
717
|
+
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L307-L315 "Source code on GitHub")
|
|
718
718
|
|
|
719
719
|
Revoke an access token
|
|
720
720
|
|
|
@@ -731,7 +731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
731
731
|
|
|
732
732
|
### deleteCurrentAccessToken
|
|
733
733
|
|
|
734
|
-
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/
|
|
734
|
+
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L325-L332 "Source code on GitHub")
|
|
735
735
|
|
|
736
736
|
Revoke the current session access token
|
|
737
737
|
|
|
@@ -746,7 +746,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
746
746
|
|
|
747
747
|
### deleteActiveAccessTokens
|
|
748
748
|
|
|
749
|
-
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/
|
|
749
|
+
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L342-L349 "Source code on GitHub")
|
|
750
750
|
|
|
751
751
|
Revoke all active access tokens
|
|
752
752
|
|
|
@@ -761,7 +761,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
761
761
|
|
|
762
762
|
### deleteUser
|
|
763
763
|
|
|
764
|
-
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/
|
|
764
|
+
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L360-L368 "Source code on GitHub")
|
|
765
765
|
|
|
766
766
|
Delete the current user
|
|
767
767
|
|
|
@@ -777,7 +777,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
777
777
|
|
|
778
778
|
### listAccessTokens
|
|
779
779
|
|
|
780
|
-
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/
|
|
780
|
+
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L380-L388 "Source code on GitHub")
|
|
781
781
|
|
|
782
782
|
List all valid access tokens for a Particle Cloud account
|
|
783
783
|
|
|
@@ -794,7 +794,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
794
794
|
|
|
795
795
|
### trackingIdentity
|
|
796
796
|
|
|
797
|
-
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/
|
|
797
|
+
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L400-L408 "Source code on GitHub")
|
|
798
798
|
|
|
799
799
|
Retrieves the information that is used to identify the current login for tracking.
|
|
800
800
|
|
|
@@ -811,7 +811,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
811
811
|
|
|
812
812
|
### listDevices
|
|
813
813
|
|
|
814
|
-
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/
|
|
814
|
+
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L426-L445 "Source code on GitHub")
|
|
815
815
|
|
|
816
816
|
List devices claimed to the account or product
|
|
817
817
|
|
|
@@ -834,7 +834,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
834
834
|
|
|
835
835
|
### getDevice
|
|
836
836
|
|
|
837
|
-
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/
|
|
837
|
+
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L457-L460 "Source code on GitHub")
|
|
838
838
|
|
|
839
839
|
Get detailed informationa about a device
|
|
840
840
|
|
|
@@ -851,7 +851,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
851
851
|
|
|
852
852
|
### claimDevice
|
|
853
853
|
|
|
854
|
-
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/
|
|
854
|
+
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L472-L483 "Source code on GitHub")
|
|
855
855
|
|
|
856
856
|
Claim a device to the account. The device must be online and unclaimed.
|
|
857
857
|
|
|
@@ -868,7 +868,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
868
868
|
|
|
869
869
|
### addDeviceToProduct
|
|
870
870
|
|
|
871
|
-
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/
|
|
871
|
+
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L497-L515 "Source code on GitHub")
|
|
872
872
|
|
|
873
873
|
Add a device to a product or move device out of quarantine.
|
|
874
874
|
|
|
@@ -887,7 +887,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
887
887
|
|
|
888
888
|
### removeDevice
|
|
889
889
|
|
|
890
|
-
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/
|
|
890
|
+
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L528-L532 "Source code on GitHub")
|
|
891
891
|
|
|
892
892
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
893
893
|
|
|
@@ -905,7 +905,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
905
905
|
|
|
906
906
|
### removeDeviceOwner
|
|
907
907
|
|
|
908
|
-
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/
|
|
908
|
+
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L544-L547 "Source code on GitHub")
|
|
909
909
|
|
|
910
910
|
Unclaim a product device its the owner, but keep it in the product
|
|
911
911
|
|
|
@@ -922,7 +922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
922
922
|
|
|
923
923
|
### renameDevice
|
|
924
924
|
|
|
925
|
-
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/
|
|
925
|
+
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L560-L562 "Source code on GitHub")
|
|
926
926
|
|
|
927
927
|
Rename a device
|
|
928
928
|
|
|
@@ -940,7 +940,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
940
940
|
|
|
941
941
|
### signalDevice
|
|
942
942
|
|
|
943
|
-
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/
|
|
943
|
+
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L575-L577 "Source code on GitHub")
|
|
944
944
|
|
|
945
945
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
946
946
|
|
|
@@ -958,7 +958,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
958
958
|
|
|
959
959
|
### setDeviceNotes
|
|
960
960
|
|
|
961
|
-
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/
|
|
961
|
+
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L590-L592 "Source code on GitHub")
|
|
962
962
|
|
|
963
963
|
Store some notes about device
|
|
964
964
|
|
|
@@ -976,7 +976,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
976
976
|
|
|
977
977
|
### markAsDevelopmentDevice
|
|
978
978
|
|
|
979
|
-
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/
|
|
979
|
+
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L605-L607 "Source code on GitHub")
|
|
980
980
|
|
|
981
981
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
982
982
|
|
|
@@ -994,7 +994,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
994
994
|
|
|
995
995
|
### lockDeviceProductFirmware
|
|
996
996
|
|
|
997
|
-
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/
|
|
997
|
+
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L621-L623 "Source code on GitHub")
|
|
998
998
|
|
|
999
999
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
1000
1000
|
|
|
@@ -1013,7 +1013,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1013
1013
|
|
|
1014
1014
|
### unlockDeviceProductFirmware
|
|
1015
1015
|
|
|
1016
|
-
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/
|
|
1016
|
+
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L635-L637 "Source code on GitHub")
|
|
1017
1017
|
|
|
1018
1018
|
Mark device as receiving automatic firmware updates
|
|
1019
1019
|
|
|
@@ -1030,7 +1030,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1030
1030
|
|
|
1031
1031
|
### updateDevice
|
|
1032
1032
|
|
|
1033
|
-
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/
|
|
1033
|
+
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L656-L668 "Source code on GitHub")
|
|
1034
1034
|
|
|
1035
1035
|
Update multiple device attributes at the same time
|
|
1036
1036
|
|
|
@@ -1054,7 +1054,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1054
1054
|
|
|
1055
1055
|
### provisionDevice
|
|
1056
1056
|
|
|
1057
|
-
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/
|
|
1057
|
+
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L679-L687 "Source code on GitHub")
|
|
1058
1058
|
|
|
1059
1059
|
Provision a new device for products that allow self-provisioning
|
|
1060
1060
|
|
|
@@ -1070,7 +1070,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1070
1070
|
|
|
1071
1071
|
### getClaimCode
|
|
1072
1072
|
|
|
1073
|
-
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/
|
|
1073
|
+
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L701-L704 "Source code on GitHub")
|
|
1074
1074
|
|
|
1075
1075
|
Generate a claim code to use in the device claiming process.
|
|
1076
1076
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -1089,7 +1089,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1089
1089
|
|
|
1090
1090
|
### getVariable
|
|
1091
1091
|
|
|
1092
|
-
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/
|
|
1092
|
+
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L736-L742 "Source code on GitHub")
|
|
1093
1093
|
|
|
1094
1094
|
Get the value of a device variable
|
|
1095
1095
|
|
|
@@ -1107,7 +1107,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1107
1107
|
|
|
1108
1108
|
### flashDevice
|
|
1109
1109
|
|
|
1110
|
-
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/
|
|
1110
|
+
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L756-L767 "Source code on GitHub")
|
|
1111
1111
|
|
|
1112
1112
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
1113
1113
|
|
|
@@ -1126,7 +1126,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1126
1126
|
|
|
1127
1127
|
### flashTinker
|
|
1128
1128
|
|
|
1129
|
-
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/
|
|
1129
|
+
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L778-L793 "Source code on GitHub")
|
|
1130
1130
|
|
|
1131
1131
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
1132
1132
|
|
|
@@ -1142,7 +1142,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1142
1142
|
|
|
1143
1143
|
### compileCode
|
|
1144
1144
|
|
|
1145
|
-
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/
|
|
1145
|
+
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L806-L824 "Source code on GitHub")
|
|
1146
1146
|
|
|
1147
1147
|
Compile firmware using the Particle Cloud
|
|
1148
1148
|
|
|
@@ -1160,7 +1160,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1160
1160
|
|
|
1161
1161
|
### downloadFirmwareBinary
|
|
1162
1162
|
|
|
1163
|
-
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/
|
|
1163
|
+
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L835-L844 "Source code on GitHub")
|
|
1164
1164
|
|
|
1165
1165
|
Download a firmware binary
|
|
1166
1166
|
|
|
@@ -1176,7 +1176,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1176
1176
|
|
|
1177
1177
|
### sendPublicKey
|
|
1178
1178
|
|
|
1179
|
-
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/
|
|
1179
|
+
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L857-L871 "Source code on GitHub")
|
|
1180
1180
|
|
|
1181
1181
|
Send a new device public key to the Particle Cloud
|
|
1182
1182
|
|
|
@@ -1194,7 +1194,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1194
1194
|
|
|
1195
1195
|
### callFunction
|
|
1196
1196
|
|
|
1197
|
-
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/
|
|
1197
|
+
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L885-L890 "Source code on GitHub")
|
|
1198
1198
|
|
|
1199
1199
|
Call a device function
|
|
1200
1200
|
|
|
@@ -1213,7 +1213,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1213
1213
|
|
|
1214
1214
|
### getEventStream
|
|
1215
1215
|
|
|
1216
|
-
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/
|
|
1216
|
+
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L903-L928 "Source code on GitHub")
|
|
1217
1217
|
|
|
1218
1218
|
Get a stream of events
|
|
1219
1219
|
|
|
@@ -1231,7 +1231,7 @@ emit 'event' events.
|
|
|
1231
1231
|
|
|
1232
1232
|
### publishEvent
|
|
1233
1233
|
|
|
1234
|
-
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/
|
|
1234
|
+
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L942-L946 "Source code on GitHub")
|
|
1235
1235
|
|
|
1236
1236
|
Publish a event to the Particle Cloud
|
|
1237
1237
|
|
|
@@ -1250,7 +1250,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1250
1250
|
|
|
1251
1251
|
### Hook
|
|
1252
1252
|
|
|
1253
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
1253
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
1254
1254
|
|
|
1255
1255
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
1256
1256
|
|
|
@@ -1283,7 +1283,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
1283
1283
|
|
|
1284
1284
|
### createWebhook
|
|
1285
1285
|
|
|
1286
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
1286
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
1287
1287
|
|
|
1288
1288
|
Create a webhook
|
|
1289
1289
|
|
|
@@ -1305,7 +1305,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1305
1305
|
|
|
1306
1306
|
### deleteWebhook
|
|
1307
1307
|
|
|
1308
|
-
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/
|
|
1308
|
+
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1011-L1014 "Source code on GitHub")
|
|
1309
1309
|
|
|
1310
1310
|
Delete a webhook
|
|
1311
1311
|
|
|
@@ -1322,7 +1322,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1322
1322
|
|
|
1323
1323
|
### listWebhooks
|
|
1324
1324
|
|
|
1325
|
-
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/
|
|
1325
|
+
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1025-L1028 "Source code on GitHub")
|
|
1326
1326
|
|
|
1327
1327
|
List all webhooks owned by the account or product
|
|
1328
1328
|
|
|
@@ -1338,7 +1338,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1338
1338
|
|
|
1339
1339
|
### createIntegration
|
|
1340
1340
|
|
|
1341
|
-
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/
|
|
1341
|
+
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1045-L1049 "Source code on GitHub")
|
|
1342
1342
|
|
|
1343
1343
|
Create an integration to send events to an external service
|
|
1344
1344
|
|
|
@@ -1359,7 +1359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1359
1359
|
|
|
1360
1360
|
### editIntegration
|
|
1361
1361
|
|
|
1362
|
-
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/
|
|
1362
|
+
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1067-L1071 "Source code on GitHub")
|
|
1363
1363
|
|
|
1364
1364
|
Edit an integration to send events to an external service
|
|
1365
1365
|
|
|
@@ -1381,7 +1381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1381
1381
|
|
|
1382
1382
|
### deleteIntegration
|
|
1383
1383
|
|
|
1384
|
-
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/
|
|
1384
|
+
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1084-L1087 "Source code on GitHub")
|
|
1385
1385
|
|
|
1386
1386
|
Delete an integration to send events to an external service
|
|
1387
1387
|
|
|
@@ -1398,7 +1398,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1398
1398
|
|
|
1399
1399
|
### listIntegrations
|
|
1400
1400
|
|
|
1401
|
-
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
1401
|
+
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1098-L1101 "Source code on GitHub")
|
|
1402
1402
|
|
|
1403
1403
|
List all integrations owned by the account or product
|
|
1404
1404
|
|
|
@@ -1414,7 +1414,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1414
1414
|
|
|
1415
1415
|
### getUserInfo
|
|
1416
1416
|
|
|
1417
|
-
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/
|
|
1417
|
+
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1111-L1113 "Source code on GitHub")
|
|
1418
1418
|
|
|
1419
1419
|
Get details about the current user
|
|
1420
1420
|
|
|
@@ -1429,7 +1429,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1429
1429
|
|
|
1430
1430
|
### setUserInfo
|
|
1431
1431
|
|
|
1432
|
-
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/
|
|
1432
|
+
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1124-L1127 "Source code on GitHub")
|
|
1433
1433
|
|
|
1434
1434
|
Set details on the current user
|
|
1435
1435
|
|
|
@@ -1445,7 +1445,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1445
1445
|
|
|
1446
1446
|
### changeUsername
|
|
1447
1447
|
|
|
1448
|
-
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/
|
|
1448
|
+
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1140-L1148 "Source code on GitHub")
|
|
1449
1449
|
|
|
1450
1450
|
Change username (i.e, email)
|
|
1451
1451
|
|
|
@@ -1463,7 +1463,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1463
1463
|
|
|
1464
1464
|
### changeUserPassword
|
|
1465
1465
|
|
|
1466
|
-
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/
|
|
1466
|
+
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1161-L1169 "Source code on GitHub")
|
|
1467
1467
|
|
|
1468
1468
|
Change user's password
|
|
1469
1469
|
|
|
@@ -1481,7 +1481,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1481
1481
|
|
|
1482
1482
|
### listSIMs
|
|
1483
1483
|
|
|
1484
|
-
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/
|
|
1484
|
+
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1185-L1189 "Source code on GitHub")
|
|
1485
1485
|
|
|
1486
1486
|
List SIM cards owned by a user or product
|
|
1487
1487
|
|
|
@@ -1502,7 +1502,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1502
1502
|
|
|
1503
1503
|
### getSIMDataUsage
|
|
1504
1504
|
|
|
1505
|
-
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/
|
|
1505
|
+
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1201-L1207 "Source code on GitHub")
|
|
1506
1506
|
|
|
1507
1507
|
Get data usage for one SIM card for the current billing period
|
|
1508
1508
|
|
|
@@ -1519,7 +1519,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1519
1519
|
|
|
1520
1520
|
### getFleetDataUsage
|
|
1521
1521
|
|
|
1522
|
-
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/
|
|
1522
|
+
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1218-L1225 "Source code on GitHub")
|
|
1523
1523
|
|
|
1524
1524
|
Get data usage for all SIM cards in a product the current billing period
|
|
1525
1525
|
|
|
@@ -1535,7 +1535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1535
1535
|
|
|
1536
1536
|
### checkSIM
|
|
1537
1537
|
|
|
1538
|
-
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/
|
|
1538
|
+
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1236-L1238 "Source code on GitHub")
|
|
1539
1539
|
|
|
1540
1540
|
Check SIM status
|
|
1541
1541
|
|
|
@@ -1551,7 +1551,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1551
1551
|
|
|
1552
1552
|
### activateSIM
|
|
1553
1553
|
|
|
1554
|
-
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/
|
|
1554
|
+
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1253-L1263 "Source code on GitHub")
|
|
1555
1555
|
|
|
1556
1556
|
Activate and add SIM cards to an account or product
|
|
1557
1557
|
|
|
@@ -1571,7 +1571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1571
1571
|
|
|
1572
1572
|
### deactivateSIM
|
|
1573
1573
|
|
|
1574
|
-
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/
|
|
1574
|
+
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1275-L1279 "Source code on GitHub")
|
|
1575
1575
|
|
|
1576
1576
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1577
1577
|
|
|
@@ -1588,7 +1588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1588
1588
|
|
|
1589
1589
|
### reactivateSIM
|
|
1590
1590
|
|
|
1591
|
-
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/
|
|
1591
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
1592
1592
|
|
|
1593
1593
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1594
1594
|
|
|
@@ -1606,7 +1606,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1606
1606
|
|
|
1607
1607
|
### updateSIM
|
|
1608
1608
|
|
|
1609
|
-
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/
|
|
1609
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
1610
1610
|
|
|
1611
1611
|
Update SIM card data limit
|
|
1612
1612
|
|
|
@@ -1624,7 +1624,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1624
1624
|
|
|
1625
1625
|
### removeSIM
|
|
1626
1626
|
|
|
1627
|
-
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/
|
|
1627
|
+
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1325-L1328 "Source code on GitHub")
|
|
1628
1628
|
|
|
1629
1629
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1630
1630
|
|
|
@@ -1641,7 +1641,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1641
1641
|
|
|
1642
1642
|
### listBuildTargets
|
|
1643
1643
|
|
|
1644
|
-
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/
|
|
1644
|
+
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1339-L1342 "Source code on GitHub")
|
|
1645
1645
|
|
|
1646
1646
|
List valid build targets to be used for compiling
|
|
1647
1647
|
|
|
@@ -1657,7 +1657,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1657
1657
|
|
|
1658
1658
|
### listLibraries
|
|
1659
1659
|
|
|
1660
|
-
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/
|
|
1660
|
+
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1368-L1385 "Source code on GitHub")
|
|
1661
1661
|
|
|
1662
1662
|
List firmware libraries
|
|
1663
1663
|
|
|
@@ -1687,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1687
1687
|
|
|
1688
1688
|
### getLibrary
|
|
1689
1689
|
|
|
1690
|
-
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/
|
|
1690
|
+
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1401-L1409 "Source code on GitHub")
|
|
1691
1691
|
|
|
1692
1692
|
Get firmware library details
|
|
1693
1693
|
|
|
@@ -1704,7 +1704,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1704
1704
|
|
|
1705
1705
|
### getLibraryVersions
|
|
1706
1706
|
|
|
1707
|
-
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/
|
|
1707
|
+
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1422-L1430 "Source code on GitHub")
|
|
1708
1708
|
|
|
1709
1709
|
Firmware library details for each version
|
|
1710
1710
|
|
|
@@ -1722,7 +1722,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1722
1722
|
|
|
1723
1723
|
### contributeLibrary
|
|
1724
1724
|
|
|
1725
|
-
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/
|
|
1725
|
+
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1442-L1455 "Source code on GitHub")
|
|
1726
1726
|
|
|
1727
1727
|
Contribute a new library version from a compressed archive
|
|
1728
1728
|
|
|
@@ -1739,7 +1739,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1739
1739
|
|
|
1740
1740
|
### publishLibrary
|
|
1741
1741
|
|
|
1742
|
-
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/
|
|
1742
|
+
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1466-L1475 "Source code on GitHub")
|
|
1743
1743
|
|
|
1744
1744
|
Publish the latest version of a library to the public
|
|
1745
1745
|
|
|
@@ -1755,7 +1755,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1755
1755
|
|
|
1756
1756
|
### deleteLibrary
|
|
1757
1757
|
|
|
1758
|
-
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
1758
|
+
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1487-L1495 "Source code on GitHub")
|
|
1759
1759
|
|
|
1760
1760
|
Delete one version of a library or an entire private library
|
|
1761
1761
|
|
|
@@ -1772,7 +1772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1772
1772
|
|
|
1773
1773
|
### downloadFile
|
|
1774
1774
|
|
|
1775
|
-
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/
|
|
1775
|
+
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1505-L1507 "Source code on GitHub")
|
|
1776
1776
|
|
|
1777
1777
|
Download an external file that may not be on the API
|
|
1778
1778
|
|
|
@@ -1787,7 +1787,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1787
1787
|
|
|
1788
1788
|
### listOAuthClients
|
|
1789
1789
|
|
|
1790
|
-
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/
|
|
1790
|
+
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1518-L1521 "Source code on GitHub")
|
|
1791
1791
|
|
|
1792
1792
|
List OAuth client created by the account
|
|
1793
1793
|
|
|
@@ -1803,7 +1803,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1803
1803
|
|
|
1804
1804
|
### createOAuthClient
|
|
1805
1805
|
|
|
1806
|
-
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/
|
|
1806
|
+
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1536-L1540 "Source code on GitHub")
|
|
1807
1807
|
|
|
1808
1808
|
Create an OAuth client
|
|
1809
1809
|
|
|
@@ -1823,7 +1823,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1823
1823
|
|
|
1824
1824
|
### updateOAuthClient
|
|
1825
1825
|
|
|
1826
|
-
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/
|
|
1826
|
+
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1554-L1558 "Source code on GitHub")
|
|
1827
1827
|
|
|
1828
1828
|
Update an OAuth client
|
|
1829
1829
|
|
|
@@ -1842,7 +1842,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1842
1842
|
|
|
1843
1843
|
### deleteOAuthClient
|
|
1844
1844
|
|
|
1845
|
-
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
1845
|
+
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1570-L1573 "Source code on GitHub")
|
|
1846
1846
|
|
|
1847
1847
|
Delete an OAuth client
|
|
1848
1848
|
|
|
@@ -1859,7 +1859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1859
1859
|
|
|
1860
1860
|
### listProducts
|
|
1861
1861
|
|
|
1862
|
-
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/
|
|
1862
|
+
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1583-L1585 "Source code on GitHub")
|
|
1863
1863
|
|
|
1864
1864
|
List products the account has access to
|
|
1865
1865
|
|
|
@@ -1874,7 +1874,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1874
1874
|
|
|
1875
1875
|
### getProduct
|
|
1876
1876
|
|
|
1877
|
-
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/
|
|
1877
|
+
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1596-L1598 "Source code on GitHub")
|
|
1878
1878
|
|
|
1879
1879
|
Get detailed information about a product
|
|
1880
1880
|
|
|
@@ -1890,7 +1890,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1890
1890
|
|
|
1891
1891
|
### listProductFirmware
|
|
1892
1892
|
|
|
1893
|
-
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/
|
|
1893
|
+
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1609-L1611 "Source code on GitHub")
|
|
1894
1894
|
|
|
1895
1895
|
List product firmware versions
|
|
1896
1896
|
|
|
@@ -1906,7 +1906,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1906
1906
|
|
|
1907
1907
|
### uploadProductFirmware
|
|
1908
1908
|
|
|
1909
|
-
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/
|
|
1909
|
+
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1627-L1643 "Source code on GitHub")
|
|
1910
1910
|
|
|
1911
1911
|
List product firmware versions
|
|
1912
1912
|
|
|
@@ -1927,7 +1927,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1927
1927
|
|
|
1928
1928
|
### getProductFirmware
|
|
1929
1929
|
|
|
1930
|
-
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/
|
|
1930
|
+
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1655-L1662 "Source code on GitHub")
|
|
1931
1931
|
|
|
1932
1932
|
Get information about a product firmware version
|
|
1933
1933
|
|
|
@@ -1944,7 +1944,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1944
1944
|
|
|
1945
1945
|
### updateProductFirmware
|
|
1946
1946
|
|
|
1947
|
-
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/
|
|
1947
|
+
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1676-L1679 "Source code on GitHub")
|
|
1948
1948
|
|
|
1949
1949
|
Update information for a product firmware version
|
|
1950
1950
|
|
|
@@ -1963,7 +1963,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1963
1963
|
|
|
1964
1964
|
### downloadProductFirmware
|
|
1965
1965
|
|
|
1966
|
-
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/
|
|
1966
|
+
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1691-L1700 "Source code on GitHub")
|
|
1967
1967
|
|
|
1968
1968
|
Download a product firmware binary
|
|
1969
1969
|
|
|
@@ -1980,7 +1980,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1980
1980
|
|
|
1981
1981
|
### releaseProductFirmware
|
|
1982
1982
|
|
|
1983
|
-
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/
|
|
1983
|
+
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1712-L1715 "Source code on GitHub")
|
|
1984
1984
|
|
|
1985
1985
|
Release a product firmware version as the default version
|
|
1986
1986
|
|
|
@@ -1997,7 +1997,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1997
1997
|
|
|
1998
1998
|
### listTeamMembers
|
|
1999
1999
|
|
|
2000
|
-
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/
|
|
2000
|
+
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1726-L1733 "Source code on GitHub")
|
|
2001
2001
|
|
|
2002
2002
|
List product team members
|
|
2003
2003
|
|
|
@@ -2013,7 +2013,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2013
2013
|
|
|
2014
2014
|
### inviteTeamMember
|
|
2015
2015
|
|
|
2016
|
-
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/
|
|
2016
|
+
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1745-L1753 "Source code on GitHub")
|
|
2017
2017
|
|
|
2018
2018
|
Invite Particle user to a product team
|
|
2019
2019
|
|
|
@@ -2030,7 +2030,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2030
2030
|
|
|
2031
2031
|
### removeTeamMember
|
|
2032
2032
|
|
|
2033
|
-
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/
|
|
2033
|
+
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1765-L1772 "Source code on GitHub")
|
|
2034
2034
|
|
|
2035
2035
|
Remove Particle user to a product team
|
|
2036
2036
|
|
|
@@ -2047,7 +2047,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2047
2047
|
|
|
2048
2048
|
### lookupSerialNumber
|
|
2049
2049
|
|
|
2050
|
-
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/
|
|
2050
|
+
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1783-L1790 "Source code on GitHub")
|
|
2051
2051
|
|
|
2052
2052
|
Fetch details about a serial number
|
|
2053
2053
|
|
|
@@ -2063,7 +2063,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2063
2063
|
|
|
2064
2064
|
### createMeshNetwork
|
|
2065
2065
|
|
|
2066
|
-
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/
|
|
2066
|
+
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1803-L1811 "Source code on GitHub")
|
|
2067
2067
|
|
|
2068
2068
|
Create a mesh network
|
|
2069
2069
|
|
|
@@ -2081,7 +2081,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2081
2081
|
|
|
2082
2082
|
### removeMeshNetwork
|
|
2083
2083
|
|
|
2084
|
-
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/
|
|
2084
|
+
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1822-L1824 "Source code on GitHub")
|
|
2085
2085
|
|
|
2086
2086
|
Remove a mesh network.
|
|
2087
2087
|
|
|
@@ -2097,7 +2097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2097
2097
|
|
|
2098
2098
|
### listMeshNetworks
|
|
2099
2099
|
|
|
2100
|
-
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/
|
|
2100
|
+
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1836-L1839 "Source code on GitHub")
|
|
2101
2101
|
|
|
2102
2102
|
List all mesh networks
|
|
2103
2103
|
|
|
@@ -2114,7 +2114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2114
2114
|
|
|
2115
2115
|
### getMeshNetwork
|
|
2116
2116
|
|
|
2117
|
-
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/
|
|
2117
|
+
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1850-L1852 "Source code on GitHub")
|
|
2118
2118
|
|
|
2119
2119
|
Get information about a mesh network.
|
|
2120
2120
|
|
|
@@ -2130,7 +2130,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2130
2130
|
|
|
2131
2131
|
### updateMeshNetwork
|
|
2132
2132
|
|
|
2133
|
-
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/
|
|
2133
|
+
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1865-L1873 "Source code on GitHub")
|
|
2134
2134
|
|
|
2135
2135
|
Modify a mesh network.
|
|
2136
2136
|
|
|
@@ -2148,7 +2148,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2148
2148
|
|
|
2149
2149
|
### addMeshNetworkDevice
|
|
2150
2150
|
|
|
2151
|
-
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/
|
|
2151
|
+
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1885-L1894 "Source code on GitHub")
|
|
2152
2152
|
|
|
2153
2153
|
Add a device to a mesh network.
|
|
2154
2154
|
|
|
@@ -2165,7 +2165,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2165
2165
|
|
|
2166
2166
|
### removeMeshNetworkDevice
|
|
2167
2167
|
|
|
2168
|
-
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/
|
|
2168
|
+
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1906-L1922 "Source code on GitHub")
|
|
2169
2169
|
|
|
2170
2170
|
Remove a device from a mesh network.
|
|
2171
2171
|
|
|
@@ -2182,7 +2182,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2182
2182
|
|
|
2183
2183
|
### listMeshNetworkDevices
|
|
2184
2184
|
|
|
2185
|
-
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/
|
|
2185
|
+
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1936-L1945 "Source code on GitHub")
|
|
2186
2186
|
|
|
2187
2187
|
List all devices of a mesh network.
|
|
2188
2188
|
|
|
@@ -2201,7 +2201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2201
2201
|
|
|
2202
2202
|
### getProductConfiguration
|
|
2203
2203
|
|
|
2204
|
-
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/
|
|
2204
|
+
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1956-L1963 "Source code on GitHub")
|
|
2205
2205
|
|
|
2206
2206
|
Get product configuration
|
|
2207
2207
|
|
|
@@ -2217,7 +2217,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2217
2217
|
|
|
2218
2218
|
### getProductConfigurationSchema
|
|
2219
2219
|
|
|
2220
|
-
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/
|
|
2220
|
+
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1974-L1982 "Source code on GitHub")
|
|
2221
2221
|
|
|
2222
2222
|
Get product configuration schema
|
|
2223
2223
|
|
|
@@ -2233,7 +2233,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2233
2233
|
|
|
2234
2234
|
### getProductDeviceConfiguration
|
|
2235
2235
|
|
|
2236
|
-
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/
|
|
2236
|
+
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1994-L2001 "Source code on GitHub")
|
|
2237
2237
|
|
|
2238
2238
|
Get product device's configuration
|
|
2239
2239
|
|
|
@@ -2250,7 +2250,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2250
2250
|
|
|
2251
2251
|
### getProductDeviceConfigurationSchema
|
|
2252
2252
|
|
|
2253
|
-
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/
|
|
2253
|
+
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2013-L2021 "Source code on GitHub")
|
|
2254
2254
|
|
|
2255
2255
|
Get product device's configuration schema
|
|
2256
2256
|
|
|
@@ -2267,7 +2267,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2267
2267
|
|
|
2268
2268
|
### setProductConfiguration
|
|
2269
2269
|
|
|
2270
|
-
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/
|
|
2270
|
+
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2033-L2041 "Source code on GitHub")
|
|
2271
2271
|
|
|
2272
2272
|
Set product configuration
|
|
2273
2273
|
|
|
@@ -2284,7 +2284,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2284
2284
|
|
|
2285
2285
|
### setProductDeviceConfiguration
|
|
2286
2286
|
|
|
2287
|
-
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/
|
|
2287
|
+
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2054-L2062 "Source code on GitHub")
|
|
2288
2288
|
|
|
2289
2289
|
Set product configuration for a specific device within the product
|
|
2290
2290
|
|
|
@@ -2302,7 +2302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2302
2302
|
|
|
2303
2303
|
### getProductLocations
|
|
2304
2304
|
|
|
2305
|
-
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/
|
|
2305
|
+
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2081-L2098 "Source code on GitHub")
|
|
2306
2306
|
|
|
2307
2307
|
Query location for devices within a product
|
|
2308
2308
|
|
|
@@ -2326,7 +2326,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2326
2326
|
|
|
2327
2327
|
### getProductDeviceLocations
|
|
2328
2328
|
|
|
2329
|
-
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/
|
|
2329
|
+
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2115-L2127 "Source code on GitHub")
|
|
2330
2330
|
|
|
2331
2331
|
Query location for one device within a product
|
|
2332
2332
|
|
|
@@ -2346,7 +2346,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2346
2346
|
|
|
2347
2347
|
### executeLogic
|
|
2348
2348
|
|
|
2349
|
-
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/
|
|
2349
|
+
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2143-L2151 "Source code on GitHub")
|
|
2350
2350
|
|
|
2351
2351
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
2352
2352
|
|
|
@@ -2365,7 +2365,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2365
2365
|
|
|
2366
2366
|
### createLogicFunction
|
|
2367
2367
|
|
|
2368
|
-
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/
|
|
2368
|
+
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2171-L2179 "Source code on GitHub")
|
|
2369
2369
|
|
|
2370
2370
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2371
2371
|
|
|
@@ -2388,7 +2388,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2388
2388
|
|
|
2389
2389
|
### getLogicFunction
|
|
2390
2390
|
|
|
2391
|
-
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/
|
|
2391
|
+
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2193-L2200 "Source code on GitHub")
|
|
2392
2392
|
|
|
2393
2393
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2394
2394
|
|
|
@@ -2405,7 +2405,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2405
2405
|
|
|
2406
2406
|
### updateLogicFunction
|
|
2407
2407
|
|
|
2408
|
-
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/
|
|
2408
|
+
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2217-L2225 "Source code on GitHub")
|
|
2409
2409
|
|
|
2410
2410
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2411
2411
|
|
|
@@ -2425,7 +2425,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2425
2425
|
|
|
2426
2426
|
### deleteLogicFunction
|
|
2427
2427
|
|
|
2428
|
-
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/
|
|
2428
|
+
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2239-L2246 "Source code on GitHub")
|
|
2429
2429
|
|
|
2430
2430
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2431
2431
|
|
|
@@ -2442,7 +2442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2442
2442
|
|
|
2443
2443
|
### listLogicFunctions
|
|
2444
2444
|
|
|
2445
|
-
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/
|
|
2445
|
+
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2260-L2270 "Source code on GitHub")
|
|
2446
2446
|
|
|
2447
2447
|
Lists all logic functions in the specified organization or sandbox.
|
|
2448
2448
|
|
|
@@ -2459,7 +2459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2459
2459
|
|
|
2460
2460
|
### listLogicRuns
|
|
2461
2461
|
|
|
2462
|
-
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/
|
|
2462
|
+
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2284-L2291 "Source code on GitHub")
|
|
2463
2463
|
|
|
2464
2464
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2465
2465
|
|
|
@@ -2476,7 +2476,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2476
2476
|
|
|
2477
2477
|
### getLogicRun
|
|
2478
2478
|
|
|
2479
|
-
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/
|
|
2479
|
+
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2306-L2313 "Source code on GitHub")
|
|
2480
2480
|
|
|
2481
2481
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2482
2482
|
|
|
@@ -2494,7 +2494,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2494
2494
|
|
|
2495
2495
|
### getLogicRunLogs
|
|
2496
2496
|
|
|
2497
|
-
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/
|
|
2497
|
+
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2328-L2335 "Source code on GitHub")
|
|
2498
2498
|
|
|
2499
2499
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2500
2500
|
|
|
@@ -2512,7 +2512,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2512
2512
|
|
|
2513
2513
|
### createLedger
|
|
2514
2514
|
|
|
2515
|
-
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/
|
|
2515
|
+
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2349-L2357 "Source code on GitHub")
|
|
2516
2516
|
|
|
2517
2517
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2518
2518
|
|
|
@@ -2529,7 +2529,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2529
2529
|
|
|
2530
2530
|
### getLedger
|
|
2531
2531
|
|
|
2532
|
-
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/
|
|
2532
|
+
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2371-L2378 "Source code on GitHub")
|
|
2533
2533
|
|
|
2534
2534
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2535
2535
|
|
|
@@ -2546,7 +2546,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2546
2546
|
|
|
2547
2547
|
### updateLedger
|
|
2548
2548
|
|
|
2549
|
-
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/
|
|
2549
|
+
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2393-L2401 "Source code on GitHub")
|
|
2550
2550
|
|
|
2551
2551
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2552
2552
|
|
|
@@ -2564,7 +2564,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2564
2564
|
|
|
2565
2565
|
### archiveLedger
|
|
2566
2566
|
|
|
2567
|
-
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/
|
|
2567
|
+
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2415-L2422 "Source code on GitHub")
|
|
2568
2568
|
|
|
2569
2569
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2570
2570
|
|
|
@@ -2581,7 +2581,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2581
2581
|
|
|
2582
2582
|
### Scope
|
|
2583
2583
|
|
|
2584
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
2584
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
2585
2585
|
|
|
2586
2586
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2587
2587
|
|
|
@@ -2599,7 +2599,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2599
2599
|
|
|
2600
2600
|
### listLedgers
|
|
2601
2601
|
|
|
2602
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
2602
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
2603
2603
|
|
|
2604
2604
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2605
2605
|
|
|
@@ -2619,7 +2619,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2619
2619
|
|
|
2620
2620
|
### getLedgerInstance
|
|
2621
2621
|
|
|
2622
|
-
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
2622
|
+
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2471-L2478 "Source code on GitHub")
|
|
2623
2623
|
|
|
2624
2624
|
Get ledger instance data.
|
|
2625
2625
|
|
|
@@ -2637,7 +2637,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2637
2637
|
|
|
2638
2638
|
### setLedgerInstance
|
|
2639
2639
|
|
|
2640
|
-
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/
|
|
2640
|
+
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2494-L2502 "Source code on GitHub")
|
|
2641
2641
|
|
|
2642
2642
|
Set ledger instance data.
|
|
2643
2643
|
|
|
@@ -2648,7 +2648,7 @@ Set ledger instance data.
|
|
|
2648
2648
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2649
2649
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2650
2650
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
2651
|
-
- `options.
|
|
2651
|
+
- `options.instance` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The instance with the data
|
|
2652
2652
|
- `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.
|
|
2653
2653
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2654
2654
|
|
|
@@ -2656,7 +2656,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2656
2656
|
|
|
2657
2657
|
### deleteLedgerInstance
|
|
2658
2658
|
|
|
2659
|
-
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/
|
|
2659
|
+
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2517-L2524 "Source code on GitHub")
|
|
2660
2660
|
|
|
2661
2661
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2662
2662
|
|
|
@@ -2674,7 +2674,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2674
2674
|
|
|
2675
2675
|
### listLedgerInstances
|
|
2676
2676
|
|
|
2677
|
-
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/
|
|
2677
|
+
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2540-L2551 "Source code on GitHub")
|
|
2678
2678
|
|
|
2679
2679
|
Lists ledger instances in the specified organization or sandbox.
|
|
2680
2680
|
|
|
@@ -2693,7 +2693,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2693
2693
|
|
|
2694
2694
|
### listLedgerInstanceVersions
|
|
2695
2695
|
|
|
2696
|
-
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/
|
|
2696
|
+
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2568-L2579 "Source code on GitHub")
|
|
2697
2697
|
|
|
2698
2698
|
List ledger instance versions
|
|
2699
2699
|
|
|
@@ -2713,7 +2713,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2713
2713
|
|
|
2714
2714
|
### getLedgerInstanceVersion
|
|
2715
2715
|
|
|
2716
|
-
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/
|
|
2716
|
+
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2595-L2602 "Source code on GitHub")
|
|
2717
2717
|
|
|
2718
2718
|
Get specific ledger instance version
|
|
2719
2719
|
|
|
@@ -2732,7 +2732,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2732
2732
|
|
|
2733
2733
|
### setDefaultAuth
|
|
2734
2734
|
|
|
2735
|
-
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/
|
|
2735
|
+
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2609-L2617 "Source code on GitHub")
|
|
2736
2736
|
|
|
2737
2737
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2738
2738
|
|
|
@@ -2745,7 +2745,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2745
2745
|
|
|
2746
2746
|
### get
|
|
2747
2747
|
|
|
2748
|
-
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/
|
|
2748
|
+
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2660-L2664 "Source code on GitHub")
|
|
2749
2749
|
|
|
2750
2750
|
Make a GET request
|
|
2751
2751
|
|
|
@@ -2762,7 +2762,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2762
2762
|
|
|
2763
2763
|
### head
|
|
2764
2764
|
|
|
2765
|
-
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/
|
|
2765
|
+
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2676-L2680 "Source code on GitHub")
|
|
2766
2766
|
|
|
2767
2767
|
Make a HEAD request
|
|
2768
2768
|
|
|
@@ -2779,7 +2779,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2779
2779
|
|
|
2780
2780
|
### post
|
|
2781
2781
|
|
|
2782
|
-
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/
|
|
2782
|
+
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2692-L2696 "Source code on GitHub")
|
|
2783
2783
|
|
|
2784
2784
|
Make a POST request
|
|
2785
2785
|
|
|
@@ -2796,7 +2796,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2796
2796
|
|
|
2797
2797
|
### put
|
|
2798
2798
|
|
|
2799
|
-
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/
|
|
2799
|
+
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2708-L2712 "Source code on GitHub")
|
|
2800
2800
|
|
|
2801
2801
|
Make a PUT request
|
|
2802
2802
|
|
|
@@ -2813,7 +2813,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2813
2813
|
|
|
2814
2814
|
### delete
|
|
2815
2815
|
|
|
2816
|
-
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/
|
|
2816
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
2817
2817
|
|
|
2818
2818
|
Make a DELETE request
|
|
2819
2819
|
|
|
@@ -2830,7 +2830,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2830
2830
|
|
|
2831
2831
|
### request
|
|
2832
2832
|
|
|
2833
|
-
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/
|
|
2833
|
+
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2745-L2749 "Source code on GitHub")
|
|
2834
2834
|
|
|
2835
2835
|
**Parameters**
|
|
2836
2836
|
|
|
@@ -2850,7 +2850,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2850
2850
|
|
|
2851
2851
|
## Particle
|
|
2852
2852
|
|
|
2853
|
-
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/
|
|
2853
|
+
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L26-L2761 "Source code on GitHub")
|
|
2854
2854
|
|
|
2855
2855
|
**Parameters**
|
|
2856
2856
|
|
|
@@ -2858,7 +2858,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2858
2858
|
|
|
2859
2859
|
### constructor
|
|
2860
2860
|
|
|
2861
|
-
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/
|
|
2861
|
+
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L39-L48 "Source code on GitHub")
|
|
2862
2862
|
|
|
2863
2863
|
Contructor for the Cloud API wrapper.
|
|
2864
2864
|
|
|
@@ -2875,7 +2875,7 @@ Create a new Particle object and call methods below on it.
|
|
|
2875
2875
|
|
|
2876
2876
|
### login
|
|
2877
2877
|
|
|
2878
|
-
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/
|
|
2878
|
+
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L85-L102 "Source code on GitHub")
|
|
2879
2879
|
|
|
2880
2880
|
Login to Particle Cloud using an existing Particle acccount.
|
|
2881
2881
|
|
|
@@ -2892,7 +2892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2892
2892
|
|
|
2893
2893
|
### sendOtp
|
|
2894
2894
|
|
|
2895
|
-
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/
|
|
2895
|
+
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L113-L129 "Source code on GitHub")
|
|
2896
2896
|
|
|
2897
2897
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
2898
2898
|
|
|
@@ -2908,7 +2908,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2908
2908
|
|
|
2909
2909
|
### enableMfa
|
|
2910
2910
|
|
|
2911
|
-
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/
|
|
2911
|
+
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L139-L141 "Source code on GitHub")
|
|
2912
2912
|
|
|
2913
2913
|
Enable MFA on the currently logged in user
|
|
2914
2914
|
|
|
@@ -2923,7 +2923,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2923
2923
|
|
|
2924
2924
|
### confirmMfa
|
|
2925
2925
|
|
|
2926
|
-
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/
|
|
2926
|
+
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L154-L168 "Source code on GitHub")
|
|
2927
2927
|
|
|
2928
2928
|
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.
|
|
2929
2929
|
|
|
@@ -2941,7 +2941,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2941
2941
|
|
|
2942
2942
|
### disableMfa
|
|
2943
2943
|
|
|
2944
|
-
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/
|
|
2944
|
+
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L179-L187 "Source code on GitHub")
|
|
2945
2945
|
|
|
2946
2946
|
Disable MFA for the user.
|
|
2947
2947
|
|
|
@@ -2957,7 +2957,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2957
2957
|
|
|
2958
2958
|
### createCustomer
|
|
2959
2959
|
|
|
2960
|
-
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/
|
|
2960
|
+
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L199-L215 "Source code on GitHub")
|
|
2961
2961
|
|
|
2962
2962
|
Create Customer for Product.
|
|
2963
2963
|
|
|
@@ -2974,7 +2974,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2974
2974
|
|
|
2975
2975
|
### loginAsClientOwner
|
|
2976
2976
|
|
|
2977
|
-
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/
|
|
2977
|
+
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L224-L238 "Source code on GitHub")
|
|
2978
2978
|
|
|
2979
2979
|
Login to Particle Cloud using an OAuth client.
|
|
2980
2980
|
|
|
@@ -2988,7 +2988,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2988
2988
|
|
|
2989
2989
|
### createUser
|
|
2990
2990
|
|
|
2991
|
-
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/
|
|
2991
|
+
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L250-L261 "Source code on GitHub")
|
|
2992
2992
|
|
|
2993
2993
|
Create a user account for the Particle Cloud
|
|
2994
2994
|
|
|
@@ -3005,7 +3005,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3005
3005
|
|
|
3006
3006
|
### verifyUser
|
|
3007
3007
|
|
|
3008
|
-
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/
|
|
3008
|
+
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L271-L278 "Source code on GitHub")
|
|
3009
3009
|
|
|
3010
3010
|
Verify new user account via verification email
|
|
3011
3011
|
|
|
@@ -3020,7 +3020,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3020
3020
|
|
|
3021
3021
|
### resetPassword
|
|
3022
3022
|
|
|
3023
|
-
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/
|
|
3023
|
+
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L288-L295 "Source code on GitHub")
|
|
3024
3024
|
|
|
3025
3025
|
Send reset password email for a Particle Cloud user account
|
|
3026
3026
|
|
|
@@ -3035,7 +3035,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3035
3035
|
|
|
3036
3036
|
### deleteAccessToken
|
|
3037
3037
|
|
|
3038
|
-
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/
|
|
3038
|
+
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L307-L315 "Source code on GitHub")
|
|
3039
3039
|
|
|
3040
3040
|
Revoke an access token
|
|
3041
3041
|
|
|
@@ -3052,7 +3052,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3052
3052
|
|
|
3053
3053
|
### deleteCurrentAccessToken
|
|
3054
3054
|
|
|
3055
|
-
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/
|
|
3055
|
+
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L325-L332 "Source code on GitHub")
|
|
3056
3056
|
|
|
3057
3057
|
Revoke the current session access token
|
|
3058
3058
|
|
|
@@ -3067,7 +3067,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3067
3067
|
|
|
3068
3068
|
### deleteActiveAccessTokens
|
|
3069
3069
|
|
|
3070
|
-
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/
|
|
3070
|
+
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L342-L349 "Source code on GitHub")
|
|
3071
3071
|
|
|
3072
3072
|
Revoke all active access tokens
|
|
3073
3073
|
|
|
@@ -3082,7 +3082,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3082
3082
|
|
|
3083
3083
|
### deleteUser
|
|
3084
3084
|
|
|
3085
|
-
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/
|
|
3085
|
+
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L360-L368 "Source code on GitHub")
|
|
3086
3086
|
|
|
3087
3087
|
Delete the current user
|
|
3088
3088
|
|
|
@@ -3098,7 +3098,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3098
3098
|
|
|
3099
3099
|
### listAccessTokens
|
|
3100
3100
|
|
|
3101
|
-
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/
|
|
3101
|
+
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L380-L388 "Source code on GitHub")
|
|
3102
3102
|
|
|
3103
3103
|
List all valid access tokens for a Particle Cloud account
|
|
3104
3104
|
|
|
@@ -3115,7 +3115,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3115
3115
|
|
|
3116
3116
|
### trackingIdentity
|
|
3117
3117
|
|
|
3118
|
-
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/
|
|
3118
|
+
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L400-L408 "Source code on GitHub")
|
|
3119
3119
|
|
|
3120
3120
|
Retrieves the information that is used to identify the current login for tracking.
|
|
3121
3121
|
|
|
@@ -3132,7 +3132,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3132
3132
|
|
|
3133
3133
|
### listDevices
|
|
3134
3134
|
|
|
3135
|
-
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/
|
|
3135
|
+
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L426-L445 "Source code on GitHub")
|
|
3136
3136
|
|
|
3137
3137
|
List devices claimed to the account or product
|
|
3138
3138
|
|
|
@@ -3155,7 +3155,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3155
3155
|
|
|
3156
3156
|
### getDevice
|
|
3157
3157
|
|
|
3158
|
-
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/
|
|
3158
|
+
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L457-L460 "Source code on GitHub")
|
|
3159
3159
|
|
|
3160
3160
|
Get detailed informationa about a device
|
|
3161
3161
|
|
|
@@ -3172,7 +3172,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3172
3172
|
|
|
3173
3173
|
### claimDevice
|
|
3174
3174
|
|
|
3175
|
-
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/
|
|
3175
|
+
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L472-L483 "Source code on GitHub")
|
|
3176
3176
|
|
|
3177
3177
|
Claim a device to the account. The device must be online and unclaimed.
|
|
3178
3178
|
|
|
@@ -3189,7 +3189,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3189
3189
|
|
|
3190
3190
|
### addDeviceToProduct
|
|
3191
3191
|
|
|
3192
|
-
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/
|
|
3192
|
+
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L497-L515 "Source code on GitHub")
|
|
3193
3193
|
|
|
3194
3194
|
Add a device to a product or move device out of quarantine.
|
|
3195
3195
|
|
|
@@ -3208,7 +3208,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3208
3208
|
|
|
3209
3209
|
### removeDevice
|
|
3210
3210
|
|
|
3211
|
-
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/
|
|
3211
|
+
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L528-L532 "Source code on GitHub")
|
|
3212
3212
|
|
|
3213
3213
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
3214
3214
|
|
|
@@ -3226,7 +3226,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3226
3226
|
|
|
3227
3227
|
### removeDeviceOwner
|
|
3228
3228
|
|
|
3229
|
-
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/
|
|
3229
|
+
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L544-L547 "Source code on GitHub")
|
|
3230
3230
|
|
|
3231
3231
|
Unclaim a product device its the owner, but keep it in the product
|
|
3232
3232
|
|
|
@@ -3243,7 +3243,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3243
3243
|
|
|
3244
3244
|
### renameDevice
|
|
3245
3245
|
|
|
3246
|
-
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/
|
|
3246
|
+
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L560-L562 "Source code on GitHub")
|
|
3247
3247
|
|
|
3248
3248
|
Rename a device
|
|
3249
3249
|
|
|
@@ -3261,7 +3261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3261
3261
|
|
|
3262
3262
|
### signalDevice
|
|
3263
3263
|
|
|
3264
|
-
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/
|
|
3264
|
+
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L575-L577 "Source code on GitHub")
|
|
3265
3265
|
|
|
3266
3266
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
3267
3267
|
|
|
@@ -3279,7 +3279,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3279
3279
|
|
|
3280
3280
|
### setDeviceNotes
|
|
3281
3281
|
|
|
3282
|
-
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/
|
|
3282
|
+
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L590-L592 "Source code on GitHub")
|
|
3283
3283
|
|
|
3284
3284
|
Store some notes about device
|
|
3285
3285
|
|
|
@@ -3297,7 +3297,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3297
3297
|
|
|
3298
3298
|
### markAsDevelopmentDevice
|
|
3299
3299
|
|
|
3300
|
-
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/
|
|
3300
|
+
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L605-L607 "Source code on GitHub")
|
|
3301
3301
|
|
|
3302
3302
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
3303
3303
|
|
|
@@ -3315,7 +3315,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3315
3315
|
|
|
3316
3316
|
### lockDeviceProductFirmware
|
|
3317
3317
|
|
|
3318
|
-
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/
|
|
3318
|
+
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L621-L623 "Source code on GitHub")
|
|
3319
3319
|
|
|
3320
3320
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
3321
3321
|
|
|
@@ -3334,7 +3334,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3334
3334
|
|
|
3335
3335
|
### unlockDeviceProductFirmware
|
|
3336
3336
|
|
|
3337
|
-
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/
|
|
3337
|
+
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L635-L637 "Source code on GitHub")
|
|
3338
3338
|
|
|
3339
3339
|
Mark device as receiving automatic firmware updates
|
|
3340
3340
|
|
|
@@ -3351,7 +3351,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3351
3351
|
|
|
3352
3352
|
### updateDevice
|
|
3353
3353
|
|
|
3354
|
-
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/
|
|
3354
|
+
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L656-L668 "Source code on GitHub")
|
|
3355
3355
|
|
|
3356
3356
|
Update multiple device attributes at the same time
|
|
3357
3357
|
|
|
@@ -3375,7 +3375,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3375
3375
|
|
|
3376
3376
|
### provisionDevice
|
|
3377
3377
|
|
|
3378
|
-
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/
|
|
3378
|
+
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L679-L687 "Source code on GitHub")
|
|
3379
3379
|
|
|
3380
3380
|
Provision a new device for products that allow self-provisioning
|
|
3381
3381
|
|
|
@@ -3391,7 +3391,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3391
3391
|
|
|
3392
3392
|
### getClaimCode
|
|
3393
3393
|
|
|
3394
|
-
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/
|
|
3394
|
+
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L701-L704 "Source code on GitHub")
|
|
3395
3395
|
|
|
3396
3396
|
Generate a claim code to use in the device claiming process.
|
|
3397
3397
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -3410,7 +3410,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3410
3410
|
|
|
3411
3411
|
### getVariable
|
|
3412
3412
|
|
|
3413
|
-
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/
|
|
3413
|
+
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L736-L742 "Source code on GitHub")
|
|
3414
3414
|
|
|
3415
3415
|
Get the value of a device variable
|
|
3416
3416
|
|
|
@@ -3428,7 +3428,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3428
3428
|
|
|
3429
3429
|
### flashDevice
|
|
3430
3430
|
|
|
3431
|
-
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/
|
|
3431
|
+
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L756-L767 "Source code on GitHub")
|
|
3432
3432
|
|
|
3433
3433
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
3434
3434
|
|
|
@@ -3447,7 +3447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3447
3447
|
|
|
3448
3448
|
### flashTinker
|
|
3449
3449
|
|
|
3450
|
-
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/
|
|
3450
|
+
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L778-L793 "Source code on GitHub")
|
|
3451
3451
|
|
|
3452
3452
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
3453
3453
|
|
|
@@ -3463,7 +3463,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3463
3463
|
|
|
3464
3464
|
### compileCode
|
|
3465
3465
|
|
|
3466
|
-
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/
|
|
3466
|
+
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L806-L824 "Source code on GitHub")
|
|
3467
3467
|
|
|
3468
3468
|
Compile firmware using the Particle Cloud
|
|
3469
3469
|
|
|
@@ -3481,7 +3481,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3481
3481
|
|
|
3482
3482
|
### downloadFirmwareBinary
|
|
3483
3483
|
|
|
3484
|
-
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/
|
|
3484
|
+
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L835-L844 "Source code on GitHub")
|
|
3485
3485
|
|
|
3486
3486
|
Download a firmware binary
|
|
3487
3487
|
|
|
@@ -3497,7 +3497,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3497
3497
|
|
|
3498
3498
|
### sendPublicKey
|
|
3499
3499
|
|
|
3500
|
-
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/
|
|
3500
|
+
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L857-L871 "Source code on GitHub")
|
|
3501
3501
|
|
|
3502
3502
|
Send a new device public key to the Particle Cloud
|
|
3503
3503
|
|
|
@@ -3515,7 +3515,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3515
3515
|
|
|
3516
3516
|
### callFunction
|
|
3517
3517
|
|
|
3518
|
-
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/
|
|
3518
|
+
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L885-L890 "Source code on GitHub")
|
|
3519
3519
|
|
|
3520
3520
|
Call a device function
|
|
3521
3521
|
|
|
@@ -3534,7 +3534,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3534
3534
|
|
|
3535
3535
|
### getEventStream
|
|
3536
3536
|
|
|
3537
|
-
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/
|
|
3537
|
+
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L903-L928 "Source code on GitHub")
|
|
3538
3538
|
|
|
3539
3539
|
Get a stream of events
|
|
3540
3540
|
|
|
@@ -3552,7 +3552,7 @@ emit 'event' events.
|
|
|
3552
3552
|
|
|
3553
3553
|
### publishEvent
|
|
3554
3554
|
|
|
3555
|
-
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/
|
|
3555
|
+
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L942-L946 "Source code on GitHub")
|
|
3556
3556
|
|
|
3557
3557
|
Publish a event to the Particle Cloud
|
|
3558
3558
|
|
|
@@ -3571,7 +3571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3571
3571
|
|
|
3572
3572
|
### Hook
|
|
3573
3573
|
|
|
3574
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
3574
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
3575
3575
|
|
|
3576
3576
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
3577
3577
|
|
|
@@ -3604,7 +3604,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
3604
3604
|
|
|
3605
3605
|
### createWebhook
|
|
3606
3606
|
|
|
3607
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
3607
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
3608
3608
|
|
|
3609
3609
|
Create a webhook
|
|
3610
3610
|
|
|
@@ -3626,7 +3626,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3626
3626
|
|
|
3627
3627
|
### deleteWebhook
|
|
3628
3628
|
|
|
3629
|
-
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/
|
|
3629
|
+
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1011-L1014 "Source code on GitHub")
|
|
3630
3630
|
|
|
3631
3631
|
Delete a webhook
|
|
3632
3632
|
|
|
@@ -3643,7 +3643,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3643
3643
|
|
|
3644
3644
|
### listWebhooks
|
|
3645
3645
|
|
|
3646
|
-
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/
|
|
3646
|
+
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1025-L1028 "Source code on GitHub")
|
|
3647
3647
|
|
|
3648
3648
|
List all webhooks owned by the account or product
|
|
3649
3649
|
|
|
@@ -3659,7 +3659,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3659
3659
|
|
|
3660
3660
|
### createIntegration
|
|
3661
3661
|
|
|
3662
|
-
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/
|
|
3662
|
+
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1045-L1049 "Source code on GitHub")
|
|
3663
3663
|
|
|
3664
3664
|
Create an integration to send events to an external service
|
|
3665
3665
|
|
|
@@ -3680,7 +3680,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3680
3680
|
|
|
3681
3681
|
### editIntegration
|
|
3682
3682
|
|
|
3683
|
-
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/
|
|
3683
|
+
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1067-L1071 "Source code on GitHub")
|
|
3684
3684
|
|
|
3685
3685
|
Edit an integration to send events to an external service
|
|
3686
3686
|
|
|
@@ -3702,7 +3702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3702
3702
|
|
|
3703
3703
|
### deleteIntegration
|
|
3704
3704
|
|
|
3705
|
-
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/
|
|
3705
|
+
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1084-L1087 "Source code on GitHub")
|
|
3706
3706
|
|
|
3707
3707
|
Delete an integration to send events to an external service
|
|
3708
3708
|
|
|
@@ -3719,7 +3719,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3719
3719
|
|
|
3720
3720
|
### listIntegrations
|
|
3721
3721
|
|
|
3722
|
-
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
3722
|
+
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1098-L1101 "Source code on GitHub")
|
|
3723
3723
|
|
|
3724
3724
|
List all integrations owned by the account or product
|
|
3725
3725
|
|
|
@@ -3735,7 +3735,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3735
3735
|
|
|
3736
3736
|
### getUserInfo
|
|
3737
3737
|
|
|
3738
|
-
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/
|
|
3738
|
+
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1111-L1113 "Source code on GitHub")
|
|
3739
3739
|
|
|
3740
3740
|
Get details about the current user
|
|
3741
3741
|
|
|
@@ -3750,7 +3750,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3750
3750
|
|
|
3751
3751
|
### setUserInfo
|
|
3752
3752
|
|
|
3753
|
-
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/
|
|
3753
|
+
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1124-L1127 "Source code on GitHub")
|
|
3754
3754
|
|
|
3755
3755
|
Set details on the current user
|
|
3756
3756
|
|
|
@@ -3766,7 +3766,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3766
3766
|
|
|
3767
3767
|
### changeUsername
|
|
3768
3768
|
|
|
3769
|
-
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/
|
|
3769
|
+
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1140-L1148 "Source code on GitHub")
|
|
3770
3770
|
|
|
3771
3771
|
Change username (i.e, email)
|
|
3772
3772
|
|
|
@@ -3784,7 +3784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3784
3784
|
|
|
3785
3785
|
### changeUserPassword
|
|
3786
3786
|
|
|
3787
|
-
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/
|
|
3787
|
+
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1161-L1169 "Source code on GitHub")
|
|
3788
3788
|
|
|
3789
3789
|
Change user's password
|
|
3790
3790
|
|
|
@@ -3802,7 +3802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3802
3802
|
|
|
3803
3803
|
### listSIMs
|
|
3804
3804
|
|
|
3805
|
-
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/
|
|
3805
|
+
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1185-L1189 "Source code on GitHub")
|
|
3806
3806
|
|
|
3807
3807
|
List SIM cards owned by a user or product
|
|
3808
3808
|
|
|
@@ -3823,7 +3823,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3823
3823
|
|
|
3824
3824
|
### getSIMDataUsage
|
|
3825
3825
|
|
|
3826
|
-
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/
|
|
3826
|
+
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1201-L1207 "Source code on GitHub")
|
|
3827
3827
|
|
|
3828
3828
|
Get data usage for one SIM card for the current billing period
|
|
3829
3829
|
|
|
@@ -3840,7 +3840,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3840
3840
|
|
|
3841
3841
|
### getFleetDataUsage
|
|
3842
3842
|
|
|
3843
|
-
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/
|
|
3843
|
+
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1218-L1225 "Source code on GitHub")
|
|
3844
3844
|
|
|
3845
3845
|
Get data usage for all SIM cards in a product the current billing period
|
|
3846
3846
|
|
|
@@ -3856,7 +3856,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3856
3856
|
|
|
3857
3857
|
### checkSIM
|
|
3858
3858
|
|
|
3859
|
-
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/
|
|
3859
|
+
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1236-L1238 "Source code on GitHub")
|
|
3860
3860
|
|
|
3861
3861
|
Check SIM status
|
|
3862
3862
|
|
|
@@ -3872,7 +3872,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3872
3872
|
|
|
3873
3873
|
### activateSIM
|
|
3874
3874
|
|
|
3875
|
-
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/
|
|
3875
|
+
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1253-L1263 "Source code on GitHub")
|
|
3876
3876
|
|
|
3877
3877
|
Activate and add SIM cards to an account or product
|
|
3878
3878
|
|
|
@@ -3892,7 +3892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3892
3892
|
|
|
3893
3893
|
### deactivateSIM
|
|
3894
3894
|
|
|
3895
|
-
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/
|
|
3895
|
+
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1275-L1279 "Source code on GitHub")
|
|
3896
3896
|
|
|
3897
3897
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
3898
3898
|
|
|
@@ -3909,7 +3909,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3909
3909
|
|
|
3910
3910
|
### reactivateSIM
|
|
3911
3911
|
|
|
3912
|
-
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/
|
|
3912
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
3913
3913
|
|
|
3914
3914
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
3915
3915
|
|
|
@@ -3927,7 +3927,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3927
3927
|
|
|
3928
3928
|
### updateSIM
|
|
3929
3929
|
|
|
3930
|
-
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/
|
|
3930
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
3931
3931
|
|
|
3932
3932
|
Update SIM card data limit
|
|
3933
3933
|
|
|
@@ -3945,7 +3945,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3945
3945
|
|
|
3946
3946
|
### removeSIM
|
|
3947
3947
|
|
|
3948
|
-
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/
|
|
3948
|
+
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1325-L1328 "Source code on GitHub")
|
|
3949
3949
|
|
|
3950
3950
|
Remove a SIM card from an account so it can be activated by a different account
|
|
3951
3951
|
|
|
@@ -3962,7 +3962,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3962
3962
|
|
|
3963
3963
|
### listBuildTargets
|
|
3964
3964
|
|
|
3965
|
-
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/
|
|
3965
|
+
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1339-L1342 "Source code on GitHub")
|
|
3966
3966
|
|
|
3967
3967
|
List valid build targets to be used for compiling
|
|
3968
3968
|
|
|
@@ -3978,7 +3978,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3978
3978
|
|
|
3979
3979
|
### listLibraries
|
|
3980
3980
|
|
|
3981
|
-
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/
|
|
3981
|
+
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1368-L1385 "Source code on GitHub")
|
|
3982
3982
|
|
|
3983
3983
|
List firmware libraries
|
|
3984
3984
|
|
|
@@ -4008,7 +4008,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4008
4008
|
|
|
4009
4009
|
### getLibrary
|
|
4010
4010
|
|
|
4011
|
-
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/
|
|
4011
|
+
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1401-L1409 "Source code on GitHub")
|
|
4012
4012
|
|
|
4013
4013
|
Get firmware library details
|
|
4014
4014
|
|
|
@@ -4025,7 +4025,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4025
4025
|
|
|
4026
4026
|
### getLibraryVersions
|
|
4027
4027
|
|
|
4028
|
-
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/
|
|
4028
|
+
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1422-L1430 "Source code on GitHub")
|
|
4029
4029
|
|
|
4030
4030
|
Firmware library details for each version
|
|
4031
4031
|
|
|
@@ -4043,7 +4043,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4043
4043
|
|
|
4044
4044
|
### contributeLibrary
|
|
4045
4045
|
|
|
4046
|
-
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/
|
|
4046
|
+
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1442-L1455 "Source code on GitHub")
|
|
4047
4047
|
|
|
4048
4048
|
Contribute a new library version from a compressed archive
|
|
4049
4049
|
|
|
@@ -4060,7 +4060,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4060
4060
|
|
|
4061
4061
|
### publishLibrary
|
|
4062
4062
|
|
|
4063
|
-
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/
|
|
4063
|
+
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1466-L1475 "Source code on GitHub")
|
|
4064
4064
|
|
|
4065
4065
|
Publish the latest version of a library to the public
|
|
4066
4066
|
|
|
@@ -4076,7 +4076,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4076
4076
|
|
|
4077
4077
|
### deleteLibrary
|
|
4078
4078
|
|
|
4079
|
-
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
4079
|
+
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1487-L1495 "Source code on GitHub")
|
|
4080
4080
|
|
|
4081
4081
|
Delete one version of a library or an entire private library
|
|
4082
4082
|
|
|
@@ -4093,7 +4093,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4093
4093
|
|
|
4094
4094
|
### downloadFile
|
|
4095
4095
|
|
|
4096
|
-
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/
|
|
4096
|
+
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1505-L1507 "Source code on GitHub")
|
|
4097
4097
|
|
|
4098
4098
|
Download an external file that may not be on the API
|
|
4099
4099
|
|
|
@@ -4108,7 +4108,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4108
4108
|
|
|
4109
4109
|
### listOAuthClients
|
|
4110
4110
|
|
|
4111
|
-
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/
|
|
4111
|
+
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1518-L1521 "Source code on GitHub")
|
|
4112
4112
|
|
|
4113
4113
|
List OAuth client created by the account
|
|
4114
4114
|
|
|
@@ -4124,7 +4124,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4124
4124
|
|
|
4125
4125
|
### createOAuthClient
|
|
4126
4126
|
|
|
4127
|
-
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/
|
|
4127
|
+
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1536-L1540 "Source code on GitHub")
|
|
4128
4128
|
|
|
4129
4129
|
Create an OAuth client
|
|
4130
4130
|
|
|
@@ -4144,7 +4144,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4144
4144
|
|
|
4145
4145
|
### updateOAuthClient
|
|
4146
4146
|
|
|
4147
|
-
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/
|
|
4147
|
+
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1554-L1558 "Source code on GitHub")
|
|
4148
4148
|
|
|
4149
4149
|
Update an OAuth client
|
|
4150
4150
|
|
|
@@ -4163,7 +4163,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4163
4163
|
|
|
4164
4164
|
### deleteOAuthClient
|
|
4165
4165
|
|
|
4166
|
-
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
4166
|
+
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1570-L1573 "Source code on GitHub")
|
|
4167
4167
|
|
|
4168
4168
|
Delete an OAuth client
|
|
4169
4169
|
|
|
@@ -4180,7 +4180,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4180
4180
|
|
|
4181
4181
|
### listProducts
|
|
4182
4182
|
|
|
4183
|
-
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/
|
|
4183
|
+
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1583-L1585 "Source code on GitHub")
|
|
4184
4184
|
|
|
4185
4185
|
List products the account has access to
|
|
4186
4186
|
|
|
@@ -4195,7 +4195,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4195
4195
|
|
|
4196
4196
|
### getProduct
|
|
4197
4197
|
|
|
4198
|
-
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/
|
|
4198
|
+
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1596-L1598 "Source code on GitHub")
|
|
4199
4199
|
|
|
4200
4200
|
Get detailed information about a product
|
|
4201
4201
|
|
|
@@ -4211,7 +4211,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4211
4211
|
|
|
4212
4212
|
### listProductFirmware
|
|
4213
4213
|
|
|
4214
|
-
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/
|
|
4214
|
+
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1609-L1611 "Source code on GitHub")
|
|
4215
4215
|
|
|
4216
4216
|
List product firmware versions
|
|
4217
4217
|
|
|
@@ -4227,7 +4227,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4227
4227
|
|
|
4228
4228
|
### uploadProductFirmware
|
|
4229
4229
|
|
|
4230
|
-
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/
|
|
4230
|
+
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1627-L1643 "Source code on GitHub")
|
|
4231
4231
|
|
|
4232
4232
|
List product firmware versions
|
|
4233
4233
|
|
|
@@ -4248,7 +4248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4248
4248
|
|
|
4249
4249
|
### getProductFirmware
|
|
4250
4250
|
|
|
4251
|
-
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/
|
|
4251
|
+
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1655-L1662 "Source code on GitHub")
|
|
4252
4252
|
|
|
4253
4253
|
Get information about a product firmware version
|
|
4254
4254
|
|
|
@@ -4265,7 +4265,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4265
4265
|
|
|
4266
4266
|
### updateProductFirmware
|
|
4267
4267
|
|
|
4268
|
-
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/
|
|
4268
|
+
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1676-L1679 "Source code on GitHub")
|
|
4269
4269
|
|
|
4270
4270
|
Update information for a product firmware version
|
|
4271
4271
|
|
|
@@ -4284,7 +4284,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4284
4284
|
|
|
4285
4285
|
### downloadProductFirmware
|
|
4286
4286
|
|
|
4287
|
-
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/
|
|
4287
|
+
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1691-L1700 "Source code on GitHub")
|
|
4288
4288
|
|
|
4289
4289
|
Download a product firmware binary
|
|
4290
4290
|
|
|
@@ -4301,7 +4301,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4301
4301
|
|
|
4302
4302
|
### releaseProductFirmware
|
|
4303
4303
|
|
|
4304
|
-
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/
|
|
4304
|
+
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1712-L1715 "Source code on GitHub")
|
|
4305
4305
|
|
|
4306
4306
|
Release a product firmware version as the default version
|
|
4307
4307
|
|
|
@@ -4318,7 +4318,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4318
4318
|
|
|
4319
4319
|
### listTeamMembers
|
|
4320
4320
|
|
|
4321
|
-
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/
|
|
4321
|
+
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1726-L1733 "Source code on GitHub")
|
|
4322
4322
|
|
|
4323
4323
|
List product team members
|
|
4324
4324
|
|
|
@@ -4334,7 +4334,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4334
4334
|
|
|
4335
4335
|
### inviteTeamMember
|
|
4336
4336
|
|
|
4337
|
-
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/
|
|
4337
|
+
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1745-L1753 "Source code on GitHub")
|
|
4338
4338
|
|
|
4339
4339
|
Invite Particle user to a product team
|
|
4340
4340
|
|
|
@@ -4351,7 +4351,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4351
4351
|
|
|
4352
4352
|
### removeTeamMember
|
|
4353
4353
|
|
|
4354
|
-
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/
|
|
4354
|
+
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1765-L1772 "Source code on GitHub")
|
|
4355
4355
|
|
|
4356
4356
|
Remove Particle user to a product team
|
|
4357
4357
|
|
|
@@ -4368,7 +4368,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4368
4368
|
|
|
4369
4369
|
### lookupSerialNumber
|
|
4370
4370
|
|
|
4371
|
-
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/
|
|
4371
|
+
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1783-L1790 "Source code on GitHub")
|
|
4372
4372
|
|
|
4373
4373
|
Fetch details about a serial number
|
|
4374
4374
|
|
|
@@ -4384,7 +4384,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4384
4384
|
|
|
4385
4385
|
### createMeshNetwork
|
|
4386
4386
|
|
|
4387
|
-
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/
|
|
4387
|
+
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1803-L1811 "Source code on GitHub")
|
|
4388
4388
|
|
|
4389
4389
|
Create a mesh network
|
|
4390
4390
|
|
|
@@ -4402,7 +4402,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4402
4402
|
|
|
4403
4403
|
### removeMeshNetwork
|
|
4404
4404
|
|
|
4405
|
-
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/
|
|
4405
|
+
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1822-L1824 "Source code on GitHub")
|
|
4406
4406
|
|
|
4407
4407
|
Remove a mesh network.
|
|
4408
4408
|
|
|
@@ -4418,7 +4418,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4418
4418
|
|
|
4419
4419
|
### listMeshNetworks
|
|
4420
4420
|
|
|
4421
|
-
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/
|
|
4421
|
+
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1836-L1839 "Source code on GitHub")
|
|
4422
4422
|
|
|
4423
4423
|
List all mesh networks
|
|
4424
4424
|
|
|
@@ -4435,7 +4435,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4435
4435
|
|
|
4436
4436
|
### getMeshNetwork
|
|
4437
4437
|
|
|
4438
|
-
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/
|
|
4438
|
+
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1850-L1852 "Source code on GitHub")
|
|
4439
4439
|
|
|
4440
4440
|
Get information about a mesh network.
|
|
4441
4441
|
|
|
@@ -4451,7 +4451,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4451
4451
|
|
|
4452
4452
|
### updateMeshNetwork
|
|
4453
4453
|
|
|
4454
|
-
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/
|
|
4454
|
+
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1865-L1873 "Source code on GitHub")
|
|
4455
4455
|
|
|
4456
4456
|
Modify a mesh network.
|
|
4457
4457
|
|
|
@@ -4469,7 +4469,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4469
4469
|
|
|
4470
4470
|
### addMeshNetworkDevice
|
|
4471
4471
|
|
|
4472
|
-
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/
|
|
4472
|
+
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1885-L1894 "Source code on GitHub")
|
|
4473
4473
|
|
|
4474
4474
|
Add a device to a mesh network.
|
|
4475
4475
|
|
|
@@ -4486,7 +4486,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4486
4486
|
|
|
4487
4487
|
### removeMeshNetworkDevice
|
|
4488
4488
|
|
|
4489
|
-
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/
|
|
4489
|
+
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1906-L1922 "Source code on GitHub")
|
|
4490
4490
|
|
|
4491
4491
|
Remove a device from a mesh network.
|
|
4492
4492
|
|
|
@@ -4503,7 +4503,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4503
4503
|
|
|
4504
4504
|
### listMeshNetworkDevices
|
|
4505
4505
|
|
|
4506
|
-
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/
|
|
4506
|
+
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1936-L1945 "Source code on GitHub")
|
|
4507
4507
|
|
|
4508
4508
|
List all devices of a mesh network.
|
|
4509
4509
|
|
|
@@ -4522,7 +4522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4522
4522
|
|
|
4523
4523
|
### getProductConfiguration
|
|
4524
4524
|
|
|
4525
|
-
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/
|
|
4525
|
+
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1956-L1963 "Source code on GitHub")
|
|
4526
4526
|
|
|
4527
4527
|
Get product configuration
|
|
4528
4528
|
|
|
@@ -4538,7 +4538,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4538
4538
|
|
|
4539
4539
|
### getProductConfigurationSchema
|
|
4540
4540
|
|
|
4541
|
-
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/
|
|
4541
|
+
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1974-L1982 "Source code on GitHub")
|
|
4542
4542
|
|
|
4543
4543
|
Get product configuration schema
|
|
4544
4544
|
|
|
@@ -4554,7 +4554,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4554
4554
|
|
|
4555
4555
|
### getProductDeviceConfiguration
|
|
4556
4556
|
|
|
4557
|
-
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/
|
|
4557
|
+
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1994-L2001 "Source code on GitHub")
|
|
4558
4558
|
|
|
4559
4559
|
Get product device's configuration
|
|
4560
4560
|
|
|
@@ -4571,7 +4571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4571
4571
|
|
|
4572
4572
|
### getProductDeviceConfigurationSchema
|
|
4573
4573
|
|
|
4574
|
-
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/
|
|
4574
|
+
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2013-L2021 "Source code on GitHub")
|
|
4575
4575
|
|
|
4576
4576
|
Get product device's configuration schema
|
|
4577
4577
|
|
|
@@ -4588,7 +4588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4588
4588
|
|
|
4589
4589
|
### setProductConfiguration
|
|
4590
4590
|
|
|
4591
|
-
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/
|
|
4591
|
+
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2033-L2041 "Source code on GitHub")
|
|
4592
4592
|
|
|
4593
4593
|
Set product configuration
|
|
4594
4594
|
|
|
@@ -4605,7 +4605,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4605
4605
|
|
|
4606
4606
|
### setProductDeviceConfiguration
|
|
4607
4607
|
|
|
4608
|
-
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/
|
|
4608
|
+
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2054-L2062 "Source code on GitHub")
|
|
4609
4609
|
|
|
4610
4610
|
Set product configuration for a specific device within the product
|
|
4611
4611
|
|
|
@@ -4623,7 +4623,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4623
4623
|
|
|
4624
4624
|
### getProductLocations
|
|
4625
4625
|
|
|
4626
|
-
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/
|
|
4626
|
+
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2081-L2098 "Source code on GitHub")
|
|
4627
4627
|
|
|
4628
4628
|
Query location for devices within a product
|
|
4629
4629
|
|
|
@@ -4647,7 +4647,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4647
4647
|
|
|
4648
4648
|
### getProductDeviceLocations
|
|
4649
4649
|
|
|
4650
|
-
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/
|
|
4650
|
+
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2115-L2127 "Source code on GitHub")
|
|
4651
4651
|
|
|
4652
4652
|
Query location for one device within a product
|
|
4653
4653
|
|
|
@@ -4667,7 +4667,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4667
4667
|
|
|
4668
4668
|
### executeLogic
|
|
4669
4669
|
|
|
4670
|
-
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/
|
|
4670
|
+
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2143-L2151 "Source code on GitHub")
|
|
4671
4671
|
|
|
4672
4672
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
4673
4673
|
|
|
@@ -4686,7 +4686,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4686
4686
|
|
|
4687
4687
|
### createLogicFunction
|
|
4688
4688
|
|
|
4689
|
-
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/
|
|
4689
|
+
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2171-L2179 "Source code on GitHub")
|
|
4690
4690
|
|
|
4691
4691
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
4692
4692
|
|
|
@@ -4709,7 +4709,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4709
4709
|
|
|
4710
4710
|
### getLogicFunction
|
|
4711
4711
|
|
|
4712
|
-
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/
|
|
4712
|
+
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2193-L2200 "Source code on GitHub")
|
|
4713
4713
|
|
|
4714
4714
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
4715
4715
|
|
|
@@ -4726,7 +4726,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4726
4726
|
|
|
4727
4727
|
### updateLogicFunction
|
|
4728
4728
|
|
|
4729
|
-
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/
|
|
4729
|
+
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2217-L2225 "Source code on GitHub")
|
|
4730
4730
|
|
|
4731
4731
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
4732
4732
|
|
|
@@ -4746,7 +4746,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4746
4746
|
|
|
4747
4747
|
### deleteLogicFunction
|
|
4748
4748
|
|
|
4749
|
-
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/
|
|
4749
|
+
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2239-L2246 "Source code on GitHub")
|
|
4750
4750
|
|
|
4751
4751
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
4752
4752
|
|
|
@@ -4763,7 +4763,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4763
4763
|
|
|
4764
4764
|
### listLogicFunctions
|
|
4765
4765
|
|
|
4766
|
-
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/
|
|
4766
|
+
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2260-L2270 "Source code on GitHub")
|
|
4767
4767
|
|
|
4768
4768
|
Lists all logic functions in the specified organization or sandbox.
|
|
4769
4769
|
|
|
@@ -4780,7 +4780,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4780
4780
|
|
|
4781
4781
|
### listLogicRuns
|
|
4782
4782
|
|
|
4783
|
-
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/
|
|
4783
|
+
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2284-L2291 "Source code on GitHub")
|
|
4784
4784
|
|
|
4785
4785
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
4786
4786
|
|
|
@@ -4797,7 +4797,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4797
4797
|
|
|
4798
4798
|
### getLogicRun
|
|
4799
4799
|
|
|
4800
|
-
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/
|
|
4800
|
+
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2306-L2313 "Source code on GitHub")
|
|
4801
4801
|
|
|
4802
4802
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
4803
4803
|
|
|
@@ -4815,7 +4815,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4815
4815
|
|
|
4816
4816
|
### getLogicRunLogs
|
|
4817
4817
|
|
|
4818
|
-
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/
|
|
4818
|
+
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2328-L2335 "Source code on GitHub")
|
|
4819
4819
|
|
|
4820
4820
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
4821
4821
|
|
|
@@ -4833,7 +4833,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4833
4833
|
|
|
4834
4834
|
### createLedger
|
|
4835
4835
|
|
|
4836
|
-
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/
|
|
4836
|
+
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2349-L2357 "Source code on GitHub")
|
|
4837
4837
|
|
|
4838
4838
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
4839
4839
|
|
|
@@ -4850,7 +4850,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4850
4850
|
|
|
4851
4851
|
### getLedger
|
|
4852
4852
|
|
|
4853
|
-
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/
|
|
4853
|
+
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2371-L2378 "Source code on GitHub")
|
|
4854
4854
|
|
|
4855
4855
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
4856
4856
|
|
|
@@ -4867,7 +4867,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4867
4867
|
|
|
4868
4868
|
### updateLedger
|
|
4869
4869
|
|
|
4870
|
-
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/
|
|
4870
|
+
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2393-L2401 "Source code on GitHub")
|
|
4871
4871
|
|
|
4872
4872
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
4873
4873
|
|
|
@@ -4885,7 +4885,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4885
4885
|
|
|
4886
4886
|
### archiveLedger
|
|
4887
4887
|
|
|
4888
|
-
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/
|
|
4888
|
+
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2415-L2422 "Source code on GitHub")
|
|
4889
4889
|
|
|
4890
4890
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
4891
4891
|
|
|
@@ -4902,7 +4902,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4902
4902
|
|
|
4903
4903
|
### Scope
|
|
4904
4904
|
|
|
4905
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
4905
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
4906
4906
|
|
|
4907
4907
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
4908
4908
|
|
|
@@ -4920,7 +4920,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
4920
4920
|
|
|
4921
4921
|
### listLedgers
|
|
4922
4922
|
|
|
4923
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
4923
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
4924
4924
|
|
|
4925
4925
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
4926
4926
|
|
|
@@ -4940,7 +4940,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4940
4940
|
|
|
4941
4941
|
### getLedgerInstance
|
|
4942
4942
|
|
|
4943
|
-
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
4943
|
+
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2471-L2478 "Source code on GitHub")
|
|
4944
4944
|
|
|
4945
4945
|
Get ledger instance data.
|
|
4946
4946
|
|
|
@@ -4958,7 +4958,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4958
4958
|
|
|
4959
4959
|
### setLedgerInstance
|
|
4960
4960
|
|
|
4961
|
-
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/
|
|
4961
|
+
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2494-L2502 "Source code on GitHub")
|
|
4962
4962
|
|
|
4963
4963
|
Set ledger instance data.
|
|
4964
4964
|
|
|
@@ -4969,7 +4969,7 @@ Set ledger instance data.
|
|
|
4969
4969
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4970
4970
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
4971
4971
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
4972
|
-
- `options.
|
|
4972
|
+
- `options.instance` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The instance with the data
|
|
4973
4973
|
- `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.
|
|
4974
4974
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4975
4975
|
|
|
@@ -4977,7 +4977,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4977
4977
|
|
|
4978
4978
|
### deleteLedgerInstance
|
|
4979
4979
|
|
|
4980
|
-
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/
|
|
4980
|
+
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2517-L2524 "Source code on GitHub")
|
|
4981
4981
|
|
|
4982
4982
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
4983
4983
|
|
|
@@ -4995,7 +4995,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4995
4995
|
|
|
4996
4996
|
### listLedgerInstances
|
|
4997
4997
|
|
|
4998
|
-
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/
|
|
4998
|
+
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2540-L2551 "Source code on GitHub")
|
|
4999
4999
|
|
|
5000
5000
|
Lists ledger instances in the specified organization or sandbox.
|
|
5001
5001
|
|
|
@@ -5014,7 +5014,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5014
5014
|
|
|
5015
5015
|
### listLedgerInstanceVersions
|
|
5016
5016
|
|
|
5017
|
-
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/
|
|
5017
|
+
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2568-L2579 "Source code on GitHub")
|
|
5018
5018
|
|
|
5019
5019
|
List ledger instance versions
|
|
5020
5020
|
|
|
@@ -5034,7 +5034,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5034
5034
|
|
|
5035
5035
|
### getLedgerInstanceVersion
|
|
5036
5036
|
|
|
5037
|
-
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/
|
|
5037
|
+
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2595-L2602 "Source code on GitHub")
|
|
5038
5038
|
|
|
5039
5039
|
Get specific ledger instance version
|
|
5040
5040
|
|
|
@@ -5053,7 +5053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5053
5053
|
|
|
5054
5054
|
### setDefaultAuth
|
|
5055
5055
|
|
|
5056
|
-
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/
|
|
5056
|
+
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2609-L2617 "Source code on GitHub")
|
|
5057
5057
|
|
|
5058
5058
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
5059
5059
|
|
|
@@ -5066,7 +5066,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
5066
5066
|
|
|
5067
5067
|
### get
|
|
5068
5068
|
|
|
5069
|
-
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/
|
|
5069
|
+
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2660-L2664 "Source code on GitHub")
|
|
5070
5070
|
|
|
5071
5071
|
Make a GET request
|
|
5072
5072
|
|
|
@@ -5083,7 +5083,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5083
5083
|
|
|
5084
5084
|
### head
|
|
5085
5085
|
|
|
5086
|
-
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/
|
|
5086
|
+
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2676-L2680 "Source code on GitHub")
|
|
5087
5087
|
|
|
5088
5088
|
Make a HEAD request
|
|
5089
5089
|
|
|
@@ -5100,7 +5100,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5100
5100
|
|
|
5101
5101
|
### post
|
|
5102
5102
|
|
|
5103
|
-
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/
|
|
5103
|
+
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2692-L2696 "Source code on GitHub")
|
|
5104
5104
|
|
|
5105
5105
|
Make a POST request
|
|
5106
5106
|
|
|
@@ -5117,7 +5117,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5117
5117
|
|
|
5118
5118
|
### put
|
|
5119
5119
|
|
|
5120
|
-
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/
|
|
5120
|
+
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2708-L2712 "Source code on GitHub")
|
|
5121
5121
|
|
|
5122
5122
|
Make a PUT request
|
|
5123
5123
|
|
|
@@ -5134,7 +5134,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5134
5134
|
|
|
5135
5135
|
### delete
|
|
5136
5136
|
|
|
5137
|
-
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/
|
|
5137
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
5138
5138
|
|
|
5139
5139
|
Make a DELETE request
|
|
5140
5140
|
|
|
@@ -5151,7 +5151,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5151
5151
|
|
|
5152
5152
|
### request
|
|
5153
5153
|
|
|
5154
|
-
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/
|
|
5154
|
+
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2745-L2749 "Source code on GitHub")
|
|
5155
5155
|
|
|
5156
5156
|
**Parameters**
|
|
5157
5157
|
|
|
@@ -5171,7 +5171,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5171
5171
|
|
|
5172
5172
|
## Particle
|
|
5173
5173
|
|
|
5174
|
-
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/
|
|
5174
|
+
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L26-L2761 "Source code on GitHub")
|
|
5175
5175
|
|
|
5176
5176
|
**Parameters**
|
|
5177
5177
|
|
|
@@ -5179,7 +5179,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5179
5179
|
|
|
5180
5180
|
### constructor
|
|
5181
5181
|
|
|
5182
|
-
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/
|
|
5182
|
+
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L39-L48 "Source code on GitHub")
|
|
5183
5183
|
|
|
5184
5184
|
Contructor for the Cloud API wrapper.
|
|
5185
5185
|
|
|
@@ -5196,7 +5196,7 @@ Create a new Particle object and call methods below on it.
|
|
|
5196
5196
|
|
|
5197
5197
|
### login
|
|
5198
5198
|
|
|
5199
|
-
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/
|
|
5199
|
+
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L85-L102 "Source code on GitHub")
|
|
5200
5200
|
|
|
5201
5201
|
Login to Particle Cloud using an existing Particle acccount.
|
|
5202
5202
|
|
|
@@ -5213,7 +5213,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5213
5213
|
|
|
5214
5214
|
### sendOtp
|
|
5215
5215
|
|
|
5216
|
-
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/
|
|
5216
|
+
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L113-L129 "Source code on GitHub")
|
|
5217
5217
|
|
|
5218
5218
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
5219
5219
|
|
|
@@ -5229,7 +5229,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5229
5229
|
|
|
5230
5230
|
### enableMfa
|
|
5231
5231
|
|
|
5232
|
-
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/
|
|
5232
|
+
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L139-L141 "Source code on GitHub")
|
|
5233
5233
|
|
|
5234
5234
|
Enable MFA on the currently logged in user
|
|
5235
5235
|
|
|
@@ -5244,7 +5244,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5244
5244
|
|
|
5245
5245
|
### confirmMfa
|
|
5246
5246
|
|
|
5247
|
-
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/
|
|
5247
|
+
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L154-L168 "Source code on GitHub")
|
|
5248
5248
|
|
|
5249
5249
|
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.
|
|
5250
5250
|
|
|
@@ -5262,7 +5262,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5262
5262
|
|
|
5263
5263
|
### disableMfa
|
|
5264
5264
|
|
|
5265
|
-
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/
|
|
5265
|
+
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L179-L187 "Source code on GitHub")
|
|
5266
5266
|
|
|
5267
5267
|
Disable MFA for the user.
|
|
5268
5268
|
|
|
@@ -5278,7 +5278,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5278
5278
|
|
|
5279
5279
|
### createCustomer
|
|
5280
5280
|
|
|
5281
|
-
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/
|
|
5281
|
+
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L199-L215 "Source code on GitHub")
|
|
5282
5282
|
|
|
5283
5283
|
Create Customer for Product.
|
|
5284
5284
|
|
|
@@ -5295,7 +5295,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5295
5295
|
|
|
5296
5296
|
### loginAsClientOwner
|
|
5297
5297
|
|
|
5298
|
-
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/
|
|
5298
|
+
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L224-L238 "Source code on GitHub")
|
|
5299
5299
|
|
|
5300
5300
|
Login to Particle Cloud using an OAuth client.
|
|
5301
5301
|
|
|
@@ -5309,7 +5309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5309
5309
|
|
|
5310
5310
|
### createUser
|
|
5311
5311
|
|
|
5312
|
-
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/
|
|
5312
|
+
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L250-L261 "Source code on GitHub")
|
|
5313
5313
|
|
|
5314
5314
|
Create a user account for the Particle Cloud
|
|
5315
5315
|
|
|
@@ -5326,7 +5326,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5326
5326
|
|
|
5327
5327
|
### verifyUser
|
|
5328
5328
|
|
|
5329
|
-
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/
|
|
5329
|
+
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L271-L278 "Source code on GitHub")
|
|
5330
5330
|
|
|
5331
5331
|
Verify new user account via verification email
|
|
5332
5332
|
|
|
@@ -5341,7 +5341,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5341
5341
|
|
|
5342
5342
|
### resetPassword
|
|
5343
5343
|
|
|
5344
|
-
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/
|
|
5344
|
+
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L288-L295 "Source code on GitHub")
|
|
5345
5345
|
|
|
5346
5346
|
Send reset password email for a Particle Cloud user account
|
|
5347
5347
|
|
|
@@ -5356,7 +5356,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5356
5356
|
|
|
5357
5357
|
### deleteAccessToken
|
|
5358
5358
|
|
|
5359
|
-
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/
|
|
5359
|
+
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L307-L315 "Source code on GitHub")
|
|
5360
5360
|
|
|
5361
5361
|
Revoke an access token
|
|
5362
5362
|
|
|
@@ -5373,7 +5373,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5373
5373
|
|
|
5374
5374
|
### deleteCurrentAccessToken
|
|
5375
5375
|
|
|
5376
|
-
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/
|
|
5376
|
+
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L325-L332 "Source code on GitHub")
|
|
5377
5377
|
|
|
5378
5378
|
Revoke the current session access token
|
|
5379
5379
|
|
|
@@ -5388,7 +5388,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5388
5388
|
|
|
5389
5389
|
### deleteActiveAccessTokens
|
|
5390
5390
|
|
|
5391
|
-
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/
|
|
5391
|
+
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L342-L349 "Source code on GitHub")
|
|
5392
5392
|
|
|
5393
5393
|
Revoke all active access tokens
|
|
5394
5394
|
|
|
@@ -5403,7 +5403,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5403
5403
|
|
|
5404
5404
|
### deleteUser
|
|
5405
5405
|
|
|
5406
|
-
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/
|
|
5406
|
+
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L360-L368 "Source code on GitHub")
|
|
5407
5407
|
|
|
5408
5408
|
Delete the current user
|
|
5409
5409
|
|
|
@@ -5419,7 +5419,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5419
5419
|
|
|
5420
5420
|
### listAccessTokens
|
|
5421
5421
|
|
|
5422
|
-
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/
|
|
5422
|
+
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L380-L388 "Source code on GitHub")
|
|
5423
5423
|
|
|
5424
5424
|
List all valid access tokens for a Particle Cloud account
|
|
5425
5425
|
|
|
@@ -5436,7 +5436,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5436
5436
|
|
|
5437
5437
|
### trackingIdentity
|
|
5438
5438
|
|
|
5439
|
-
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/
|
|
5439
|
+
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L400-L408 "Source code on GitHub")
|
|
5440
5440
|
|
|
5441
5441
|
Retrieves the information that is used to identify the current login for tracking.
|
|
5442
5442
|
|
|
@@ -5453,7 +5453,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5453
5453
|
|
|
5454
5454
|
### listDevices
|
|
5455
5455
|
|
|
5456
|
-
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/
|
|
5456
|
+
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L426-L445 "Source code on GitHub")
|
|
5457
5457
|
|
|
5458
5458
|
List devices claimed to the account or product
|
|
5459
5459
|
|
|
@@ -5476,7 +5476,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5476
5476
|
|
|
5477
5477
|
### getDevice
|
|
5478
5478
|
|
|
5479
|
-
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/
|
|
5479
|
+
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L457-L460 "Source code on GitHub")
|
|
5480
5480
|
|
|
5481
5481
|
Get detailed informationa about a device
|
|
5482
5482
|
|
|
@@ -5493,7 +5493,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5493
5493
|
|
|
5494
5494
|
### claimDevice
|
|
5495
5495
|
|
|
5496
|
-
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/
|
|
5496
|
+
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L472-L483 "Source code on GitHub")
|
|
5497
5497
|
|
|
5498
5498
|
Claim a device to the account. The device must be online and unclaimed.
|
|
5499
5499
|
|
|
@@ -5510,7 +5510,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5510
5510
|
|
|
5511
5511
|
### addDeviceToProduct
|
|
5512
5512
|
|
|
5513
|
-
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/
|
|
5513
|
+
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L497-L515 "Source code on GitHub")
|
|
5514
5514
|
|
|
5515
5515
|
Add a device to a product or move device out of quarantine.
|
|
5516
5516
|
|
|
@@ -5529,7 +5529,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5529
5529
|
|
|
5530
5530
|
### removeDevice
|
|
5531
5531
|
|
|
5532
|
-
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/
|
|
5532
|
+
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L528-L532 "Source code on GitHub")
|
|
5533
5533
|
|
|
5534
5534
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
5535
5535
|
|
|
@@ -5547,7 +5547,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5547
5547
|
|
|
5548
5548
|
### removeDeviceOwner
|
|
5549
5549
|
|
|
5550
|
-
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/
|
|
5550
|
+
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L544-L547 "Source code on GitHub")
|
|
5551
5551
|
|
|
5552
5552
|
Unclaim a product device its the owner, but keep it in the product
|
|
5553
5553
|
|
|
@@ -5564,7 +5564,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5564
5564
|
|
|
5565
5565
|
### renameDevice
|
|
5566
5566
|
|
|
5567
|
-
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/
|
|
5567
|
+
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L560-L562 "Source code on GitHub")
|
|
5568
5568
|
|
|
5569
5569
|
Rename a device
|
|
5570
5570
|
|
|
@@ -5582,7 +5582,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5582
5582
|
|
|
5583
5583
|
### signalDevice
|
|
5584
5584
|
|
|
5585
|
-
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/
|
|
5585
|
+
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L575-L577 "Source code on GitHub")
|
|
5586
5586
|
|
|
5587
5587
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
5588
5588
|
|
|
@@ -5600,7 +5600,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5600
5600
|
|
|
5601
5601
|
### setDeviceNotes
|
|
5602
5602
|
|
|
5603
|
-
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/
|
|
5603
|
+
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L590-L592 "Source code on GitHub")
|
|
5604
5604
|
|
|
5605
5605
|
Store some notes about device
|
|
5606
5606
|
|
|
@@ -5618,7 +5618,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5618
5618
|
|
|
5619
5619
|
### markAsDevelopmentDevice
|
|
5620
5620
|
|
|
5621
|
-
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/
|
|
5621
|
+
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L605-L607 "Source code on GitHub")
|
|
5622
5622
|
|
|
5623
5623
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
5624
5624
|
|
|
@@ -5636,7 +5636,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5636
5636
|
|
|
5637
5637
|
### lockDeviceProductFirmware
|
|
5638
5638
|
|
|
5639
|
-
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/
|
|
5639
|
+
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L621-L623 "Source code on GitHub")
|
|
5640
5640
|
|
|
5641
5641
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
5642
5642
|
|
|
@@ -5655,7 +5655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5655
5655
|
|
|
5656
5656
|
### unlockDeviceProductFirmware
|
|
5657
5657
|
|
|
5658
|
-
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/
|
|
5658
|
+
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L635-L637 "Source code on GitHub")
|
|
5659
5659
|
|
|
5660
5660
|
Mark device as receiving automatic firmware updates
|
|
5661
5661
|
|
|
@@ -5672,7 +5672,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5672
5672
|
|
|
5673
5673
|
### updateDevice
|
|
5674
5674
|
|
|
5675
|
-
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/
|
|
5675
|
+
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L656-L668 "Source code on GitHub")
|
|
5676
5676
|
|
|
5677
5677
|
Update multiple device attributes at the same time
|
|
5678
5678
|
|
|
@@ -5696,7 +5696,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5696
5696
|
|
|
5697
5697
|
### provisionDevice
|
|
5698
5698
|
|
|
5699
|
-
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/
|
|
5699
|
+
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L679-L687 "Source code on GitHub")
|
|
5700
5700
|
|
|
5701
5701
|
Provision a new device for products that allow self-provisioning
|
|
5702
5702
|
|
|
@@ -5712,7 +5712,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5712
5712
|
|
|
5713
5713
|
### getClaimCode
|
|
5714
5714
|
|
|
5715
|
-
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/
|
|
5715
|
+
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L701-L704 "Source code on GitHub")
|
|
5716
5716
|
|
|
5717
5717
|
Generate a claim code to use in the device claiming process.
|
|
5718
5718
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -5731,7 +5731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5731
5731
|
|
|
5732
5732
|
### getVariable
|
|
5733
5733
|
|
|
5734
|
-
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/
|
|
5734
|
+
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L736-L742 "Source code on GitHub")
|
|
5735
5735
|
|
|
5736
5736
|
Get the value of a device variable
|
|
5737
5737
|
|
|
@@ -5749,7 +5749,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5749
5749
|
|
|
5750
5750
|
### flashDevice
|
|
5751
5751
|
|
|
5752
|
-
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/
|
|
5752
|
+
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L756-L767 "Source code on GitHub")
|
|
5753
5753
|
|
|
5754
5754
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
5755
5755
|
|
|
@@ -5768,7 +5768,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5768
5768
|
|
|
5769
5769
|
### flashTinker
|
|
5770
5770
|
|
|
5771
|
-
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/
|
|
5771
|
+
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L778-L793 "Source code on GitHub")
|
|
5772
5772
|
|
|
5773
5773
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
5774
5774
|
|
|
@@ -5784,7 +5784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5784
5784
|
|
|
5785
5785
|
### compileCode
|
|
5786
5786
|
|
|
5787
|
-
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/
|
|
5787
|
+
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L806-L824 "Source code on GitHub")
|
|
5788
5788
|
|
|
5789
5789
|
Compile firmware using the Particle Cloud
|
|
5790
5790
|
|
|
@@ -5802,7 +5802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5802
5802
|
|
|
5803
5803
|
### downloadFirmwareBinary
|
|
5804
5804
|
|
|
5805
|
-
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/
|
|
5805
|
+
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L835-L844 "Source code on GitHub")
|
|
5806
5806
|
|
|
5807
5807
|
Download a firmware binary
|
|
5808
5808
|
|
|
@@ -5818,7 +5818,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5818
5818
|
|
|
5819
5819
|
### sendPublicKey
|
|
5820
5820
|
|
|
5821
|
-
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/
|
|
5821
|
+
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L857-L871 "Source code on GitHub")
|
|
5822
5822
|
|
|
5823
5823
|
Send a new device public key to the Particle Cloud
|
|
5824
5824
|
|
|
@@ -5836,7 +5836,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5836
5836
|
|
|
5837
5837
|
### callFunction
|
|
5838
5838
|
|
|
5839
|
-
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/
|
|
5839
|
+
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L885-L890 "Source code on GitHub")
|
|
5840
5840
|
|
|
5841
5841
|
Call a device function
|
|
5842
5842
|
|
|
@@ -5855,7 +5855,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5855
5855
|
|
|
5856
5856
|
### getEventStream
|
|
5857
5857
|
|
|
5858
|
-
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/
|
|
5858
|
+
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L903-L928 "Source code on GitHub")
|
|
5859
5859
|
|
|
5860
5860
|
Get a stream of events
|
|
5861
5861
|
|
|
@@ -5873,7 +5873,7 @@ emit 'event' events.
|
|
|
5873
5873
|
|
|
5874
5874
|
### publishEvent
|
|
5875
5875
|
|
|
5876
|
-
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/
|
|
5876
|
+
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L942-L946 "Source code on GitHub")
|
|
5877
5877
|
|
|
5878
5878
|
Publish a event to the Particle Cloud
|
|
5879
5879
|
|
|
@@ -5892,7 +5892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5892
5892
|
|
|
5893
5893
|
### Hook
|
|
5894
5894
|
|
|
5895
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
5895
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
5896
5896
|
|
|
5897
5897
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
5898
5898
|
|
|
@@ -5925,7 +5925,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
5925
5925
|
|
|
5926
5926
|
### createWebhook
|
|
5927
5927
|
|
|
5928
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
5928
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
5929
5929
|
|
|
5930
5930
|
Create a webhook
|
|
5931
5931
|
|
|
@@ -5947,7 +5947,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5947
5947
|
|
|
5948
5948
|
### deleteWebhook
|
|
5949
5949
|
|
|
5950
|
-
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/
|
|
5950
|
+
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1011-L1014 "Source code on GitHub")
|
|
5951
5951
|
|
|
5952
5952
|
Delete a webhook
|
|
5953
5953
|
|
|
@@ -5964,7 +5964,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5964
5964
|
|
|
5965
5965
|
### listWebhooks
|
|
5966
5966
|
|
|
5967
|
-
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/
|
|
5967
|
+
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1025-L1028 "Source code on GitHub")
|
|
5968
5968
|
|
|
5969
5969
|
List all webhooks owned by the account or product
|
|
5970
5970
|
|
|
@@ -5980,7 +5980,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5980
5980
|
|
|
5981
5981
|
### createIntegration
|
|
5982
5982
|
|
|
5983
|
-
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/
|
|
5983
|
+
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1045-L1049 "Source code on GitHub")
|
|
5984
5984
|
|
|
5985
5985
|
Create an integration to send events to an external service
|
|
5986
5986
|
|
|
@@ -6001,7 +6001,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6001
6001
|
|
|
6002
6002
|
### editIntegration
|
|
6003
6003
|
|
|
6004
|
-
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/
|
|
6004
|
+
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1067-L1071 "Source code on GitHub")
|
|
6005
6005
|
|
|
6006
6006
|
Edit an integration to send events to an external service
|
|
6007
6007
|
|
|
@@ -6023,7 +6023,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6023
6023
|
|
|
6024
6024
|
### deleteIntegration
|
|
6025
6025
|
|
|
6026
|
-
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/
|
|
6026
|
+
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1084-L1087 "Source code on GitHub")
|
|
6027
6027
|
|
|
6028
6028
|
Delete an integration to send events to an external service
|
|
6029
6029
|
|
|
@@ -6040,7 +6040,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6040
6040
|
|
|
6041
6041
|
### listIntegrations
|
|
6042
6042
|
|
|
6043
|
-
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
6043
|
+
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1098-L1101 "Source code on GitHub")
|
|
6044
6044
|
|
|
6045
6045
|
List all integrations owned by the account or product
|
|
6046
6046
|
|
|
@@ -6056,7 +6056,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6056
6056
|
|
|
6057
6057
|
### getUserInfo
|
|
6058
6058
|
|
|
6059
|
-
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/
|
|
6059
|
+
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1111-L1113 "Source code on GitHub")
|
|
6060
6060
|
|
|
6061
6061
|
Get details about the current user
|
|
6062
6062
|
|
|
@@ -6071,7 +6071,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6071
6071
|
|
|
6072
6072
|
### setUserInfo
|
|
6073
6073
|
|
|
6074
|
-
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/
|
|
6074
|
+
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1124-L1127 "Source code on GitHub")
|
|
6075
6075
|
|
|
6076
6076
|
Set details on the current user
|
|
6077
6077
|
|
|
@@ -6087,7 +6087,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6087
6087
|
|
|
6088
6088
|
### changeUsername
|
|
6089
6089
|
|
|
6090
|
-
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/
|
|
6090
|
+
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1140-L1148 "Source code on GitHub")
|
|
6091
6091
|
|
|
6092
6092
|
Change username (i.e, email)
|
|
6093
6093
|
|
|
@@ -6105,7 +6105,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6105
6105
|
|
|
6106
6106
|
### changeUserPassword
|
|
6107
6107
|
|
|
6108
|
-
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/
|
|
6108
|
+
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1161-L1169 "Source code on GitHub")
|
|
6109
6109
|
|
|
6110
6110
|
Change user's password
|
|
6111
6111
|
|
|
@@ -6123,7 +6123,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6123
6123
|
|
|
6124
6124
|
### listSIMs
|
|
6125
6125
|
|
|
6126
|
-
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/
|
|
6126
|
+
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1185-L1189 "Source code on GitHub")
|
|
6127
6127
|
|
|
6128
6128
|
List SIM cards owned by a user or product
|
|
6129
6129
|
|
|
@@ -6144,7 +6144,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6144
6144
|
|
|
6145
6145
|
### getSIMDataUsage
|
|
6146
6146
|
|
|
6147
|
-
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/
|
|
6147
|
+
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1201-L1207 "Source code on GitHub")
|
|
6148
6148
|
|
|
6149
6149
|
Get data usage for one SIM card for the current billing period
|
|
6150
6150
|
|
|
@@ -6161,7 +6161,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6161
6161
|
|
|
6162
6162
|
### getFleetDataUsage
|
|
6163
6163
|
|
|
6164
|
-
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/
|
|
6164
|
+
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1218-L1225 "Source code on GitHub")
|
|
6165
6165
|
|
|
6166
6166
|
Get data usage for all SIM cards in a product the current billing period
|
|
6167
6167
|
|
|
@@ -6177,7 +6177,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6177
6177
|
|
|
6178
6178
|
### checkSIM
|
|
6179
6179
|
|
|
6180
|
-
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/
|
|
6180
|
+
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1236-L1238 "Source code on GitHub")
|
|
6181
6181
|
|
|
6182
6182
|
Check SIM status
|
|
6183
6183
|
|
|
@@ -6193,7 +6193,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6193
6193
|
|
|
6194
6194
|
### activateSIM
|
|
6195
6195
|
|
|
6196
|
-
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/
|
|
6196
|
+
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1253-L1263 "Source code on GitHub")
|
|
6197
6197
|
|
|
6198
6198
|
Activate and add SIM cards to an account or product
|
|
6199
6199
|
|
|
@@ -6213,7 +6213,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6213
6213
|
|
|
6214
6214
|
### deactivateSIM
|
|
6215
6215
|
|
|
6216
|
-
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/
|
|
6216
|
+
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1275-L1279 "Source code on GitHub")
|
|
6217
6217
|
|
|
6218
6218
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
6219
6219
|
|
|
@@ -6230,7 +6230,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6230
6230
|
|
|
6231
6231
|
### reactivateSIM
|
|
6232
6232
|
|
|
6233
|
-
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/
|
|
6233
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
6234
6234
|
|
|
6235
6235
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
6236
6236
|
|
|
@@ -6248,7 +6248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6248
6248
|
|
|
6249
6249
|
### updateSIM
|
|
6250
6250
|
|
|
6251
|
-
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/
|
|
6251
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
6252
6252
|
|
|
6253
6253
|
Update SIM card data limit
|
|
6254
6254
|
|
|
@@ -6266,7 +6266,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6266
6266
|
|
|
6267
6267
|
### removeSIM
|
|
6268
6268
|
|
|
6269
|
-
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/
|
|
6269
|
+
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1325-L1328 "Source code on GitHub")
|
|
6270
6270
|
|
|
6271
6271
|
Remove a SIM card from an account so it can be activated by a different account
|
|
6272
6272
|
|
|
@@ -6283,7 +6283,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6283
6283
|
|
|
6284
6284
|
### listBuildTargets
|
|
6285
6285
|
|
|
6286
|
-
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/
|
|
6286
|
+
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1339-L1342 "Source code on GitHub")
|
|
6287
6287
|
|
|
6288
6288
|
List valid build targets to be used for compiling
|
|
6289
6289
|
|
|
@@ -6299,7 +6299,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6299
6299
|
|
|
6300
6300
|
### listLibraries
|
|
6301
6301
|
|
|
6302
|
-
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/
|
|
6302
|
+
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1368-L1385 "Source code on GitHub")
|
|
6303
6303
|
|
|
6304
6304
|
List firmware libraries
|
|
6305
6305
|
|
|
@@ -6329,7 +6329,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6329
6329
|
|
|
6330
6330
|
### getLibrary
|
|
6331
6331
|
|
|
6332
|
-
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/
|
|
6332
|
+
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1401-L1409 "Source code on GitHub")
|
|
6333
6333
|
|
|
6334
6334
|
Get firmware library details
|
|
6335
6335
|
|
|
@@ -6346,7 +6346,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6346
6346
|
|
|
6347
6347
|
### getLibraryVersions
|
|
6348
6348
|
|
|
6349
|
-
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/
|
|
6349
|
+
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1422-L1430 "Source code on GitHub")
|
|
6350
6350
|
|
|
6351
6351
|
Firmware library details for each version
|
|
6352
6352
|
|
|
@@ -6364,7 +6364,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6364
6364
|
|
|
6365
6365
|
### contributeLibrary
|
|
6366
6366
|
|
|
6367
|
-
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/
|
|
6367
|
+
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1442-L1455 "Source code on GitHub")
|
|
6368
6368
|
|
|
6369
6369
|
Contribute a new library version from a compressed archive
|
|
6370
6370
|
|
|
@@ -6381,7 +6381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6381
6381
|
|
|
6382
6382
|
### publishLibrary
|
|
6383
6383
|
|
|
6384
|
-
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/
|
|
6384
|
+
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1466-L1475 "Source code on GitHub")
|
|
6385
6385
|
|
|
6386
6386
|
Publish the latest version of a library to the public
|
|
6387
6387
|
|
|
@@ -6397,7 +6397,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6397
6397
|
|
|
6398
6398
|
### deleteLibrary
|
|
6399
6399
|
|
|
6400
|
-
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
6400
|
+
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1487-L1495 "Source code on GitHub")
|
|
6401
6401
|
|
|
6402
6402
|
Delete one version of a library or an entire private library
|
|
6403
6403
|
|
|
@@ -6414,7 +6414,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6414
6414
|
|
|
6415
6415
|
### downloadFile
|
|
6416
6416
|
|
|
6417
|
-
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/
|
|
6417
|
+
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1505-L1507 "Source code on GitHub")
|
|
6418
6418
|
|
|
6419
6419
|
Download an external file that may not be on the API
|
|
6420
6420
|
|
|
@@ -6429,7 +6429,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6429
6429
|
|
|
6430
6430
|
### listOAuthClients
|
|
6431
6431
|
|
|
6432
|
-
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/
|
|
6432
|
+
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1518-L1521 "Source code on GitHub")
|
|
6433
6433
|
|
|
6434
6434
|
List OAuth client created by the account
|
|
6435
6435
|
|
|
@@ -6445,7 +6445,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6445
6445
|
|
|
6446
6446
|
### createOAuthClient
|
|
6447
6447
|
|
|
6448
|
-
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/
|
|
6448
|
+
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1536-L1540 "Source code on GitHub")
|
|
6449
6449
|
|
|
6450
6450
|
Create an OAuth client
|
|
6451
6451
|
|
|
@@ -6465,7 +6465,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6465
6465
|
|
|
6466
6466
|
### updateOAuthClient
|
|
6467
6467
|
|
|
6468
|
-
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/
|
|
6468
|
+
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1554-L1558 "Source code on GitHub")
|
|
6469
6469
|
|
|
6470
6470
|
Update an OAuth client
|
|
6471
6471
|
|
|
@@ -6484,7 +6484,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6484
6484
|
|
|
6485
6485
|
### deleteOAuthClient
|
|
6486
6486
|
|
|
6487
|
-
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
6487
|
+
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1570-L1573 "Source code on GitHub")
|
|
6488
6488
|
|
|
6489
6489
|
Delete an OAuth client
|
|
6490
6490
|
|
|
@@ -6501,7 +6501,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6501
6501
|
|
|
6502
6502
|
### listProducts
|
|
6503
6503
|
|
|
6504
|
-
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/
|
|
6504
|
+
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1583-L1585 "Source code on GitHub")
|
|
6505
6505
|
|
|
6506
6506
|
List products the account has access to
|
|
6507
6507
|
|
|
@@ -6516,7 +6516,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6516
6516
|
|
|
6517
6517
|
### getProduct
|
|
6518
6518
|
|
|
6519
|
-
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/
|
|
6519
|
+
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1596-L1598 "Source code on GitHub")
|
|
6520
6520
|
|
|
6521
6521
|
Get detailed information about a product
|
|
6522
6522
|
|
|
@@ -6532,7 +6532,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6532
6532
|
|
|
6533
6533
|
### listProductFirmware
|
|
6534
6534
|
|
|
6535
|
-
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/
|
|
6535
|
+
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1609-L1611 "Source code on GitHub")
|
|
6536
6536
|
|
|
6537
6537
|
List product firmware versions
|
|
6538
6538
|
|
|
@@ -6548,7 +6548,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6548
6548
|
|
|
6549
6549
|
### uploadProductFirmware
|
|
6550
6550
|
|
|
6551
|
-
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/
|
|
6551
|
+
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1627-L1643 "Source code on GitHub")
|
|
6552
6552
|
|
|
6553
6553
|
List product firmware versions
|
|
6554
6554
|
|
|
@@ -6569,7 +6569,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6569
6569
|
|
|
6570
6570
|
### getProductFirmware
|
|
6571
6571
|
|
|
6572
|
-
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/
|
|
6572
|
+
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1655-L1662 "Source code on GitHub")
|
|
6573
6573
|
|
|
6574
6574
|
Get information about a product firmware version
|
|
6575
6575
|
|
|
@@ -6586,7 +6586,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6586
6586
|
|
|
6587
6587
|
### updateProductFirmware
|
|
6588
6588
|
|
|
6589
|
-
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/
|
|
6589
|
+
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1676-L1679 "Source code on GitHub")
|
|
6590
6590
|
|
|
6591
6591
|
Update information for a product firmware version
|
|
6592
6592
|
|
|
@@ -6605,7 +6605,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6605
6605
|
|
|
6606
6606
|
### downloadProductFirmware
|
|
6607
6607
|
|
|
6608
|
-
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/
|
|
6608
|
+
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1691-L1700 "Source code on GitHub")
|
|
6609
6609
|
|
|
6610
6610
|
Download a product firmware binary
|
|
6611
6611
|
|
|
@@ -6622,7 +6622,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6622
6622
|
|
|
6623
6623
|
### releaseProductFirmware
|
|
6624
6624
|
|
|
6625
|
-
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/
|
|
6625
|
+
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1712-L1715 "Source code on GitHub")
|
|
6626
6626
|
|
|
6627
6627
|
Release a product firmware version as the default version
|
|
6628
6628
|
|
|
@@ -6639,7 +6639,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6639
6639
|
|
|
6640
6640
|
### listTeamMembers
|
|
6641
6641
|
|
|
6642
|
-
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/
|
|
6642
|
+
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1726-L1733 "Source code on GitHub")
|
|
6643
6643
|
|
|
6644
6644
|
List product team members
|
|
6645
6645
|
|
|
@@ -6655,7 +6655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6655
6655
|
|
|
6656
6656
|
### inviteTeamMember
|
|
6657
6657
|
|
|
6658
|
-
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/
|
|
6658
|
+
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1745-L1753 "Source code on GitHub")
|
|
6659
6659
|
|
|
6660
6660
|
Invite Particle user to a product team
|
|
6661
6661
|
|
|
@@ -6672,7 +6672,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6672
6672
|
|
|
6673
6673
|
### removeTeamMember
|
|
6674
6674
|
|
|
6675
|
-
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/
|
|
6675
|
+
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1765-L1772 "Source code on GitHub")
|
|
6676
6676
|
|
|
6677
6677
|
Remove Particle user to a product team
|
|
6678
6678
|
|
|
@@ -6689,7 +6689,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6689
6689
|
|
|
6690
6690
|
### lookupSerialNumber
|
|
6691
6691
|
|
|
6692
|
-
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/
|
|
6692
|
+
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1783-L1790 "Source code on GitHub")
|
|
6693
6693
|
|
|
6694
6694
|
Fetch details about a serial number
|
|
6695
6695
|
|
|
@@ -6705,7 +6705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6705
6705
|
|
|
6706
6706
|
### createMeshNetwork
|
|
6707
6707
|
|
|
6708
|
-
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/
|
|
6708
|
+
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1803-L1811 "Source code on GitHub")
|
|
6709
6709
|
|
|
6710
6710
|
Create a mesh network
|
|
6711
6711
|
|
|
@@ -6723,7 +6723,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6723
6723
|
|
|
6724
6724
|
### removeMeshNetwork
|
|
6725
6725
|
|
|
6726
|
-
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/
|
|
6726
|
+
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1822-L1824 "Source code on GitHub")
|
|
6727
6727
|
|
|
6728
6728
|
Remove a mesh network.
|
|
6729
6729
|
|
|
@@ -6739,7 +6739,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6739
6739
|
|
|
6740
6740
|
### listMeshNetworks
|
|
6741
6741
|
|
|
6742
|
-
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/
|
|
6742
|
+
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1836-L1839 "Source code on GitHub")
|
|
6743
6743
|
|
|
6744
6744
|
List all mesh networks
|
|
6745
6745
|
|
|
@@ -6756,7 +6756,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6756
6756
|
|
|
6757
6757
|
### getMeshNetwork
|
|
6758
6758
|
|
|
6759
|
-
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/
|
|
6759
|
+
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1850-L1852 "Source code on GitHub")
|
|
6760
6760
|
|
|
6761
6761
|
Get information about a mesh network.
|
|
6762
6762
|
|
|
@@ -6772,7 +6772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6772
6772
|
|
|
6773
6773
|
### updateMeshNetwork
|
|
6774
6774
|
|
|
6775
|
-
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/
|
|
6775
|
+
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1865-L1873 "Source code on GitHub")
|
|
6776
6776
|
|
|
6777
6777
|
Modify a mesh network.
|
|
6778
6778
|
|
|
@@ -6790,7 +6790,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6790
6790
|
|
|
6791
6791
|
### addMeshNetworkDevice
|
|
6792
6792
|
|
|
6793
|
-
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/
|
|
6793
|
+
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1885-L1894 "Source code on GitHub")
|
|
6794
6794
|
|
|
6795
6795
|
Add a device to a mesh network.
|
|
6796
6796
|
|
|
@@ -6807,7 +6807,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6807
6807
|
|
|
6808
6808
|
### removeMeshNetworkDevice
|
|
6809
6809
|
|
|
6810
|
-
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/
|
|
6810
|
+
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1906-L1922 "Source code on GitHub")
|
|
6811
6811
|
|
|
6812
6812
|
Remove a device from a mesh network.
|
|
6813
6813
|
|
|
@@ -6824,7 +6824,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6824
6824
|
|
|
6825
6825
|
### listMeshNetworkDevices
|
|
6826
6826
|
|
|
6827
|
-
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/
|
|
6827
|
+
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1936-L1945 "Source code on GitHub")
|
|
6828
6828
|
|
|
6829
6829
|
List all devices of a mesh network.
|
|
6830
6830
|
|
|
@@ -6843,7 +6843,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6843
6843
|
|
|
6844
6844
|
### getProductConfiguration
|
|
6845
6845
|
|
|
6846
|
-
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/
|
|
6846
|
+
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1956-L1963 "Source code on GitHub")
|
|
6847
6847
|
|
|
6848
6848
|
Get product configuration
|
|
6849
6849
|
|
|
@@ -6859,7 +6859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6859
6859
|
|
|
6860
6860
|
### getProductConfigurationSchema
|
|
6861
6861
|
|
|
6862
|
-
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/
|
|
6862
|
+
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1974-L1982 "Source code on GitHub")
|
|
6863
6863
|
|
|
6864
6864
|
Get product configuration schema
|
|
6865
6865
|
|
|
@@ -6875,7 +6875,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6875
6875
|
|
|
6876
6876
|
### getProductDeviceConfiguration
|
|
6877
6877
|
|
|
6878
|
-
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/
|
|
6878
|
+
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1994-L2001 "Source code on GitHub")
|
|
6879
6879
|
|
|
6880
6880
|
Get product device's configuration
|
|
6881
6881
|
|
|
@@ -6892,7 +6892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6892
6892
|
|
|
6893
6893
|
### getProductDeviceConfigurationSchema
|
|
6894
6894
|
|
|
6895
|
-
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/
|
|
6895
|
+
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2013-L2021 "Source code on GitHub")
|
|
6896
6896
|
|
|
6897
6897
|
Get product device's configuration schema
|
|
6898
6898
|
|
|
@@ -6909,7 +6909,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6909
6909
|
|
|
6910
6910
|
### setProductConfiguration
|
|
6911
6911
|
|
|
6912
|
-
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/
|
|
6912
|
+
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2033-L2041 "Source code on GitHub")
|
|
6913
6913
|
|
|
6914
6914
|
Set product configuration
|
|
6915
6915
|
|
|
@@ -6926,7 +6926,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6926
6926
|
|
|
6927
6927
|
### setProductDeviceConfiguration
|
|
6928
6928
|
|
|
6929
|
-
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/
|
|
6929
|
+
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2054-L2062 "Source code on GitHub")
|
|
6930
6930
|
|
|
6931
6931
|
Set product configuration for a specific device within the product
|
|
6932
6932
|
|
|
@@ -6944,7 +6944,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6944
6944
|
|
|
6945
6945
|
### getProductLocations
|
|
6946
6946
|
|
|
6947
|
-
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/
|
|
6947
|
+
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2081-L2098 "Source code on GitHub")
|
|
6948
6948
|
|
|
6949
6949
|
Query location for devices within a product
|
|
6950
6950
|
|
|
@@ -6968,7 +6968,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6968
6968
|
|
|
6969
6969
|
### getProductDeviceLocations
|
|
6970
6970
|
|
|
6971
|
-
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/
|
|
6971
|
+
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2115-L2127 "Source code on GitHub")
|
|
6972
6972
|
|
|
6973
6973
|
Query location for one device within a product
|
|
6974
6974
|
|
|
@@ -6988,7 +6988,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6988
6988
|
|
|
6989
6989
|
### executeLogic
|
|
6990
6990
|
|
|
6991
|
-
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/
|
|
6991
|
+
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2143-L2151 "Source code on GitHub")
|
|
6992
6992
|
|
|
6993
6993
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
6994
6994
|
|
|
@@ -7007,7 +7007,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7007
7007
|
|
|
7008
7008
|
### createLogicFunction
|
|
7009
7009
|
|
|
7010
|
-
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/
|
|
7010
|
+
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2171-L2179 "Source code on GitHub")
|
|
7011
7011
|
|
|
7012
7012
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
7013
7013
|
|
|
@@ -7030,7 +7030,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7030
7030
|
|
|
7031
7031
|
### getLogicFunction
|
|
7032
7032
|
|
|
7033
|
-
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/
|
|
7033
|
+
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2193-L2200 "Source code on GitHub")
|
|
7034
7034
|
|
|
7035
7035
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
7036
7036
|
|
|
@@ -7047,7 +7047,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7047
7047
|
|
|
7048
7048
|
### updateLogicFunction
|
|
7049
7049
|
|
|
7050
|
-
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/
|
|
7050
|
+
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2217-L2225 "Source code on GitHub")
|
|
7051
7051
|
|
|
7052
7052
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
7053
7053
|
|
|
@@ -7067,7 +7067,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7067
7067
|
|
|
7068
7068
|
### deleteLogicFunction
|
|
7069
7069
|
|
|
7070
|
-
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/
|
|
7070
|
+
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2239-L2246 "Source code on GitHub")
|
|
7071
7071
|
|
|
7072
7072
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
7073
7073
|
|
|
@@ -7084,7 +7084,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7084
7084
|
|
|
7085
7085
|
### listLogicFunctions
|
|
7086
7086
|
|
|
7087
|
-
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/
|
|
7087
|
+
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2260-L2270 "Source code on GitHub")
|
|
7088
7088
|
|
|
7089
7089
|
Lists all logic functions in the specified organization or sandbox.
|
|
7090
7090
|
|
|
@@ -7101,7 +7101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7101
7101
|
|
|
7102
7102
|
### listLogicRuns
|
|
7103
7103
|
|
|
7104
|
-
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/
|
|
7104
|
+
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2284-L2291 "Source code on GitHub")
|
|
7105
7105
|
|
|
7106
7106
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
7107
7107
|
|
|
@@ -7118,7 +7118,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7118
7118
|
|
|
7119
7119
|
### getLogicRun
|
|
7120
7120
|
|
|
7121
|
-
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/
|
|
7121
|
+
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2306-L2313 "Source code on GitHub")
|
|
7122
7122
|
|
|
7123
7123
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
7124
7124
|
|
|
@@ -7136,7 +7136,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7136
7136
|
|
|
7137
7137
|
### getLogicRunLogs
|
|
7138
7138
|
|
|
7139
|
-
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/
|
|
7139
|
+
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2328-L2335 "Source code on GitHub")
|
|
7140
7140
|
|
|
7141
7141
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
7142
7142
|
|
|
@@ -7154,7 +7154,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7154
7154
|
|
|
7155
7155
|
### createLedger
|
|
7156
7156
|
|
|
7157
|
-
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/
|
|
7157
|
+
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2349-L2357 "Source code on GitHub")
|
|
7158
7158
|
|
|
7159
7159
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
7160
7160
|
|
|
@@ -7171,7 +7171,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7171
7171
|
|
|
7172
7172
|
### getLedger
|
|
7173
7173
|
|
|
7174
|
-
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/
|
|
7174
|
+
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2371-L2378 "Source code on GitHub")
|
|
7175
7175
|
|
|
7176
7176
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
7177
7177
|
|
|
@@ -7188,7 +7188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7188
7188
|
|
|
7189
7189
|
### updateLedger
|
|
7190
7190
|
|
|
7191
|
-
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/
|
|
7191
|
+
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2393-L2401 "Source code on GitHub")
|
|
7192
7192
|
|
|
7193
7193
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
7194
7194
|
|
|
@@ -7206,7 +7206,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7206
7206
|
|
|
7207
7207
|
### archiveLedger
|
|
7208
7208
|
|
|
7209
|
-
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/
|
|
7209
|
+
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2415-L2422 "Source code on GitHub")
|
|
7210
7210
|
|
|
7211
7211
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
7212
7212
|
|
|
@@ -7223,7 +7223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7223
7223
|
|
|
7224
7224
|
### Scope
|
|
7225
7225
|
|
|
7226
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
7226
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
7227
7227
|
|
|
7228
7228
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
7229
7229
|
|
|
@@ -7241,7 +7241,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
7241
7241
|
|
|
7242
7242
|
### listLedgers
|
|
7243
7243
|
|
|
7244
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
7244
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
7245
7245
|
|
|
7246
7246
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
7247
7247
|
|
|
@@ -7261,7 +7261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7261
7261
|
|
|
7262
7262
|
### getLedgerInstance
|
|
7263
7263
|
|
|
7264
|
-
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
7264
|
+
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2471-L2478 "Source code on GitHub")
|
|
7265
7265
|
|
|
7266
7266
|
Get ledger instance data.
|
|
7267
7267
|
|
|
@@ -7279,7 +7279,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7279
7279
|
|
|
7280
7280
|
### setLedgerInstance
|
|
7281
7281
|
|
|
7282
|
-
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/
|
|
7282
|
+
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2494-L2502 "Source code on GitHub")
|
|
7283
7283
|
|
|
7284
7284
|
Set ledger instance data.
|
|
7285
7285
|
|
|
@@ -7290,7 +7290,7 @@ Set ledger instance data.
|
|
|
7290
7290
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
7291
7291
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
7292
7292
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
7293
|
-
- `options.
|
|
7293
|
+
- `options.instance` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The instance with the data
|
|
7294
7294
|
- `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.
|
|
7295
7295
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
7296
7296
|
|
|
@@ -7298,7 +7298,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7298
7298
|
|
|
7299
7299
|
### deleteLedgerInstance
|
|
7300
7300
|
|
|
7301
|
-
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/
|
|
7301
|
+
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2517-L2524 "Source code on GitHub")
|
|
7302
7302
|
|
|
7303
7303
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
7304
7304
|
|
|
@@ -7316,7 +7316,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7316
7316
|
|
|
7317
7317
|
### listLedgerInstances
|
|
7318
7318
|
|
|
7319
|
-
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/
|
|
7319
|
+
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2540-L2551 "Source code on GitHub")
|
|
7320
7320
|
|
|
7321
7321
|
Lists ledger instances in the specified organization or sandbox.
|
|
7322
7322
|
|
|
@@ -7335,7 +7335,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7335
7335
|
|
|
7336
7336
|
### listLedgerInstanceVersions
|
|
7337
7337
|
|
|
7338
|
-
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/
|
|
7338
|
+
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2568-L2579 "Source code on GitHub")
|
|
7339
7339
|
|
|
7340
7340
|
List ledger instance versions
|
|
7341
7341
|
|
|
@@ -7355,7 +7355,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7355
7355
|
|
|
7356
7356
|
### getLedgerInstanceVersion
|
|
7357
7357
|
|
|
7358
|
-
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/
|
|
7358
|
+
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2595-L2602 "Source code on GitHub")
|
|
7359
7359
|
|
|
7360
7360
|
Get specific ledger instance version
|
|
7361
7361
|
|
|
@@ -7374,7 +7374,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7374
7374
|
|
|
7375
7375
|
### setDefaultAuth
|
|
7376
7376
|
|
|
7377
|
-
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/
|
|
7377
|
+
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2609-L2617 "Source code on GitHub")
|
|
7378
7378
|
|
|
7379
7379
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
7380
7380
|
|
|
@@ -7387,7 +7387,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
7387
7387
|
|
|
7388
7388
|
### get
|
|
7389
7389
|
|
|
7390
|
-
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/
|
|
7390
|
+
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2660-L2664 "Source code on GitHub")
|
|
7391
7391
|
|
|
7392
7392
|
Make a GET request
|
|
7393
7393
|
|
|
@@ -7404,7 +7404,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7404
7404
|
|
|
7405
7405
|
### head
|
|
7406
7406
|
|
|
7407
|
-
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/
|
|
7407
|
+
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2676-L2680 "Source code on GitHub")
|
|
7408
7408
|
|
|
7409
7409
|
Make a HEAD request
|
|
7410
7410
|
|
|
@@ -7421,7 +7421,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7421
7421
|
|
|
7422
7422
|
### post
|
|
7423
7423
|
|
|
7424
|
-
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/
|
|
7424
|
+
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2692-L2696 "Source code on GitHub")
|
|
7425
7425
|
|
|
7426
7426
|
Make a POST request
|
|
7427
7427
|
|
|
@@ -7438,7 +7438,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7438
7438
|
|
|
7439
7439
|
### put
|
|
7440
7440
|
|
|
7441
|
-
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/
|
|
7441
|
+
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2708-L2712 "Source code on GitHub")
|
|
7442
7442
|
|
|
7443
7443
|
Make a PUT request
|
|
7444
7444
|
|
|
@@ -7455,7 +7455,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7455
7455
|
|
|
7456
7456
|
### delete
|
|
7457
7457
|
|
|
7458
|
-
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/
|
|
7458
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
7459
7459
|
|
|
7460
7460
|
Make a DELETE request
|
|
7461
7461
|
|
|
@@ -7472,7 +7472,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7472
7472
|
|
|
7473
7473
|
### request
|
|
7474
7474
|
|
|
7475
|
-
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/
|
|
7475
|
+
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2745-L2749 "Source code on GitHub")
|
|
7476
7476
|
|
|
7477
7477
|
**Parameters**
|
|
7478
7478
|
|
|
@@ -7492,7 +7492,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7492
7492
|
|
|
7493
7493
|
## Particle
|
|
7494
7494
|
|
|
7495
|
-
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/
|
|
7495
|
+
[src/Particle.js:26-2761](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L26-L2761 "Source code on GitHub")
|
|
7496
7496
|
|
|
7497
7497
|
Particle Cloud API wrapper.
|
|
7498
7498
|
|
|
@@ -7508,7 +7508,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
7508
7508
|
|
|
7509
7509
|
### constructor
|
|
7510
7510
|
|
|
7511
|
-
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/
|
|
7511
|
+
[src/Particle.js:39-48](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L39-L48 "Source code on GitHub")
|
|
7512
7512
|
|
|
7513
7513
|
Contructor for the Cloud API wrapper.
|
|
7514
7514
|
|
|
@@ -7525,7 +7525,7 @@ Create a new Particle object and call methods below on it.
|
|
|
7525
7525
|
|
|
7526
7526
|
### login
|
|
7527
7527
|
|
|
7528
|
-
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/
|
|
7528
|
+
[src/Particle.js:85-102](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L85-L102 "Source code on GitHub")
|
|
7529
7529
|
|
|
7530
7530
|
Login to Particle Cloud using an existing Particle acccount.
|
|
7531
7531
|
|
|
@@ -7542,7 +7542,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7542
7542
|
|
|
7543
7543
|
### sendOtp
|
|
7544
7544
|
|
|
7545
|
-
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/
|
|
7545
|
+
[src/Particle.js:113-129](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L113-L129 "Source code on GitHub")
|
|
7546
7546
|
|
|
7547
7547
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
7548
7548
|
|
|
@@ -7558,7 +7558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7558
7558
|
|
|
7559
7559
|
### enableMfa
|
|
7560
7560
|
|
|
7561
|
-
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/
|
|
7561
|
+
[src/Particle.js:139-141](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L139-L141 "Source code on GitHub")
|
|
7562
7562
|
|
|
7563
7563
|
Enable MFA on the currently logged in user
|
|
7564
7564
|
|
|
@@ -7573,7 +7573,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7573
7573
|
|
|
7574
7574
|
### confirmMfa
|
|
7575
7575
|
|
|
7576
|
-
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/
|
|
7576
|
+
[src/Particle.js:154-168](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L154-L168 "Source code on GitHub")
|
|
7577
7577
|
|
|
7578
7578
|
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.
|
|
7579
7579
|
|
|
@@ -7591,7 +7591,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7591
7591
|
|
|
7592
7592
|
### disableMfa
|
|
7593
7593
|
|
|
7594
|
-
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/
|
|
7594
|
+
[src/Particle.js:179-187](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L179-L187 "Source code on GitHub")
|
|
7595
7595
|
|
|
7596
7596
|
Disable MFA for the user.
|
|
7597
7597
|
|
|
@@ -7607,7 +7607,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7607
7607
|
|
|
7608
7608
|
### createCustomer
|
|
7609
7609
|
|
|
7610
|
-
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/
|
|
7610
|
+
[src/Particle.js:199-215](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L199-L215 "Source code on GitHub")
|
|
7611
7611
|
|
|
7612
7612
|
Create Customer for Product.
|
|
7613
7613
|
|
|
@@ -7624,7 +7624,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7624
7624
|
|
|
7625
7625
|
### loginAsClientOwner
|
|
7626
7626
|
|
|
7627
|
-
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/
|
|
7627
|
+
[src/Particle.js:224-238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L224-L238 "Source code on GitHub")
|
|
7628
7628
|
|
|
7629
7629
|
Login to Particle Cloud using an OAuth client.
|
|
7630
7630
|
|
|
@@ -7638,7 +7638,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7638
7638
|
|
|
7639
7639
|
### createUser
|
|
7640
7640
|
|
|
7641
|
-
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/
|
|
7641
|
+
[src/Particle.js:250-261](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L250-L261 "Source code on GitHub")
|
|
7642
7642
|
|
|
7643
7643
|
Create a user account for the Particle Cloud
|
|
7644
7644
|
|
|
@@ -7655,7 +7655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7655
7655
|
|
|
7656
7656
|
### verifyUser
|
|
7657
7657
|
|
|
7658
|
-
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/
|
|
7658
|
+
[src/Particle.js:271-278](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L271-L278 "Source code on GitHub")
|
|
7659
7659
|
|
|
7660
7660
|
Verify new user account via verification email
|
|
7661
7661
|
|
|
@@ -7670,7 +7670,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7670
7670
|
|
|
7671
7671
|
### resetPassword
|
|
7672
7672
|
|
|
7673
|
-
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/
|
|
7673
|
+
[src/Particle.js:288-295](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L288-L295 "Source code on GitHub")
|
|
7674
7674
|
|
|
7675
7675
|
Send reset password email for a Particle Cloud user account
|
|
7676
7676
|
|
|
@@ -7685,7 +7685,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7685
7685
|
|
|
7686
7686
|
### deleteAccessToken
|
|
7687
7687
|
|
|
7688
|
-
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/
|
|
7688
|
+
[src/Particle.js:307-315](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L307-L315 "Source code on GitHub")
|
|
7689
7689
|
|
|
7690
7690
|
Revoke an access token
|
|
7691
7691
|
|
|
@@ -7702,7 +7702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7702
7702
|
|
|
7703
7703
|
### deleteCurrentAccessToken
|
|
7704
7704
|
|
|
7705
|
-
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/
|
|
7705
|
+
[src/Particle.js:325-332](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L325-L332 "Source code on GitHub")
|
|
7706
7706
|
|
|
7707
7707
|
Revoke the current session access token
|
|
7708
7708
|
|
|
@@ -7717,7 +7717,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7717
7717
|
|
|
7718
7718
|
### deleteActiveAccessTokens
|
|
7719
7719
|
|
|
7720
|
-
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/
|
|
7720
|
+
[src/Particle.js:342-349](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L342-L349 "Source code on GitHub")
|
|
7721
7721
|
|
|
7722
7722
|
Revoke all active access tokens
|
|
7723
7723
|
|
|
@@ -7732,7 +7732,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7732
7732
|
|
|
7733
7733
|
### deleteUser
|
|
7734
7734
|
|
|
7735
|
-
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/
|
|
7735
|
+
[src/Particle.js:360-368](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L360-L368 "Source code on GitHub")
|
|
7736
7736
|
|
|
7737
7737
|
Delete the current user
|
|
7738
7738
|
|
|
@@ -7748,7 +7748,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7748
7748
|
|
|
7749
7749
|
### listAccessTokens
|
|
7750
7750
|
|
|
7751
|
-
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/
|
|
7751
|
+
[src/Particle.js:380-388](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L380-L388 "Source code on GitHub")
|
|
7752
7752
|
|
|
7753
7753
|
List all valid access tokens for a Particle Cloud account
|
|
7754
7754
|
|
|
@@ -7765,7 +7765,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7765
7765
|
|
|
7766
7766
|
### trackingIdentity
|
|
7767
7767
|
|
|
7768
|
-
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/
|
|
7768
|
+
[src/Particle.js:400-408](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L400-L408 "Source code on GitHub")
|
|
7769
7769
|
|
|
7770
7770
|
Retrieves the information that is used to identify the current login for tracking.
|
|
7771
7771
|
|
|
@@ -7782,7 +7782,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7782
7782
|
|
|
7783
7783
|
### listDevices
|
|
7784
7784
|
|
|
7785
|
-
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/
|
|
7785
|
+
[src/Particle.js:426-445](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L426-L445 "Source code on GitHub")
|
|
7786
7786
|
|
|
7787
7787
|
List devices claimed to the account or product
|
|
7788
7788
|
|
|
@@ -7805,7 +7805,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7805
7805
|
|
|
7806
7806
|
### getDevice
|
|
7807
7807
|
|
|
7808
|
-
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/
|
|
7808
|
+
[src/Particle.js:457-460](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L457-L460 "Source code on GitHub")
|
|
7809
7809
|
|
|
7810
7810
|
Get detailed informationa about a device
|
|
7811
7811
|
|
|
@@ -7822,7 +7822,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7822
7822
|
|
|
7823
7823
|
### claimDevice
|
|
7824
7824
|
|
|
7825
|
-
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/
|
|
7825
|
+
[src/Particle.js:472-483](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L472-L483 "Source code on GitHub")
|
|
7826
7826
|
|
|
7827
7827
|
Claim a device to the account. The device must be online and unclaimed.
|
|
7828
7828
|
|
|
@@ -7839,7 +7839,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7839
7839
|
|
|
7840
7840
|
### addDeviceToProduct
|
|
7841
7841
|
|
|
7842
|
-
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/
|
|
7842
|
+
[src/Particle.js:497-515](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L497-L515 "Source code on GitHub")
|
|
7843
7843
|
|
|
7844
7844
|
Add a device to a product or move device out of quarantine.
|
|
7845
7845
|
|
|
@@ -7858,7 +7858,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7858
7858
|
|
|
7859
7859
|
### removeDevice
|
|
7860
7860
|
|
|
7861
|
-
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/
|
|
7861
|
+
[src/Particle.js:528-532](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L528-L532 "Source code on GitHub")
|
|
7862
7862
|
|
|
7863
7863
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
7864
7864
|
|
|
@@ -7876,7 +7876,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7876
7876
|
|
|
7877
7877
|
### removeDeviceOwner
|
|
7878
7878
|
|
|
7879
|
-
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/
|
|
7879
|
+
[src/Particle.js:544-547](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L544-L547 "Source code on GitHub")
|
|
7880
7880
|
|
|
7881
7881
|
Unclaim a product device its the owner, but keep it in the product
|
|
7882
7882
|
|
|
@@ -7893,7 +7893,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7893
7893
|
|
|
7894
7894
|
### renameDevice
|
|
7895
7895
|
|
|
7896
|
-
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/
|
|
7896
|
+
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L560-L562 "Source code on GitHub")
|
|
7897
7897
|
|
|
7898
7898
|
Rename a device
|
|
7899
7899
|
|
|
@@ -7911,7 +7911,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7911
7911
|
|
|
7912
7912
|
### signalDevice
|
|
7913
7913
|
|
|
7914
|
-
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/
|
|
7914
|
+
[src/Particle.js:575-577](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L575-L577 "Source code on GitHub")
|
|
7915
7915
|
|
|
7916
7916
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
7917
7917
|
|
|
@@ -7929,7 +7929,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7929
7929
|
|
|
7930
7930
|
### setDeviceNotes
|
|
7931
7931
|
|
|
7932
|
-
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/
|
|
7932
|
+
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L590-L592 "Source code on GitHub")
|
|
7933
7933
|
|
|
7934
7934
|
Store some notes about device
|
|
7935
7935
|
|
|
@@ -7947,7 +7947,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7947
7947
|
|
|
7948
7948
|
### markAsDevelopmentDevice
|
|
7949
7949
|
|
|
7950
|
-
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/
|
|
7950
|
+
[src/Particle.js:605-607](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L605-L607 "Source code on GitHub")
|
|
7951
7951
|
|
|
7952
7952
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
7953
7953
|
|
|
@@ -7965,7 +7965,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7965
7965
|
|
|
7966
7966
|
### lockDeviceProductFirmware
|
|
7967
7967
|
|
|
7968
|
-
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/
|
|
7968
|
+
[src/Particle.js:621-623](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L621-L623 "Source code on GitHub")
|
|
7969
7969
|
|
|
7970
7970
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
7971
7971
|
|
|
@@ -7984,7 +7984,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7984
7984
|
|
|
7985
7985
|
### unlockDeviceProductFirmware
|
|
7986
7986
|
|
|
7987
|
-
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/
|
|
7987
|
+
[src/Particle.js:635-637](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L635-L637 "Source code on GitHub")
|
|
7988
7988
|
|
|
7989
7989
|
Mark device as receiving automatic firmware updates
|
|
7990
7990
|
|
|
@@ -8001,7 +8001,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8001
8001
|
|
|
8002
8002
|
### updateDevice
|
|
8003
8003
|
|
|
8004
|
-
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/
|
|
8004
|
+
[src/Particle.js:656-668](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L656-L668 "Source code on GitHub")
|
|
8005
8005
|
|
|
8006
8006
|
Update multiple device attributes at the same time
|
|
8007
8007
|
|
|
@@ -8025,7 +8025,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8025
8025
|
|
|
8026
8026
|
### provisionDevice
|
|
8027
8027
|
|
|
8028
|
-
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/
|
|
8028
|
+
[src/Particle.js:679-687](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L679-L687 "Source code on GitHub")
|
|
8029
8029
|
|
|
8030
8030
|
Provision a new device for products that allow self-provisioning
|
|
8031
8031
|
|
|
@@ -8041,7 +8041,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8041
8041
|
|
|
8042
8042
|
### getClaimCode
|
|
8043
8043
|
|
|
8044
|
-
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/
|
|
8044
|
+
[src/Particle.js:701-704](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L701-L704 "Source code on GitHub")
|
|
8045
8045
|
|
|
8046
8046
|
Generate a claim code to use in the device claiming process.
|
|
8047
8047
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -8060,7 +8060,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8060
8060
|
|
|
8061
8061
|
### getVariable
|
|
8062
8062
|
|
|
8063
|
-
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/
|
|
8063
|
+
[src/Particle.js:736-742](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L736-L742 "Source code on GitHub")
|
|
8064
8064
|
|
|
8065
8065
|
Get the value of a device variable
|
|
8066
8066
|
|
|
@@ -8078,7 +8078,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8078
8078
|
|
|
8079
8079
|
### flashDevice
|
|
8080
8080
|
|
|
8081
|
-
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/
|
|
8081
|
+
[src/Particle.js:756-767](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L756-L767 "Source code on GitHub")
|
|
8082
8082
|
|
|
8083
8083
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
8084
8084
|
|
|
@@ -8097,7 +8097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8097
8097
|
|
|
8098
8098
|
### flashTinker
|
|
8099
8099
|
|
|
8100
|
-
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/
|
|
8100
|
+
[src/Particle.js:778-793](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L778-L793 "Source code on GitHub")
|
|
8101
8101
|
|
|
8102
8102
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
8103
8103
|
|
|
@@ -8113,7 +8113,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8113
8113
|
|
|
8114
8114
|
### compileCode
|
|
8115
8115
|
|
|
8116
|
-
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/
|
|
8116
|
+
[src/Particle.js:806-824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L806-L824 "Source code on GitHub")
|
|
8117
8117
|
|
|
8118
8118
|
Compile firmware using the Particle Cloud
|
|
8119
8119
|
|
|
@@ -8131,7 +8131,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8131
8131
|
|
|
8132
8132
|
### downloadFirmwareBinary
|
|
8133
8133
|
|
|
8134
|
-
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/
|
|
8134
|
+
[src/Particle.js:835-844](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L835-L844 "Source code on GitHub")
|
|
8135
8135
|
|
|
8136
8136
|
Download a firmware binary
|
|
8137
8137
|
|
|
@@ -8147,7 +8147,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8147
8147
|
|
|
8148
8148
|
### sendPublicKey
|
|
8149
8149
|
|
|
8150
|
-
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/
|
|
8150
|
+
[src/Particle.js:857-871](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L857-L871 "Source code on GitHub")
|
|
8151
8151
|
|
|
8152
8152
|
Send a new device public key to the Particle Cloud
|
|
8153
8153
|
|
|
@@ -8165,7 +8165,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8165
8165
|
|
|
8166
8166
|
### callFunction
|
|
8167
8167
|
|
|
8168
|
-
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/
|
|
8168
|
+
[src/Particle.js:885-890](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L885-L890 "Source code on GitHub")
|
|
8169
8169
|
|
|
8170
8170
|
Call a device function
|
|
8171
8171
|
|
|
@@ -8184,7 +8184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8184
8184
|
|
|
8185
8185
|
### getEventStream
|
|
8186
8186
|
|
|
8187
|
-
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/
|
|
8187
|
+
[src/Particle.js:903-928](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L903-L928 "Source code on GitHub")
|
|
8188
8188
|
|
|
8189
8189
|
Get a stream of events
|
|
8190
8190
|
|
|
@@ -8202,7 +8202,7 @@ emit 'event' events.
|
|
|
8202
8202
|
|
|
8203
8203
|
### publishEvent
|
|
8204
8204
|
|
|
8205
|
-
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/
|
|
8205
|
+
[src/Particle.js:942-946](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L942-L946 "Source code on GitHub")
|
|
8206
8206
|
|
|
8207
8207
|
Publish a event to the Particle Cloud
|
|
8208
8208
|
|
|
@@ -8221,7 +8221,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8221
8221
|
|
|
8222
8222
|
### Hook
|
|
8223
8223
|
|
|
8224
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
8224
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
8225
8225
|
|
|
8226
8226
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
8227
8227
|
|
|
@@ -8254,7 +8254,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
8254
8254
|
|
|
8255
8255
|
### createWebhook
|
|
8256
8256
|
|
|
8257
|
-
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/
|
|
8257
|
+
[src/Particle.js:977-999](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L977-L999 "Source code on GitHub")
|
|
8258
8258
|
|
|
8259
8259
|
Create a webhook
|
|
8260
8260
|
|
|
@@ -8276,7 +8276,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8276
8276
|
|
|
8277
8277
|
### deleteWebhook
|
|
8278
8278
|
|
|
8279
|
-
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/
|
|
8279
|
+
[src/Particle.js:1011-1014](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1011-L1014 "Source code on GitHub")
|
|
8280
8280
|
|
|
8281
8281
|
Delete a webhook
|
|
8282
8282
|
|
|
@@ -8293,7 +8293,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8293
8293
|
|
|
8294
8294
|
### listWebhooks
|
|
8295
8295
|
|
|
8296
|
-
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/
|
|
8296
|
+
[src/Particle.js:1025-1028](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1025-L1028 "Source code on GitHub")
|
|
8297
8297
|
|
|
8298
8298
|
List all webhooks owned by the account or product
|
|
8299
8299
|
|
|
@@ -8309,7 +8309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8309
8309
|
|
|
8310
8310
|
### createIntegration
|
|
8311
8311
|
|
|
8312
|
-
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/
|
|
8312
|
+
[src/Particle.js:1045-1049](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1045-L1049 "Source code on GitHub")
|
|
8313
8313
|
|
|
8314
8314
|
Create an integration to send events to an external service
|
|
8315
8315
|
|
|
@@ -8330,7 +8330,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8330
8330
|
|
|
8331
8331
|
### editIntegration
|
|
8332
8332
|
|
|
8333
|
-
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/
|
|
8333
|
+
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1067-L1071 "Source code on GitHub")
|
|
8334
8334
|
|
|
8335
8335
|
Edit an integration to send events to an external service
|
|
8336
8336
|
|
|
@@ -8352,7 +8352,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8352
8352
|
|
|
8353
8353
|
### deleteIntegration
|
|
8354
8354
|
|
|
8355
|
-
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/
|
|
8355
|
+
[src/Particle.js:1084-1087](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1084-L1087 "Source code on GitHub")
|
|
8356
8356
|
|
|
8357
8357
|
Delete an integration to send events to an external service
|
|
8358
8358
|
|
|
@@ -8369,7 +8369,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8369
8369
|
|
|
8370
8370
|
### listIntegrations
|
|
8371
8371
|
|
|
8372
|
-
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
8372
|
+
[src/Particle.js:1098-1101](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1098-L1101 "Source code on GitHub")
|
|
8373
8373
|
|
|
8374
8374
|
List all integrations owned by the account or product
|
|
8375
8375
|
|
|
@@ -8385,7 +8385,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8385
8385
|
|
|
8386
8386
|
### getUserInfo
|
|
8387
8387
|
|
|
8388
|
-
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/
|
|
8388
|
+
[src/Particle.js:1111-1113](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1111-L1113 "Source code on GitHub")
|
|
8389
8389
|
|
|
8390
8390
|
Get details about the current user
|
|
8391
8391
|
|
|
@@ -8400,7 +8400,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8400
8400
|
|
|
8401
8401
|
### setUserInfo
|
|
8402
8402
|
|
|
8403
|
-
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/
|
|
8403
|
+
[src/Particle.js:1124-1127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1124-L1127 "Source code on GitHub")
|
|
8404
8404
|
|
|
8405
8405
|
Set details on the current user
|
|
8406
8406
|
|
|
@@ -8416,7 +8416,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8416
8416
|
|
|
8417
8417
|
### changeUsername
|
|
8418
8418
|
|
|
8419
|
-
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/
|
|
8419
|
+
[src/Particle.js:1140-1148](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1140-L1148 "Source code on GitHub")
|
|
8420
8420
|
|
|
8421
8421
|
Change username (i.e, email)
|
|
8422
8422
|
|
|
@@ -8434,7 +8434,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8434
8434
|
|
|
8435
8435
|
### changeUserPassword
|
|
8436
8436
|
|
|
8437
|
-
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/
|
|
8437
|
+
[src/Particle.js:1161-1169](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1161-L1169 "Source code on GitHub")
|
|
8438
8438
|
|
|
8439
8439
|
Change user's password
|
|
8440
8440
|
|
|
@@ -8452,7 +8452,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8452
8452
|
|
|
8453
8453
|
### listSIMs
|
|
8454
8454
|
|
|
8455
|
-
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/
|
|
8455
|
+
[src/Particle.js:1185-1189](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1185-L1189 "Source code on GitHub")
|
|
8456
8456
|
|
|
8457
8457
|
List SIM cards owned by a user or product
|
|
8458
8458
|
|
|
@@ -8473,7 +8473,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8473
8473
|
|
|
8474
8474
|
### getSIMDataUsage
|
|
8475
8475
|
|
|
8476
|
-
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/
|
|
8476
|
+
[src/Particle.js:1201-1207](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1201-L1207 "Source code on GitHub")
|
|
8477
8477
|
|
|
8478
8478
|
Get data usage for one SIM card for the current billing period
|
|
8479
8479
|
|
|
@@ -8490,7 +8490,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8490
8490
|
|
|
8491
8491
|
### getFleetDataUsage
|
|
8492
8492
|
|
|
8493
|
-
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/
|
|
8493
|
+
[src/Particle.js:1218-1225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1218-L1225 "Source code on GitHub")
|
|
8494
8494
|
|
|
8495
8495
|
Get data usage for all SIM cards in a product the current billing period
|
|
8496
8496
|
|
|
@@ -8506,7 +8506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8506
8506
|
|
|
8507
8507
|
### checkSIM
|
|
8508
8508
|
|
|
8509
|
-
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/
|
|
8509
|
+
[src/Particle.js:1236-1238](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1236-L1238 "Source code on GitHub")
|
|
8510
8510
|
|
|
8511
8511
|
Check SIM status
|
|
8512
8512
|
|
|
@@ -8522,7 +8522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8522
8522
|
|
|
8523
8523
|
### activateSIM
|
|
8524
8524
|
|
|
8525
|
-
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/
|
|
8525
|
+
[src/Particle.js:1253-1263](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1253-L1263 "Source code on GitHub")
|
|
8526
8526
|
|
|
8527
8527
|
Activate and add SIM cards to an account or product
|
|
8528
8528
|
|
|
@@ -8542,7 +8542,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8542
8542
|
|
|
8543
8543
|
### deactivateSIM
|
|
8544
8544
|
|
|
8545
|
-
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/
|
|
8545
|
+
[src/Particle.js:1275-1279](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1275-L1279 "Source code on GitHub")
|
|
8546
8546
|
|
|
8547
8547
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
8548
8548
|
|
|
@@ -8559,7 +8559,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8559
8559
|
|
|
8560
8560
|
### reactivateSIM
|
|
8561
8561
|
|
|
8562
|
-
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/
|
|
8562
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
8563
8563
|
|
|
8564
8564
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
8565
8565
|
|
|
@@ -8577,7 +8577,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8577
8577
|
|
|
8578
8578
|
### updateSIM
|
|
8579
8579
|
|
|
8580
|
-
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/
|
|
8580
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
8581
8581
|
|
|
8582
8582
|
Update SIM card data limit
|
|
8583
8583
|
|
|
@@ -8595,7 +8595,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8595
8595
|
|
|
8596
8596
|
### removeSIM
|
|
8597
8597
|
|
|
8598
|
-
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/
|
|
8598
|
+
[src/Particle.js:1325-1328](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1325-L1328 "Source code on GitHub")
|
|
8599
8599
|
|
|
8600
8600
|
Remove a SIM card from an account so it can be activated by a different account
|
|
8601
8601
|
|
|
@@ -8612,7 +8612,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8612
8612
|
|
|
8613
8613
|
### listBuildTargets
|
|
8614
8614
|
|
|
8615
|
-
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/
|
|
8615
|
+
[src/Particle.js:1339-1342](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1339-L1342 "Source code on GitHub")
|
|
8616
8616
|
|
|
8617
8617
|
List valid build targets to be used for compiling
|
|
8618
8618
|
|
|
@@ -8628,7 +8628,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8628
8628
|
|
|
8629
8629
|
### listLibraries
|
|
8630
8630
|
|
|
8631
|
-
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/
|
|
8631
|
+
[src/Particle.js:1368-1385](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1368-L1385 "Source code on GitHub")
|
|
8632
8632
|
|
|
8633
8633
|
List firmware libraries
|
|
8634
8634
|
|
|
@@ -8658,7 +8658,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8658
8658
|
|
|
8659
8659
|
### getLibrary
|
|
8660
8660
|
|
|
8661
|
-
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/
|
|
8661
|
+
[src/Particle.js:1401-1409](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1401-L1409 "Source code on GitHub")
|
|
8662
8662
|
|
|
8663
8663
|
Get firmware library details
|
|
8664
8664
|
|
|
@@ -8675,7 +8675,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8675
8675
|
|
|
8676
8676
|
### getLibraryVersions
|
|
8677
8677
|
|
|
8678
|
-
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/
|
|
8678
|
+
[src/Particle.js:1422-1430](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1422-L1430 "Source code on GitHub")
|
|
8679
8679
|
|
|
8680
8680
|
Firmware library details for each version
|
|
8681
8681
|
|
|
@@ -8693,7 +8693,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8693
8693
|
|
|
8694
8694
|
### contributeLibrary
|
|
8695
8695
|
|
|
8696
|
-
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/
|
|
8696
|
+
[src/Particle.js:1442-1455](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1442-L1455 "Source code on GitHub")
|
|
8697
8697
|
|
|
8698
8698
|
Contribute a new library version from a compressed archive
|
|
8699
8699
|
|
|
@@ -8710,7 +8710,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8710
8710
|
|
|
8711
8711
|
### publishLibrary
|
|
8712
8712
|
|
|
8713
|
-
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/
|
|
8713
|
+
[src/Particle.js:1466-1475](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1466-L1475 "Source code on GitHub")
|
|
8714
8714
|
|
|
8715
8715
|
Publish the latest version of a library to the public
|
|
8716
8716
|
|
|
@@ -8726,7 +8726,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8726
8726
|
|
|
8727
8727
|
### deleteLibrary
|
|
8728
8728
|
|
|
8729
|
-
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
8729
|
+
[src/Particle.js:1487-1495](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1487-L1495 "Source code on GitHub")
|
|
8730
8730
|
|
|
8731
8731
|
Delete one version of a library or an entire private library
|
|
8732
8732
|
|
|
@@ -8743,7 +8743,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8743
8743
|
|
|
8744
8744
|
### downloadFile
|
|
8745
8745
|
|
|
8746
|
-
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/
|
|
8746
|
+
[src/Particle.js:1505-1507](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1505-L1507 "Source code on GitHub")
|
|
8747
8747
|
|
|
8748
8748
|
Download an external file that may not be on the API
|
|
8749
8749
|
|
|
@@ -8758,7 +8758,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8758
8758
|
|
|
8759
8759
|
### listOAuthClients
|
|
8760
8760
|
|
|
8761
|
-
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/
|
|
8761
|
+
[src/Particle.js:1518-1521](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1518-L1521 "Source code on GitHub")
|
|
8762
8762
|
|
|
8763
8763
|
List OAuth client created by the account
|
|
8764
8764
|
|
|
@@ -8774,7 +8774,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8774
8774
|
|
|
8775
8775
|
### createOAuthClient
|
|
8776
8776
|
|
|
8777
|
-
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/
|
|
8777
|
+
[src/Particle.js:1536-1540](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1536-L1540 "Source code on GitHub")
|
|
8778
8778
|
|
|
8779
8779
|
Create an OAuth client
|
|
8780
8780
|
|
|
@@ -8794,7 +8794,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8794
8794
|
|
|
8795
8795
|
### updateOAuthClient
|
|
8796
8796
|
|
|
8797
|
-
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/
|
|
8797
|
+
[src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1554-L1558 "Source code on GitHub")
|
|
8798
8798
|
|
|
8799
8799
|
Update an OAuth client
|
|
8800
8800
|
|
|
@@ -8813,7 +8813,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8813
8813
|
|
|
8814
8814
|
### deleteOAuthClient
|
|
8815
8815
|
|
|
8816
|
-
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
8816
|
+
[src/Particle.js:1570-1573](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1570-L1573 "Source code on GitHub")
|
|
8817
8817
|
|
|
8818
8818
|
Delete an OAuth client
|
|
8819
8819
|
|
|
@@ -8830,7 +8830,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8830
8830
|
|
|
8831
8831
|
### listProducts
|
|
8832
8832
|
|
|
8833
|
-
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/
|
|
8833
|
+
[src/Particle.js:1583-1585](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1583-L1585 "Source code on GitHub")
|
|
8834
8834
|
|
|
8835
8835
|
List products the account has access to
|
|
8836
8836
|
|
|
@@ -8845,7 +8845,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8845
8845
|
|
|
8846
8846
|
### getProduct
|
|
8847
8847
|
|
|
8848
|
-
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/
|
|
8848
|
+
[src/Particle.js:1596-1598](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1596-L1598 "Source code on GitHub")
|
|
8849
8849
|
|
|
8850
8850
|
Get detailed information about a product
|
|
8851
8851
|
|
|
@@ -8861,7 +8861,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8861
8861
|
|
|
8862
8862
|
### listProductFirmware
|
|
8863
8863
|
|
|
8864
|
-
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/
|
|
8864
|
+
[src/Particle.js:1609-1611](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1609-L1611 "Source code on GitHub")
|
|
8865
8865
|
|
|
8866
8866
|
List product firmware versions
|
|
8867
8867
|
|
|
@@ -8877,7 +8877,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8877
8877
|
|
|
8878
8878
|
### uploadProductFirmware
|
|
8879
8879
|
|
|
8880
|
-
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/
|
|
8880
|
+
[src/Particle.js:1627-1643](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1627-L1643 "Source code on GitHub")
|
|
8881
8881
|
|
|
8882
8882
|
List product firmware versions
|
|
8883
8883
|
|
|
@@ -8898,7 +8898,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8898
8898
|
|
|
8899
8899
|
### getProductFirmware
|
|
8900
8900
|
|
|
8901
|
-
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/
|
|
8901
|
+
[src/Particle.js:1655-1662](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1655-L1662 "Source code on GitHub")
|
|
8902
8902
|
|
|
8903
8903
|
Get information about a product firmware version
|
|
8904
8904
|
|
|
@@ -8915,7 +8915,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8915
8915
|
|
|
8916
8916
|
### updateProductFirmware
|
|
8917
8917
|
|
|
8918
|
-
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/
|
|
8918
|
+
[src/Particle.js:1676-1679](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1676-L1679 "Source code on GitHub")
|
|
8919
8919
|
|
|
8920
8920
|
Update information for a product firmware version
|
|
8921
8921
|
|
|
@@ -8934,7 +8934,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8934
8934
|
|
|
8935
8935
|
### downloadProductFirmware
|
|
8936
8936
|
|
|
8937
|
-
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/
|
|
8937
|
+
[src/Particle.js:1691-1700](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1691-L1700 "Source code on GitHub")
|
|
8938
8938
|
|
|
8939
8939
|
Download a product firmware binary
|
|
8940
8940
|
|
|
@@ -8951,7 +8951,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8951
8951
|
|
|
8952
8952
|
### releaseProductFirmware
|
|
8953
8953
|
|
|
8954
|
-
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/
|
|
8954
|
+
[src/Particle.js:1712-1715](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1712-L1715 "Source code on GitHub")
|
|
8955
8955
|
|
|
8956
8956
|
Release a product firmware version as the default version
|
|
8957
8957
|
|
|
@@ -8968,7 +8968,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8968
8968
|
|
|
8969
8969
|
### listTeamMembers
|
|
8970
8970
|
|
|
8971
|
-
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/
|
|
8971
|
+
[src/Particle.js:1726-1733](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1726-L1733 "Source code on GitHub")
|
|
8972
8972
|
|
|
8973
8973
|
List product team members
|
|
8974
8974
|
|
|
@@ -8984,7 +8984,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
8984
8984
|
|
|
8985
8985
|
### inviteTeamMember
|
|
8986
8986
|
|
|
8987
|
-
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/
|
|
8987
|
+
[src/Particle.js:1745-1753](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1745-L1753 "Source code on GitHub")
|
|
8988
8988
|
|
|
8989
8989
|
Invite Particle user to a product team
|
|
8990
8990
|
|
|
@@ -9001,7 +9001,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9001
9001
|
|
|
9002
9002
|
### removeTeamMember
|
|
9003
9003
|
|
|
9004
|
-
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/
|
|
9004
|
+
[src/Particle.js:1765-1772](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1765-L1772 "Source code on GitHub")
|
|
9005
9005
|
|
|
9006
9006
|
Remove Particle user to a product team
|
|
9007
9007
|
|
|
@@ -9018,7 +9018,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9018
9018
|
|
|
9019
9019
|
### lookupSerialNumber
|
|
9020
9020
|
|
|
9021
|
-
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/
|
|
9021
|
+
[src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1783-L1790 "Source code on GitHub")
|
|
9022
9022
|
|
|
9023
9023
|
Fetch details about a serial number
|
|
9024
9024
|
|
|
@@ -9034,7 +9034,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9034
9034
|
|
|
9035
9035
|
### createMeshNetwork
|
|
9036
9036
|
|
|
9037
|
-
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/
|
|
9037
|
+
[src/Particle.js:1803-1811](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1803-L1811 "Source code on GitHub")
|
|
9038
9038
|
|
|
9039
9039
|
Create a mesh network
|
|
9040
9040
|
|
|
@@ -9052,7 +9052,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9052
9052
|
|
|
9053
9053
|
### removeMeshNetwork
|
|
9054
9054
|
|
|
9055
|
-
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/
|
|
9055
|
+
[src/Particle.js:1822-1824](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1822-L1824 "Source code on GitHub")
|
|
9056
9056
|
|
|
9057
9057
|
Remove a mesh network.
|
|
9058
9058
|
|
|
@@ -9068,7 +9068,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9068
9068
|
|
|
9069
9069
|
### listMeshNetworks
|
|
9070
9070
|
|
|
9071
|
-
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/
|
|
9071
|
+
[src/Particle.js:1836-1839](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1836-L1839 "Source code on GitHub")
|
|
9072
9072
|
|
|
9073
9073
|
List all mesh networks
|
|
9074
9074
|
|
|
@@ -9085,7 +9085,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9085
9085
|
|
|
9086
9086
|
### getMeshNetwork
|
|
9087
9087
|
|
|
9088
|
-
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/
|
|
9088
|
+
[src/Particle.js:1850-1852](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1850-L1852 "Source code on GitHub")
|
|
9089
9089
|
|
|
9090
9090
|
Get information about a mesh network.
|
|
9091
9091
|
|
|
@@ -9101,7 +9101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9101
9101
|
|
|
9102
9102
|
### updateMeshNetwork
|
|
9103
9103
|
|
|
9104
|
-
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/
|
|
9104
|
+
[src/Particle.js:1865-1873](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1865-L1873 "Source code on GitHub")
|
|
9105
9105
|
|
|
9106
9106
|
Modify a mesh network.
|
|
9107
9107
|
|
|
@@ -9119,7 +9119,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9119
9119
|
|
|
9120
9120
|
### addMeshNetworkDevice
|
|
9121
9121
|
|
|
9122
|
-
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/
|
|
9122
|
+
[src/Particle.js:1885-1894](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1885-L1894 "Source code on GitHub")
|
|
9123
9123
|
|
|
9124
9124
|
Add a device to a mesh network.
|
|
9125
9125
|
|
|
@@ -9136,7 +9136,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9136
9136
|
|
|
9137
9137
|
### removeMeshNetworkDevice
|
|
9138
9138
|
|
|
9139
|
-
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/
|
|
9139
|
+
[src/Particle.js:1906-1922](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1906-L1922 "Source code on GitHub")
|
|
9140
9140
|
|
|
9141
9141
|
Remove a device from a mesh network.
|
|
9142
9142
|
|
|
@@ -9153,7 +9153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9153
9153
|
|
|
9154
9154
|
### listMeshNetworkDevices
|
|
9155
9155
|
|
|
9156
|
-
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/
|
|
9156
|
+
[src/Particle.js:1936-1945](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1936-L1945 "Source code on GitHub")
|
|
9157
9157
|
|
|
9158
9158
|
List all devices of a mesh network.
|
|
9159
9159
|
|
|
@@ -9172,7 +9172,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9172
9172
|
|
|
9173
9173
|
### getProductConfiguration
|
|
9174
9174
|
|
|
9175
|
-
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/
|
|
9175
|
+
[src/Particle.js:1956-1963](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1956-L1963 "Source code on GitHub")
|
|
9176
9176
|
|
|
9177
9177
|
Get product configuration
|
|
9178
9178
|
|
|
@@ -9188,7 +9188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9188
9188
|
|
|
9189
9189
|
### getProductConfigurationSchema
|
|
9190
9190
|
|
|
9191
|
-
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/
|
|
9191
|
+
[src/Particle.js:1974-1982](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1974-L1982 "Source code on GitHub")
|
|
9192
9192
|
|
|
9193
9193
|
Get product configuration schema
|
|
9194
9194
|
|
|
@@ -9204,7 +9204,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9204
9204
|
|
|
9205
9205
|
### getProductDeviceConfiguration
|
|
9206
9206
|
|
|
9207
|
-
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/
|
|
9207
|
+
[src/Particle.js:1994-2001](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L1994-L2001 "Source code on GitHub")
|
|
9208
9208
|
|
|
9209
9209
|
Get product device's configuration
|
|
9210
9210
|
|
|
@@ -9221,7 +9221,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9221
9221
|
|
|
9222
9222
|
### getProductDeviceConfigurationSchema
|
|
9223
9223
|
|
|
9224
|
-
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/
|
|
9224
|
+
[src/Particle.js:2013-2021](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2013-L2021 "Source code on GitHub")
|
|
9225
9225
|
|
|
9226
9226
|
Get product device's configuration schema
|
|
9227
9227
|
|
|
@@ -9238,7 +9238,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9238
9238
|
|
|
9239
9239
|
### setProductConfiguration
|
|
9240
9240
|
|
|
9241
|
-
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/
|
|
9241
|
+
[src/Particle.js:2033-2041](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2033-L2041 "Source code on GitHub")
|
|
9242
9242
|
|
|
9243
9243
|
Set product configuration
|
|
9244
9244
|
|
|
@@ -9255,7 +9255,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9255
9255
|
|
|
9256
9256
|
### setProductDeviceConfiguration
|
|
9257
9257
|
|
|
9258
|
-
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/
|
|
9258
|
+
[src/Particle.js:2054-2062](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2054-L2062 "Source code on GitHub")
|
|
9259
9259
|
|
|
9260
9260
|
Set product configuration for a specific device within the product
|
|
9261
9261
|
|
|
@@ -9273,7 +9273,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9273
9273
|
|
|
9274
9274
|
### getProductLocations
|
|
9275
9275
|
|
|
9276
|
-
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/
|
|
9276
|
+
[src/Particle.js:2081-2098](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2081-L2098 "Source code on GitHub")
|
|
9277
9277
|
|
|
9278
9278
|
Query location for devices within a product
|
|
9279
9279
|
|
|
@@ -9297,7 +9297,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9297
9297
|
|
|
9298
9298
|
### getProductDeviceLocations
|
|
9299
9299
|
|
|
9300
|
-
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/
|
|
9300
|
+
[src/Particle.js:2115-2127](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2115-L2127 "Source code on GitHub")
|
|
9301
9301
|
|
|
9302
9302
|
Query location for one device within a product
|
|
9303
9303
|
|
|
@@ -9317,7 +9317,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9317
9317
|
|
|
9318
9318
|
### executeLogic
|
|
9319
9319
|
|
|
9320
|
-
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/
|
|
9320
|
+
[src/Particle.js:2143-2151](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2143-L2151 "Source code on GitHub")
|
|
9321
9321
|
|
|
9322
9322
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
9323
9323
|
|
|
@@ -9336,7 +9336,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9336
9336
|
|
|
9337
9337
|
### createLogicFunction
|
|
9338
9338
|
|
|
9339
|
-
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/
|
|
9339
|
+
[src/Particle.js:2171-2179](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2171-L2179 "Source code on GitHub")
|
|
9340
9340
|
|
|
9341
9341
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
9342
9342
|
|
|
@@ -9359,7 +9359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9359
9359
|
|
|
9360
9360
|
### getLogicFunction
|
|
9361
9361
|
|
|
9362
|
-
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/
|
|
9362
|
+
[src/Particle.js:2193-2200](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2193-L2200 "Source code on GitHub")
|
|
9363
9363
|
|
|
9364
9364
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
9365
9365
|
|
|
@@ -9376,7 +9376,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9376
9376
|
|
|
9377
9377
|
### updateLogicFunction
|
|
9378
9378
|
|
|
9379
|
-
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/
|
|
9379
|
+
[src/Particle.js:2217-2225](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2217-L2225 "Source code on GitHub")
|
|
9380
9380
|
|
|
9381
9381
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
9382
9382
|
|
|
@@ -9396,7 +9396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9396
9396
|
|
|
9397
9397
|
### deleteLogicFunction
|
|
9398
9398
|
|
|
9399
|
-
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/
|
|
9399
|
+
[src/Particle.js:2239-2246](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2239-L2246 "Source code on GitHub")
|
|
9400
9400
|
|
|
9401
9401
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
9402
9402
|
|
|
@@ -9413,7 +9413,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9413
9413
|
|
|
9414
9414
|
### listLogicFunctions
|
|
9415
9415
|
|
|
9416
|
-
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/
|
|
9416
|
+
[src/Particle.js:2260-2270](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2260-L2270 "Source code on GitHub")
|
|
9417
9417
|
|
|
9418
9418
|
Lists all logic functions in the specified organization or sandbox.
|
|
9419
9419
|
|
|
@@ -9430,7 +9430,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9430
9430
|
|
|
9431
9431
|
### listLogicRuns
|
|
9432
9432
|
|
|
9433
|
-
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/
|
|
9433
|
+
[src/Particle.js:2284-2291](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2284-L2291 "Source code on GitHub")
|
|
9434
9434
|
|
|
9435
9435
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
9436
9436
|
|
|
@@ -9447,7 +9447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9447
9447
|
|
|
9448
9448
|
### getLogicRun
|
|
9449
9449
|
|
|
9450
|
-
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/
|
|
9450
|
+
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2306-L2313 "Source code on GitHub")
|
|
9451
9451
|
|
|
9452
9452
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
9453
9453
|
|
|
@@ -9465,7 +9465,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9465
9465
|
|
|
9466
9466
|
### getLogicRunLogs
|
|
9467
9467
|
|
|
9468
|
-
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/
|
|
9468
|
+
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2328-L2335 "Source code on GitHub")
|
|
9469
9469
|
|
|
9470
9470
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
9471
9471
|
|
|
@@ -9483,7 +9483,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9483
9483
|
|
|
9484
9484
|
### createLedger
|
|
9485
9485
|
|
|
9486
|
-
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/
|
|
9486
|
+
[src/Particle.js:2349-2357](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2349-L2357 "Source code on GitHub")
|
|
9487
9487
|
|
|
9488
9488
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
9489
9489
|
|
|
@@ -9500,7 +9500,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9500
9500
|
|
|
9501
9501
|
### getLedger
|
|
9502
9502
|
|
|
9503
|
-
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/
|
|
9503
|
+
[src/Particle.js:2371-2378](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2371-L2378 "Source code on GitHub")
|
|
9504
9504
|
|
|
9505
9505
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
9506
9506
|
|
|
@@ -9517,7 +9517,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9517
9517
|
|
|
9518
9518
|
### updateLedger
|
|
9519
9519
|
|
|
9520
|
-
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/
|
|
9520
|
+
[src/Particle.js:2393-2401](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2393-L2401 "Source code on GitHub")
|
|
9521
9521
|
|
|
9522
9522
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
9523
9523
|
|
|
@@ -9535,7 +9535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9535
9535
|
|
|
9536
9536
|
### archiveLedger
|
|
9537
9537
|
|
|
9538
|
-
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/
|
|
9538
|
+
[src/Particle.js:2415-2422](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2415-L2422 "Source code on GitHub")
|
|
9539
9539
|
|
|
9540
9540
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
9541
9541
|
|
|
@@ -9552,7 +9552,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9552
9552
|
|
|
9553
9553
|
### Scope
|
|
9554
9554
|
|
|
9555
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
9555
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
9556
9556
|
|
|
9557
9557
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
9558
9558
|
|
|
@@ -9570,7 +9570,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
9570
9570
|
|
|
9571
9571
|
### listLedgers
|
|
9572
9572
|
|
|
9573
|
-
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/
|
|
9573
|
+
[src/Particle.js:2443-2456](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2443-L2456 "Source code on GitHub")
|
|
9574
9574
|
|
|
9575
9575
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
9576
9576
|
|
|
@@ -9590,7 +9590,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9590
9590
|
|
|
9591
9591
|
### getLedgerInstance
|
|
9592
9592
|
|
|
9593
|
-
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
9593
|
+
[src/Particle.js:2471-2478](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2471-L2478 "Source code on GitHub")
|
|
9594
9594
|
|
|
9595
9595
|
Get ledger instance data.
|
|
9596
9596
|
|
|
@@ -9608,7 +9608,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9608
9608
|
|
|
9609
9609
|
### setLedgerInstance
|
|
9610
9610
|
|
|
9611
|
-
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/
|
|
9611
|
+
[src/Particle.js:2494-2502](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2494-L2502 "Source code on GitHub")
|
|
9612
9612
|
|
|
9613
9613
|
Set ledger instance data.
|
|
9614
9614
|
|
|
@@ -9619,7 +9619,7 @@ Set ledger instance data.
|
|
|
9619
9619
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
9620
9620
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
9621
9621
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
9622
|
-
- `options.
|
|
9622
|
+
- `options.instance` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The instance with the data
|
|
9623
9623
|
- `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.
|
|
9624
9624
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
9625
9625
|
|
|
@@ -9627,7 +9627,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9627
9627
|
|
|
9628
9628
|
### deleteLedgerInstance
|
|
9629
9629
|
|
|
9630
|
-
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/
|
|
9630
|
+
[src/Particle.js:2517-2524](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2517-L2524 "Source code on GitHub")
|
|
9631
9631
|
|
|
9632
9632
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
9633
9633
|
|
|
@@ -9645,7 +9645,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9645
9645
|
|
|
9646
9646
|
### listLedgerInstances
|
|
9647
9647
|
|
|
9648
|
-
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/
|
|
9648
|
+
[src/Particle.js:2540-2551](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2540-L2551 "Source code on GitHub")
|
|
9649
9649
|
|
|
9650
9650
|
Lists ledger instances in the specified organization or sandbox.
|
|
9651
9651
|
|
|
@@ -9664,7 +9664,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9664
9664
|
|
|
9665
9665
|
### listLedgerInstanceVersions
|
|
9666
9666
|
|
|
9667
|
-
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/
|
|
9667
|
+
[src/Particle.js:2568-2579](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2568-L2579 "Source code on GitHub")
|
|
9668
9668
|
|
|
9669
9669
|
List ledger instance versions
|
|
9670
9670
|
|
|
@@ -9684,7 +9684,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9684
9684
|
|
|
9685
9685
|
### getLedgerInstanceVersion
|
|
9686
9686
|
|
|
9687
|
-
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/
|
|
9687
|
+
[src/Particle.js:2595-2602](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2595-L2602 "Source code on GitHub")
|
|
9688
9688
|
|
|
9689
9689
|
Get specific ledger instance version
|
|
9690
9690
|
|
|
@@ -9703,7 +9703,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9703
9703
|
|
|
9704
9704
|
### setDefaultAuth
|
|
9705
9705
|
|
|
9706
|
-
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/
|
|
9706
|
+
[src/Particle.js:2609-2617](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2609-L2617 "Source code on GitHub")
|
|
9707
9707
|
|
|
9708
9708
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
9709
9709
|
|
|
@@ -9716,7 +9716,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
9716
9716
|
|
|
9717
9717
|
### get
|
|
9718
9718
|
|
|
9719
|
-
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/
|
|
9719
|
+
[src/Particle.js:2660-2664](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2660-L2664 "Source code on GitHub")
|
|
9720
9720
|
|
|
9721
9721
|
Make a GET request
|
|
9722
9722
|
|
|
@@ -9733,7 +9733,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9733
9733
|
|
|
9734
9734
|
### head
|
|
9735
9735
|
|
|
9736
|
-
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/
|
|
9736
|
+
[src/Particle.js:2676-2680](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2676-L2680 "Source code on GitHub")
|
|
9737
9737
|
|
|
9738
9738
|
Make a HEAD request
|
|
9739
9739
|
|
|
@@ -9750,7 +9750,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9750
9750
|
|
|
9751
9751
|
### post
|
|
9752
9752
|
|
|
9753
|
-
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/
|
|
9753
|
+
[src/Particle.js:2692-2696](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2692-L2696 "Source code on GitHub")
|
|
9754
9754
|
|
|
9755
9755
|
Make a POST request
|
|
9756
9756
|
|
|
@@ -9767,7 +9767,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9767
9767
|
|
|
9768
9768
|
### put
|
|
9769
9769
|
|
|
9770
|
-
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/
|
|
9770
|
+
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2708-L2712 "Source code on GitHub")
|
|
9771
9771
|
|
|
9772
9772
|
Make a PUT request
|
|
9773
9773
|
|
|
@@ -9784,7 +9784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9784
9784
|
|
|
9785
9785
|
### delete
|
|
9786
9786
|
|
|
9787
|
-
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/
|
|
9787
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
9788
9788
|
|
|
9789
9789
|
Make a DELETE request
|
|
9790
9790
|
|
|
@@ -9801,7 +9801,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
9801
9801
|
|
|
9802
9802
|
### request
|
|
9803
9803
|
|
|
9804
|
-
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/
|
|
9804
|
+
[src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/23cdac89fae13fb4cf308097cfbf5d02d2ebf06e/src/Particle.js#L2745-L2749 "Source code on GitHub")
|
|
9805
9805
|
|
|
9806
9806
|
**Parameters**
|
|
9807
9807
|
|