particle-api-js 10.2.0 → 10.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +534 -474
- package/package.json +1 -1
- package/src/Particle.js +84 -49
- package/test/Particle.spec.js +37 -0
package/docs/api.md
CHANGED
|
@@ -104,6 +104,7 @@
|
|
|
104
104
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration)
|
|
105
105
|
- [getProductLocations](#getproductlocations)
|
|
106
106
|
- [getProductDeviceLocations](#getproductdevicelocations)
|
|
107
|
+
- [executeLogic](#executelogic)
|
|
107
108
|
- [createLogicFunction](#createlogicfunction)
|
|
108
109
|
- [getLogicFunction](#getlogicfunction)
|
|
109
110
|
- [updateLogicFunction](#updatelogicfunction)
|
|
@@ -230,6 +231,7 @@
|
|
|
230
231
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration-1)
|
|
231
232
|
- [getProductLocations](#getproductlocations-1)
|
|
232
233
|
- [getProductDeviceLocations](#getproductdevicelocations-1)
|
|
234
|
+
- [executeLogic](#executelogic-1)
|
|
233
235
|
- [createLogicFunction](#createlogicfunction-1)
|
|
234
236
|
- [getLogicFunction](#getlogicfunction-1)
|
|
235
237
|
- [updateLogicFunction](#updatelogicfunction-1)
|
|
@@ -356,6 +358,7 @@
|
|
|
356
358
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration-2)
|
|
357
359
|
- [getProductLocations](#getproductlocations-2)
|
|
358
360
|
- [getProductDeviceLocations](#getproductdevicelocations-2)
|
|
361
|
+
- [executeLogic](#executelogic-2)
|
|
359
362
|
- [createLogicFunction](#createlogicfunction-2)
|
|
360
363
|
- [getLogicFunction](#getlogicfunction-2)
|
|
361
364
|
- [updateLogicFunction](#updatelogicfunction-2)
|
|
@@ -383,7 +386,7 @@
|
|
|
383
386
|
|
|
384
387
|
## Particle
|
|
385
388
|
|
|
386
|
-
[src/Particle.js:23-
|
|
389
|
+
[src/Particle.js:23-2674](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L23-L2674 "Source code on GitHub")
|
|
387
390
|
|
|
388
391
|
**Parameters**
|
|
389
392
|
|
|
@@ -391,7 +394,7 @@
|
|
|
391
394
|
|
|
392
395
|
### constructor
|
|
393
396
|
|
|
394
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
397
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
395
398
|
|
|
396
399
|
Contructor for the Cloud API wrapper.
|
|
397
400
|
|
|
@@ -403,7 +406,7 @@ Create a new Particle object and call methods below on it.
|
|
|
403
406
|
|
|
404
407
|
### login
|
|
405
408
|
|
|
406
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
409
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
407
410
|
|
|
408
411
|
Login to Particle Cloud using an existing Particle acccount.
|
|
409
412
|
|
|
@@ -420,7 +423,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
420
423
|
|
|
421
424
|
### sendOtp
|
|
422
425
|
|
|
423
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
426
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
424
427
|
|
|
425
428
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
426
429
|
|
|
@@ -436,7 +439,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
436
439
|
|
|
437
440
|
### enableMfa
|
|
438
441
|
|
|
439
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
442
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
440
443
|
|
|
441
444
|
Enable MFA on the currently logged in user
|
|
442
445
|
|
|
@@ -451,7 +454,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
451
454
|
|
|
452
455
|
### confirmMfa
|
|
453
456
|
|
|
454
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
457
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
455
458
|
|
|
456
459
|
Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
|
|
457
460
|
|
|
@@ -469,7 +472,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
469
472
|
|
|
470
473
|
### disableMfa
|
|
471
474
|
|
|
472
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
475
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
473
476
|
|
|
474
477
|
Disable MFA for the user.
|
|
475
478
|
|
|
@@ -485,7 +488,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
485
488
|
|
|
486
489
|
### createCustomer
|
|
487
490
|
|
|
488
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
491
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
489
492
|
|
|
490
493
|
Create Customer for Product.
|
|
491
494
|
|
|
@@ -502,7 +505,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
502
505
|
|
|
503
506
|
### loginAsClientOwner
|
|
504
507
|
|
|
505
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
508
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
506
509
|
|
|
507
510
|
Login to Particle Cloud using an OAuth client.
|
|
508
511
|
|
|
@@ -516,7 +519,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
516
519
|
|
|
517
520
|
### createUser
|
|
518
521
|
|
|
519
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
522
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
520
523
|
|
|
521
524
|
Create a user account for the Particle Cloud
|
|
522
525
|
|
|
@@ -533,7 +536,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
533
536
|
|
|
534
537
|
### verifyUser
|
|
535
538
|
|
|
536
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
539
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
537
540
|
|
|
538
541
|
Verify new user account via verification email
|
|
539
542
|
|
|
@@ -548,7 +551,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
548
551
|
|
|
549
552
|
### resetPassword
|
|
550
553
|
|
|
551
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
554
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
552
555
|
|
|
553
556
|
Send reset password email for a Particle Cloud user account
|
|
554
557
|
|
|
@@ -563,7 +566,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
563
566
|
|
|
564
567
|
### deleteAccessToken
|
|
565
568
|
|
|
566
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
569
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
567
570
|
|
|
568
571
|
Revoke an access token
|
|
569
572
|
|
|
@@ -580,7 +583,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
580
583
|
|
|
581
584
|
### deleteCurrentAccessToken
|
|
582
585
|
|
|
583
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
586
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
584
587
|
|
|
585
588
|
Revoke the current session access token
|
|
586
589
|
|
|
@@ -595,7 +598,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
595
598
|
|
|
596
599
|
### deleteActiveAccessTokens
|
|
597
600
|
|
|
598
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
601
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
599
602
|
|
|
600
603
|
Revoke all active access tokens
|
|
601
604
|
|
|
@@ -610,7 +613,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
610
613
|
|
|
611
614
|
### deleteUser
|
|
612
615
|
|
|
613
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
616
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
614
617
|
|
|
615
618
|
Delete the current user
|
|
616
619
|
|
|
@@ -626,7 +629,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
626
629
|
|
|
627
630
|
### listAccessTokens
|
|
628
631
|
|
|
629
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
632
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
630
633
|
|
|
631
634
|
List all valid access tokens for a Particle Cloud account
|
|
632
635
|
|
|
@@ -643,7 +646,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
643
646
|
|
|
644
647
|
### trackingIdentity
|
|
645
648
|
|
|
646
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
649
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
647
650
|
|
|
648
651
|
Retrieves the information that is used to identify the current login for tracking.
|
|
649
652
|
|
|
@@ -660,7 +663,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
660
663
|
|
|
661
664
|
### listDevices
|
|
662
665
|
|
|
663
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
666
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
664
667
|
|
|
665
668
|
List devices claimed to the account or product
|
|
666
669
|
|
|
@@ -683,7 +686,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
683
686
|
|
|
684
687
|
### getDevice
|
|
685
688
|
|
|
686
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
689
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
687
690
|
|
|
688
691
|
Get detailed informationa about a device
|
|
689
692
|
|
|
@@ -700,7 +703,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
700
703
|
|
|
701
704
|
### claimDevice
|
|
702
705
|
|
|
703
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
706
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
704
707
|
|
|
705
708
|
Claim a device to the account. The device must be online and unclaimed.
|
|
706
709
|
|
|
@@ -717,7 +720,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
717
720
|
|
|
718
721
|
### addDeviceToProduct
|
|
719
722
|
|
|
720
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
723
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
721
724
|
|
|
722
725
|
Add a device to a product or move device out of quarantine.
|
|
723
726
|
|
|
@@ -736,7 +739,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
736
739
|
|
|
737
740
|
### removeDevice
|
|
738
741
|
|
|
739
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
742
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
740
743
|
|
|
741
744
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
742
745
|
|
|
@@ -754,7 +757,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
754
757
|
|
|
755
758
|
### removeDeviceOwner
|
|
756
759
|
|
|
757
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
760
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
758
761
|
|
|
759
762
|
Unclaim a product device its the owner, but keep it in the product
|
|
760
763
|
|
|
@@ -771,7 +774,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
771
774
|
|
|
772
775
|
### renameDevice
|
|
773
776
|
|
|
774
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
777
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
775
778
|
|
|
776
779
|
Rename a device
|
|
777
780
|
|
|
@@ -789,7 +792,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
789
792
|
|
|
790
793
|
### signalDevice
|
|
791
794
|
|
|
792
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
795
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
793
796
|
|
|
794
797
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
795
798
|
|
|
@@ -807,7 +810,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
807
810
|
|
|
808
811
|
### setDeviceNotes
|
|
809
812
|
|
|
810
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
813
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
811
814
|
|
|
812
815
|
Store some notes about device
|
|
813
816
|
|
|
@@ -825,7 +828,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
825
828
|
|
|
826
829
|
### markAsDevelopmentDevice
|
|
827
830
|
|
|
828
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
831
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
829
832
|
|
|
830
833
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
831
834
|
|
|
@@ -843,7 +846,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
843
846
|
|
|
844
847
|
### lockDeviceProductFirmware
|
|
845
848
|
|
|
846
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
849
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
847
850
|
|
|
848
851
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
849
852
|
|
|
@@ -862,7 +865,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
862
865
|
|
|
863
866
|
### unlockDeviceProductFirmware
|
|
864
867
|
|
|
865
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
868
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
866
869
|
|
|
867
870
|
Mark device as receiving automatic firmware updates
|
|
868
871
|
|
|
@@ -879,7 +882,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
879
882
|
|
|
880
883
|
### updateDevice
|
|
881
884
|
|
|
882
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
885
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
883
886
|
|
|
884
887
|
Update multiple device attributes at the same time
|
|
885
888
|
|
|
@@ -903,7 +906,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
903
906
|
|
|
904
907
|
### provisionDevice
|
|
905
908
|
|
|
906
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
909
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
907
910
|
|
|
908
911
|
Provision a new device for products that allow self-provisioning
|
|
909
912
|
|
|
@@ -919,7 +922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
919
922
|
|
|
920
923
|
### getClaimCode
|
|
921
924
|
|
|
922
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
925
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
923
926
|
|
|
924
927
|
Generate a claim code to use in the device claiming process.
|
|
925
928
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -938,7 +941,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
938
941
|
|
|
939
942
|
### getVariable
|
|
940
943
|
|
|
941
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
944
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
942
945
|
|
|
943
946
|
Get the value of a device variable
|
|
944
947
|
|
|
@@ -956,7 +959,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
956
959
|
|
|
957
960
|
### flashDevice
|
|
958
961
|
|
|
959
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
962
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
960
963
|
|
|
961
964
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
962
965
|
|
|
@@ -975,7 +978,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
975
978
|
|
|
976
979
|
### flashTinker
|
|
977
980
|
|
|
978
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
981
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
979
982
|
|
|
980
983
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
981
984
|
|
|
@@ -991,7 +994,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
991
994
|
|
|
992
995
|
### compileCode
|
|
993
996
|
|
|
994
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
997
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
995
998
|
|
|
996
999
|
Compile firmware using the Particle Cloud
|
|
997
1000
|
|
|
@@ -1009,7 +1012,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1009
1012
|
|
|
1010
1013
|
### downloadFirmwareBinary
|
|
1011
1014
|
|
|
1012
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
1015
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
1013
1016
|
|
|
1014
1017
|
Download a firmware binary
|
|
1015
1018
|
|
|
@@ -1025,7 +1028,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1025
1028
|
|
|
1026
1029
|
### sendPublicKey
|
|
1027
1030
|
|
|
1028
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
1031
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
1029
1032
|
|
|
1030
1033
|
Send a new device public key to the Particle Cloud
|
|
1031
1034
|
|
|
@@ -1043,7 +1046,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1043
1046
|
|
|
1044
1047
|
### callFunction
|
|
1045
1048
|
|
|
1046
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
1049
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
1047
1050
|
|
|
1048
1051
|
Call a device function
|
|
1049
1052
|
|
|
@@ -1062,7 +1065,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1062
1065
|
|
|
1063
1066
|
### getEventStream
|
|
1064
1067
|
|
|
1065
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
1068
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
1066
1069
|
|
|
1067
1070
|
Get a stream of events
|
|
1068
1071
|
|
|
@@ -1080,7 +1083,7 @@ emit 'event' events.
|
|
|
1080
1083
|
|
|
1081
1084
|
### publishEvent
|
|
1082
1085
|
|
|
1083
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
1086
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
1084
1087
|
|
|
1085
1088
|
Publish a event to the Particle Cloud
|
|
1086
1089
|
|
|
@@ -1099,7 +1102,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1099
1102
|
|
|
1100
1103
|
### createWebhook
|
|
1101
1104
|
|
|
1102
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
1105
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
1103
1106
|
|
|
1104
1107
|
Create a webhook
|
|
1105
1108
|
|
|
@@ -1131,7 +1134,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1131
1134
|
|
|
1132
1135
|
### deleteWebhook
|
|
1133
1136
|
|
|
1134
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
1137
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
1135
1138
|
|
|
1136
1139
|
Delete a webhook
|
|
1137
1140
|
|
|
@@ -1148,7 +1151,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1148
1151
|
|
|
1149
1152
|
### listWebhooks
|
|
1150
1153
|
|
|
1151
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
1154
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
1152
1155
|
|
|
1153
1156
|
List all webhooks owned by the account or product
|
|
1154
1157
|
|
|
@@ -1164,7 +1167,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1164
1167
|
|
|
1165
1168
|
### createIntegration
|
|
1166
1169
|
|
|
1167
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
1170
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
1168
1171
|
|
|
1169
1172
|
Create an integration to send events to an external service
|
|
1170
1173
|
|
|
@@ -1185,7 +1188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1185
1188
|
|
|
1186
1189
|
### editIntegration
|
|
1187
1190
|
|
|
1188
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
1191
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
1189
1192
|
|
|
1190
1193
|
Edit an integration to send events to an external service
|
|
1191
1194
|
|
|
@@ -1207,7 +1210,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1207
1210
|
|
|
1208
1211
|
### deleteIntegration
|
|
1209
1212
|
|
|
1210
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
1213
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
1211
1214
|
|
|
1212
1215
|
Delete an integration to send events to an external service
|
|
1213
1216
|
|
|
@@ -1224,7 +1227,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1224
1227
|
|
|
1225
1228
|
### listIntegrations
|
|
1226
1229
|
|
|
1227
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
1230
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
1228
1231
|
|
|
1229
1232
|
List all integrations owned by the account or product
|
|
1230
1233
|
|
|
@@ -1240,7 +1243,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1240
1243
|
|
|
1241
1244
|
### getUserInfo
|
|
1242
1245
|
|
|
1243
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
1246
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
1244
1247
|
|
|
1245
1248
|
Get details about the current user
|
|
1246
1249
|
|
|
@@ -1255,7 +1258,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1255
1258
|
|
|
1256
1259
|
### setUserInfo
|
|
1257
1260
|
|
|
1258
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
1261
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
1259
1262
|
|
|
1260
1263
|
Set details on the current user
|
|
1261
1264
|
|
|
@@ -1271,7 +1274,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1271
1274
|
|
|
1272
1275
|
### changeUsername
|
|
1273
1276
|
|
|
1274
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
1277
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
1275
1278
|
|
|
1276
1279
|
Change username (i.e, email)
|
|
1277
1280
|
|
|
@@ -1289,7 +1292,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1289
1292
|
|
|
1290
1293
|
### changeUserPassword
|
|
1291
1294
|
|
|
1292
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
1295
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
1293
1296
|
|
|
1294
1297
|
Change user's password
|
|
1295
1298
|
|
|
@@ -1307,7 +1310,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1307
1310
|
|
|
1308
1311
|
### listSIMs
|
|
1309
1312
|
|
|
1310
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
1313
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
1311
1314
|
|
|
1312
1315
|
List SIM cards owned by a user or product
|
|
1313
1316
|
|
|
@@ -1328,7 +1331,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1328
1331
|
|
|
1329
1332
|
### getSIMDataUsage
|
|
1330
1333
|
|
|
1331
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
1334
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
1332
1335
|
|
|
1333
1336
|
Get data usage for one SIM card for the current billing period
|
|
1334
1337
|
|
|
@@ -1345,7 +1348,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1345
1348
|
|
|
1346
1349
|
### getFleetDataUsage
|
|
1347
1350
|
|
|
1348
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
1351
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
1349
1352
|
|
|
1350
1353
|
Get data usage for all SIM cards in a product the current billing period
|
|
1351
1354
|
|
|
@@ -1361,7 +1364,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1361
1364
|
|
|
1362
1365
|
### checkSIM
|
|
1363
1366
|
|
|
1364
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
1367
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
1365
1368
|
|
|
1366
1369
|
Check SIM status
|
|
1367
1370
|
|
|
@@ -1377,7 +1380,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1377
1380
|
|
|
1378
1381
|
### activateSIM
|
|
1379
1382
|
|
|
1380
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
1383
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
1381
1384
|
|
|
1382
1385
|
Activate and add SIM cards to an account or product
|
|
1383
1386
|
|
|
@@ -1397,7 +1400,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1397
1400
|
|
|
1398
1401
|
### deactivateSIM
|
|
1399
1402
|
|
|
1400
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
1403
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
1401
1404
|
|
|
1402
1405
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1403
1406
|
|
|
@@ -1414,7 +1417,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1414
1417
|
|
|
1415
1418
|
### reactivateSIM
|
|
1416
1419
|
|
|
1417
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
1420
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
1418
1421
|
|
|
1419
1422
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1420
1423
|
|
|
@@ -1432,7 +1435,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1432
1435
|
|
|
1433
1436
|
### updateSIM
|
|
1434
1437
|
|
|
1435
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
1438
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
1436
1439
|
|
|
1437
1440
|
Update SIM card data limit
|
|
1438
1441
|
|
|
@@ -1450,7 +1453,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1450
1453
|
|
|
1451
1454
|
### removeSIM
|
|
1452
1455
|
|
|
1453
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
1456
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
1454
1457
|
|
|
1455
1458
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1456
1459
|
|
|
@@ -1467,7 +1470,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1467
1470
|
|
|
1468
1471
|
### listBuildTargets
|
|
1469
1472
|
|
|
1470
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
1473
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
1471
1474
|
|
|
1472
1475
|
List valid build targets to be used for compiling
|
|
1473
1476
|
|
|
@@ -1483,7 +1486,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1483
1486
|
|
|
1484
1487
|
### listLibraries
|
|
1485
1488
|
|
|
1486
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
1489
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
1487
1490
|
|
|
1488
1491
|
List firmware libraries
|
|
1489
1492
|
|
|
@@ -1512,7 +1515,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1512
1515
|
|
|
1513
1516
|
### getLibrary
|
|
1514
1517
|
|
|
1515
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
1518
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
1516
1519
|
|
|
1517
1520
|
Get firmware library details
|
|
1518
1521
|
|
|
@@ -1529,7 +1532,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1529
1532
|
|
|
1530
1533
|
### getLibraryVersions
|
|
1531
1534
|
|
|
1532
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
1535
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
1533
1536
|
|
|
1534
1537
|
Firmware library details for each version
|
|
1535
1538
|
|
|
@@ -1547,7 +1550,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1547
1550
|
|
|
1548
1551
|
### contributeLibrary
|
|
1549
1552
|
|
|
1550
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
1553
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
1551
1554
|
|
|
1552
1555
|
Contribute a new library version from a compressed archive
|
|
1553
1556
|
|
|
@@ -1564,7 +1567,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1564
1567
|
|
|
1565
1568
|
### publishLibrary
|
|
1566
1569
|
|
|
1567
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
1570
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
1568
1571
|
|
|
1569
1572
|
Publish the latest version of a library to the public
|
|
1570
1573
|
|
|
@@ -1580,7 +1583,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1580
1583
|
|
|
1581
1584
|
### deleteLibrary
|
|
1582
1585
|
|
|
1583
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
1586
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
1584
1587
|
|
|
1585
1588
|
Delete one version of a library or an entire private library
|
|
1586
1589
|
|
|
@@ -1597,7 +1600,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1597
1600
|
|
|
1598
1601
|
### downloadFile
|
|
1599
1602
|
|
|
1600
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
1603
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
1601
1604
|
|
|
1602
1605
|
Download an external file that may not be on the API
|
|
1603
1606
|
|
|
@@ -1612,7 +1615,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1612
1615
|
|
|
1613
1616
|
### listOAuthClients
|
|
1614
1617
|
|
|
1615
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
1618
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
1616
1619
|
|
|
1617
1620
|
List OAuth client created by the account
|
|
1618
1621
|
|
|
@@ -1628,7 +1631,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1628
1631
|
|
|
1629
1632
|
### createOAuthClient
|
|
1630
1633
|
|
|
1631
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
1634
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
1632
1635
|
|
|
1633
1636
|
Create an OAuth client
|
|
1634
1637
|
|
|
@@ -1648,7 +1651,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1648
1651
|
|
|
1649
1652
|
### updateOAuthClient
|
|
1650
1653
|
|
|
1651
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
1654
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
1652
1655
|
|
|
1653
1656
|
Update an OAuth client
|
|
1654
1657
|
|
|
@@ -1667,7 +1670,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1667
1670
|
|
|
1668
1671
|
### deleteOAuthClient
|
|
1669
1672
|
|
|
1670
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
1673
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
1671
1674
|
|
|
1672
1675
|
Delete an OAuth client
|
|
1673
1676
|
|
|
@@ -1684,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1684
1687
|
|
|
1685
1688
|
### listProducts
|
|
1686
1689
|
|
|
1687
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
1690
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
1688
1691
|
|
|
1689
1692
|
List products the account has access to
|
|
1690
1693
|
|
|
@@ -1699,7 +1702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1699
1702
|
|
|
1700
1703
|
### getProduct
|
|
1701
1704
|
|
|
1702
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
1705
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
1703
1706
|
|
|
1704
1707
|
Get detailed information about a product
|
|
1705
1708
|
|
|
@@ -1715,7 +1718,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1715
1718
|
|
|
1716
1719
|
### listProductFirmware
|
|
1717
1720
|
|
|
1718
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
1721
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
1719
1722
|
|
|
1720
1723
|
List product firmware versions
|
|
1721
1724
|
|
|
@@ -1731,7 +1734,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1731
1734
|
|
|
1732
1735
|
### uploadProductFirmware
|
|
1733
1736
|
|
|
1734
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
1737
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
1735
1738
|
|
|
1736
1739
|
List product firmware versions
|
|
1737
1740
|
|
|
@@ -1752,7 +1755,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1752
1755
|
|
|
1753
1756
|
### getProductFirmware
|
|
1754
1757
|
|
|
1755
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
1758
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
1756
1759
|
|
|
1757
1760
|
Get information about a product firmware version
|
|
1758
1761
|
|
|
@@ -1769,7 +1772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1769
1772
|
|
|
1770
1773
|
### updateProductFirmware
|
|
1771
1774
|
|
|
1772
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
1775
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
1773
1776
|
|
|
1774
1777
|
Update information for a product firmware version
|
|
1775
1778
|
|
|
@@ -1788,7 +1791,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1788
1791
|
|
|
1789
1792
|
### downloadProductFirmware
|
|
1790
1793
|
|
|
1791
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
1794
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
1792
1795
|
|
|
1793
1796
|
Download a product firmware binary
|
|
1794
1797
|
|
|
@@ -1805,7 +1808,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1805
1808
|
|
|
1806
1809
|
### releaseProductFirmware
|
|
1807
1810
|
|
|
1808
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
1811
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
1809
1812
|
|
|
1810
1813
|
Release a product firmware version as the default version
|
|
1811
1814
|
|
|
@@ -1822,7 +1825,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1822
1825
|
|
|
1823
1826
|
### listTeamMembers
|
|
1824
1827
|
|
|
1825
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
1828
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
1826
1829
|
|
|
1827
1830
|
List product team members
|
|
1828
1831
|
|
|
@@ -1838,7 +1841,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1838
1841
|
|
|
1839
1842
|
### inviteTeamMember
|
|
1840
1843
|
|
|
1841
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
1844
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
1842
1845
|
|
|
1843
1846
|
Invite Particle user to a product team
|
|
1844
1847
|
|
|
@@ -1855,7 +1858,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1855
1858
|
|
|
1856
1859
|
### removeTeamMember
|
|
1857
1860
|
|
|
1858
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
1861
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
1859
1862
|
|
|
1860
1863
|
Remove Particle user to a product team
|
|
1861
1864
|
|
|
@@ -1872,7 +1875,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1872
1875
|
|
|
1873
1876
|
### lookupSerialNumber
|
|
1874
1877
|
|
|
1875
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
1878
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
1876
1879
|
|
|
1877
1880
|
Fetch details about a serial number
|
|
1878
1881
|
|
|
@@ -1888,7 +1891,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1888
1891
|
|
|
1889
1892
|
### createMeshNetwork
|
|
1890
1893
|
|
|
1891
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
1894
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
1892
1895
|
|
|
1893
1896
|
Create a mesh network
|
|
1894
1897
|
|
|
@@ -1906,7 +1909,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1906
1909
|
|
|
1907
1910
|
### removeMeshNetwork
|
|
1908
1911
|
|
|
1909
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
1912
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
1910
1913
|
|
|
1911
1914
|
Remove a mesh network.
|
|
1912
1915
|
|
|
@@ -1922,7 +1925,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1922
1925
|
|
|
1923
1926
|
### listMeshNetworks
|
|
1924
1927
|
|
|
1925
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
1928
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
1926
1929
|
|
|
1927
1930
|
List all mesh networks
|
|
1928
1931
|
|
|
@@ -1939,7 +1942,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1939
1942
|
|
|
1940
1943
|
### getMeshNetwork
|
|
1941
1944
|
|
|
1942
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
1945
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
1943
1946
|
|
|
1944
1947
|
Get information about a mesh network.
|
|
1945
1948
|
|
|
@@ -1955,7 +1958,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1955
1958
|
|
|
1956
1959
|
### updateMeshNetwork
|
|
1957
1960
|
|
|
1958
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
1961
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
1959
1962
|
|
|
1960
1963
|
Modify a mesh network.
|
|
1961
1964
|
|
|
@@ -1973,7 +1976,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1973
1976
|
|
|
1974
1977
|
### addMeshNetworkDevice
|
|
1975
1978
|
|
|
1976
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
1979
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
1977
1980
|
|
|
1978
1981
|
Add a device to a mesh network.
|
|
1979
1982
|
|
|
@@ -1990,7 +1993,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1990
1993
|
|
|
1991
1994
|
### removeMeshNetworkDevice
|
|
1992
1995
|
|
|
1993
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
1996
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
1994
1997
|
|
|
1995
1998
|
Remove a device from a mesh network.
|
|
1996
1999
|
|
|
@@ -2007,7 +2010,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2007
2010
|
|
|
2008
2011
|
### listMeshNetworkDevices
|
|
2009
2012
|
|
|
2010
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
2013
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
2011
2014
|
|
|
2012
2015
|
List all devices of a mesh network.
|
|
2013
2016
|
|
|
@@ -2026,7 +2029,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2026
2029
|
|
|
2027
2030
|
### getProductConfiguration
|
|
2028
2031
|
|
|
2029
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
2032
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
2030
2033
|
|
|
2031
2034
|
Get product configuration
|
|
2032
2035
|
|
|
@@ -2042,7 +2045,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2042
2045
|
|
|
2043
2046
|
### getProductConfigurationSchema
|
|
2044
2047
|
|
|
2045
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
2048
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
2046
2049
|
|
|
2047
2050
|
Get product configuration schema
|
|
2048
2051
|
|
|
@@ -2058,7 +2061,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2058
2061
|
|
|
2059
2062
|
### getProductDeviceConfiguration
|
|
2060
2063
|
|
|
2061
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
2064
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
2062
2065
|
|
|
2063
2066
|
Get product device's configuration
|
|
2064
2067
|
|
|
@@ -2075,7 +2078,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2075
2078
|
|
|
2076
2079
|
### getProductDeviceConfigurationSchema
|
|
2077
2080
|
|
|
2078
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
2081
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
2079
2082
|
|
|
2080
2083
|
Get product device's configuration schema
|
|
2081
2084
|
|
|
@@ -2092,7 +2095,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2092
2095
|
|
|
2093
2096
|
### setProductConfiguration
|
|
2094
2097
|
|
|
2095
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
2098
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
2096
2099
|
|
|
2097
2100
|
Set product configuration
|
|
2098
2101
|
|
|
@@ -2109,7 +2112,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2109
2112
|
|
|
2110
2113
|
### setProductDeviceConfiguration
|
|
2111
2114
|
|
|
2112
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
2115
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
2113
2116
|
|
|
2114
2117
|
Set product configuration for a specific device within the product
|
|
2115
2118
|
|
|
@@ -2127,7 +2130,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2127
2130
|
|
|
2128
2131
|
### getProductLocations
|
|
2129
2132
|
|
|
2130
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
2133
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
2131
2134
|
|
|
2132
2135
|
Query location for devices within a product
|
|
2133
2136
|
|
|
@@ -2151,7 +2154,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2151
2154
|
|
|
2152
2155
|
### getProductDeviceLocations
|
|
2153
2156
|
|
|
2154
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
2157
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
2155
2158
|
|
|
2156
2159
|
Query location for one device within a product
|
|
2157
2160
|
|
|
@@ -2169,11 +2172,30 @@ Query location for one device within a product
|
|
|
2169
2172
|
|
|
2170
2173
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
2171
2174
|
|
|
2175
|
+
### executeLogic
|
|
2176
|
+
|
|
2177
|
+
[src/Particle.js:2131-2139](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2131-L2139 "Source code on GitHub")
|
|
2178
|
+
|
|
2179
|
+
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
2180
|
+
|
|
2181
|
+
NOTE: Any external interactions such as Particle.publish will actually occur when the logic is executed.
|
|
2182
|
+
|
|
2183
|
+
**Parameters**
|
|
2184
|
+
|
|
2185
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2186
|
+
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2187
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2188
|
+
- `options.logic` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic "function" which will be executed once
|
|
2189
|
+
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2190
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2191
|
+
|
|
2192
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
2193
|
+
|
|
2172
2194
|
### createLogicFunction
|
|
2173
2195
|
|
|
2174
|
-
[src/Particle.js:
|
|
2196
|
+
[src/Particle.js:2159-2167](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2159-L2167 "Source code on GitHub")
|
|
2175
2197
|
|
|
2176
|
-
Creates a new logic function in the specified organization using the provided function data.
|
|
2198
|
+
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2177
2199
|
|
|
2178
2200
|
When you create a logic function with Event logic triggers, events will immediately
|
|
2179
2201
|
start being handled by the function code.
|
|
@@ -2185,7 +2207,7 @@ according to the cron and start_at properties.
|
|
|
2185
2207
|
|
|
2186
2208
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2187
2209
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2188
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2210
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2189
2211
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
2190
2212
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2191
2213
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -2194,15 +2216,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2194
2216
|
|
|
2195
2217
|
### getLogicFunction
|
|
2196
2218
|
|
|
2197
|
-
[src/Particle.js:
|
|
2219
|
+
[src/Particle.js:2181-2188](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2181-L2188 "Source code on GitHub")
|
|
2198
2220
|
|
|
2199
|
-
Get a logic function in the specified organization by logic function ID.
|
|
2221
|
+
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2200
2222
|
|
|
2201
2223
|
**Parameters**
|
|
2202
2224
|
|
|
2203
2225
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
2204
2226
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2205
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2227
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2206
2228
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
2207
2229
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2208
2230
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -2211,9 +2233,9 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2211
2233
|
|
|
2212
2234
|
### updateLogicFunction
|
|
2213
2235
|
|
|
2214
|
-
[src/Particle.js:
|
|
2236
|
+
[src/Particle.js:2205-2213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2205-L2213 "Source code on GitHub")
|
|
2215
2237
|
|
|
2216
|
-
Updates an existing logic function in the specified organization using the provided function data.
|
|
2238
|
+
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2217
2239
|
|
|
2218
2240
|
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
2219
2241
|
|
|
@@ -2221,7 +2243,7 @@ If you include an id on a logic trigger, it will update the logic trigger in pla
|
|
|
2221
2243
|
|
|
2222
2244
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
2223
2245
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2224
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2246
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2225
2247
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
2226
2248
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
2227
2249
|
- `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.
|
|
@@ -2231,15 +2253,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2231
2253
|
|
|
2232
2254
|
### deleteLogicFunction
|
|
2233
2255
|
|
|
2234
|
-
[src/Particle.js:
|
|
2256
|
+
[src/Particle.js:2227-2234](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2227-L2234 "Source code on GitHub")
|
|
2235
2257
|
|
|
2236
|
-
Deletes a logic function in the specified organization by logic function ID.
|
|
2258
|
+
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2237
2259
|
|
|
2238
2260
|
**Parameters**
|
|
2239
2261
|
|
|
2240
2262
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
2241
2263
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2242
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2264
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2243
2265
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
2244
2266
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2245
2267
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -2248,15 +2270,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2248
2270
|
|
|
2249
2271
|
### listLogicFunctions
|
|
2250
2272
|
|
|
2251
|
-
[src/Particle.js:
|
|
2273
|
+
[src/Particle.js:2247-2254](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2247-L2254 "Source code on GitHub")
|
|
2252
2274
|
|
|
2253
|
-
Lists all logic functions in the specified organization.
|
|
2275
|
+
Lists all logic functions in the specified organization or sandbox.
|
|
2254
2276
|
|
|
2255
2277
|
**Parameters**
|
|
2256
2278
|
|
|
2257
2279
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
2258
2280
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2259
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2281
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2260
2282
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2261
2283
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2262
2284
|
|
|
@@ -2264,15 +2286,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2264
2286
|
|
|
2265
2287
|
### listLogicRuns
|
|
2266
2288
|
|
|
2267
|
-
[src/Particle.js:
|
|
2289
|
+
[src/Particle.js:2268-2275](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2268-L2275 "Source code on GitHub")
|
|
2268
2290
|
|
|
2269
|
-
Lists all logic runs for the specified logic function.
|
|
2291
|
+
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2270
2292
|
|
|
2271
2293
|
**Parameters**
|
|
2272
2294
|
|
|
2273
2295
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2274
2296
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2275
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2297
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2276
2298
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
2277
2299
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2278
2300
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -2281,15 +2303,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2281
2303
|
|
|
2282
2304
|
### getLogicRun
|
|
2283
2305
|
|
|
2284
|
-
[src/Particle.js:
|
|
2306
|
+
[src/Particle.js:2290-2297](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2290-L2297 "Source code on GitHub")
|
|
2285
2307
|
|
|
2286
|
-
Retrieves a logic run by its ID for the specified logic function.
|
|
2308
|
+
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2287
2309
|
|
|
2288
2310
|
**Parameters**
|
|
2289
2311
|
|
|
2290
2312
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2291
2313
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2292
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2314
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2293
2315
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
2294
2316
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
2295
2317
|
- `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.
|
|
@@ -2299,15 +2321,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2299
2321
|
|
|
2300
2322
|
### getLogicRunLogs
|
|
2301
2323
|
|
|
2302
|
-
[src/Particle.js:
|
|
2324
|
+
[src/Particle.js:2312-2319](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2312-L2319 "Source code on GitHub")
|
|
2303
2325
|
|
|
2304
|
-
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
2326
|
+
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2305
2327
|
|
|
2306
2328
|
**Parameters**
|
|
2307
2329
|
|
|
2308
2330
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2309
2331
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2310
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2332
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The unique identifier of the organization.
|
|
2311
2333
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
2312
2334
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
2313
2335
|
- `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.
|
|
@@ -2317,15 +2339,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2317
2339
|
|
|
2318
2340
|
### createLedger
|
|
2319
2341
|
|
|
2320
|
-
[src/Particle.js:
|
|
2342
|
+
[src/Particle.js:2334-2342](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2334-L2342 "Source code on GitHub")
|
|
2321
2343
|
|
|
2322
|
-
Creates a new ledger definition in the specified organization.
|
|
2344
|
+
Creates a new ledger definition in the specified organization or sandbox.
|
|
2323
2345
|
|
|
2324
2346
|
**Parameters**
|
|
2325
2347
|
|
|
2326
2348
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
|
|
2327
2349
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2328
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2350
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2329
2351
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
2330
2352
|
- `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.
|
|
2331
2353
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -2335,15 +2357,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2335
2357
|
|
|
2336
2358
|
### getLedger
|
|
2337
2359
|
|
|
2338
|
-
[src/Particle.js:
|
|
2360
|
+
[src/Particle.js:2356-2363](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2356-L2363 "Source code on GitHub")
|
|
2339
2361
|
|
|
2340
|
-
Get a ledger definition in the specified organization by ledger name.
|
|
2362
|
+
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2341
2363
|
|
|
2342
2364
|
**Parameters**
|
|
2343
2365
|
|
|
2344
2366
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
|
|
2345
2367
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2346
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2368
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2347
2369
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
|
|
2348
2370
|
- `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.
|
|
2349
2371
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -2352,15 +2374,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2352
2374
|
|
|
2353
2375
|
### updateLedger
|
|
2354
2376
|
|
|
2355
|
-
[src/Particle.js:
|
|
2377
|
+
[src/Particle.js:2378-2386](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2378-L2386 "Source code on GitHub")
|
|
2356
2378
|
|
|
2357
|
-
Updates an existing ledger definition in the specified organization.
|
|
2379
|
+
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2358
2380
|
|
|
2359
2381
|
**Parameters**
|
|
2360
2382
|
|
|
2361
2383
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
|
|
2362
2384
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2363
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2385
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2364
2386
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
|
|
2365
2387
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
2366
2388
|
- `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.
|
|
@@ -2370,15 +2392,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2370
2392
|
|
|
2371
2393
|
### archiveLedger
|
|
2372
2394
|
|
|
2373
|
-
[src/Particle.js:
|
|
2395
|
+
[src/Particle.js:2400-2407](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2400-L2407 "Source code on GitHub")
|
|
2374
2396
|
|
|
2375
|
-
Archives a ledger definition in the specified organization by ledger name.
|
|
2397
|
+
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2376
2398
|
|
|
2377
2399
|
**Parameters**
|
|
2378
2400
|
|
|
2379
2401
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
|
|
2380
2402
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2381
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2403
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2382
2404
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
|
|
2383
2405
|
- `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.
|
|
2384
2406
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -2387,15 +2409,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2387
2409
|
|
|
2388
2410
|
### listLedgers
|
|
2389
2411
|
|
|
2390
|
-
[src/Particle.js:
|
|
2412
|
+
[src/Particle.js:2420-2427](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2420-L2427 "Source code on GitHub")
|
|
2391
2413
|
|
|
2392
|
-
Lists all ledger definitions in the specified organization.
|
|
2414
|
+
Lists all ledger definitions in the specified organization or sandbox.
|
|
2393
2415
|
|
|
2394
2416
|
**Parameters**
|
|
2395
2417
|
|
|
2396
2418
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
|
|
2397
2419
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2398
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2420
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2399
2421
|
- `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.
|
|
2400
2422
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2401
2423
|
|
|
@@ -2403,7 +2425,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2403
2425
|
|
|
2404
2426
|
### getLedgerInstance
|
|
2405
2427
|
|
|
2406
|
-
[src/Particle.js:
|
|
2428
|
+
[src/Particle.js:2442-2449](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2442-L2449 "Source code on GitHub")
|
|
2407
2429
|
|
|
2408
2430
|
Get ledger instance data.
|
|
2409
2431
|
|
|
@@ -2411,7 +2433,7 @@ Get ledger instance data.
|
|
|
2411
2433
|
|
|
2412
2434
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2413
2435
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2414
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2436
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2415
2437
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2416
2438
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
2417
2439
|
- `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.
|
|
@@ -2421,7 +2443,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2421
2443
|
|
|
2422
2444
|
### setLedgerInstance
|
|
2423
2445
|
|
|
2424
|
-
[src/Particle.js:
|
|
2446
|
+
[src/Particle.js:2466-2474](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2466-L2474 "Source code on GitHub")
|
|
2425
2447
|
|
|
2426
2448
|
Set ledger instance data.
|
|
2427
2449
|
|
|
@@ -2429,7 +2451,7 @@ Set ledger instance data.
|
|
|
2429
2451
|
|
|
2430
2452
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
|
|
2431
2453
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2432
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2454
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2433
2455
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2434
2456
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
2435
2457
|
- `options.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The data to set to the instance
|
|
@@ -2441,15 +2463,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2441
2463
|
|
|
2442
2464
|
### deleteLedgerInstance
|
|
2443
2465
|
|
|
2444
|
-
[src/Particle.js:
|
|
2466
|
+
[src/Particle.js:2489-2496](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2489-L2496 "Source code on GitHub")
|
|
2445
2467
|
|
|
2446
|
-
Delete a ledger instance in the specified organization by ledger name.
|
|
2468
|
+
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2447
2469
|
|
|
2448
2470
|
**Parameters**
|
|
2449
2471
|
|
|
2450
2472
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
|
|
2451
2473
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2452
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
2474
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2453
2475
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2454
2476
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
2455
2477
|
- `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.
|
|
@@ -2459,15 +2481,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2459
2481
|
|
|
2460
2482
|
### listLedgerInstances
|
|
2461
2483
|
|
|
2462
|
-
[src/Particle.js:
|
|
2484
|
+
[src/Particle.js:2510-2517](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2510-L2517 "Source code on GitHub")
|
|
2463
2485
|
|
|
2464
|
-
Lists ledger instances.
|
|
2486
|
+
Lists ledger instances in the specified organization or sandbox.
|
|
2465
2487
|
|
|
2466
2488
|
**Parameters**
|
|
2467
2489
|
|
|
2468
2490
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
|
|
2469
2491
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2470
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
2492
|
+
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
2471
2493
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2472
2494
|
- `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.
|
|
2473
2495
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -2476,7 +2498,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2476
2498
|
|
|
2477
2499
|
### setDefaultAuth
|
|
2478
2500
|
|
|
2479
|
-
[src/Particle.js:
|
|
2501
|
+
[src/Particle.js:2524-2530](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2524-L2530 "Source code on GitHub")
|
|
2480
2502
|
|
|
2481
2503
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2482
2504
|
|
|
@@ -2489,7 +2511,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2489
2511
|
|
|
2490
2512
|
### get
|
|
2491
2513
|
|
|
2492
|
-
[src/Particle.js:
|
|
2514
|
+
[src/Particle.js:2573-2577](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2573-L2577 "Source code on GitHub")
|
|
2493
2515
|
|
|
2494
2516
|
Make a GET request
|
|
2495
2517
|
|
|
@@ -2506,7 +2528,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2506
2528
|
|
|
2507
2529
|
### head
|
|
2508
2530
|
|
|
2509
|
-
[src/Particle.js:
|
|
2531
|
+
[src/Particle.js:2589-2593](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2589-L2593 "Source code on GitHub")
|
|
2510
2532
|
|
|
2511
2533
|
Make a HEAD request
|
|
2512
2534
|
|
|
@@ -2523,7 +2545,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2523
2545
|
|
|
2524
2546
|
### post
|
|
2525
2547
|
|
|
2526
|
-
[src/Particle.js:
|
|
2548
|
+
[src/Particle.js:2605-2609](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2605-L2609 "Source code on GitHub")
|
|
2527
2549
|
|
|
2528
2550
|
Make a POST request
|
|
2529
2551
|
|
|
@@ -2540,7 +2562,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2540
2562
|
|
|
2541
2563
|
### put
|
|
2542
2564
|
|
|
2543
|
-
[src/Particle.js:
|
|
2565
|
+
[src/Particle.js:2621-2625](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2621-L2625 "Source code on GitHub")
|
|
2544
2566
|
|
|
2545
2567
|
Make a PUT request
|
|
2546
2568
|
|
|
@@ -2557,7 +2579,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2557
2579
|
|
|
2558
2580
|
### delete
|
|
2559
2581
|
|
|
2560
|
-
[src/Particle.js:
|
|
2582
|
+
[src/Particle.js:2637-2641](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2637-L2641 "Source code on GitHub")
|
|
2561
2583
|
|
|
2562
2584
|
Make a DELETE request
|
|
2563
2585
|
|
|
@@ -2574,7 +2596,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2574
2596
|
|
|
2575
2597
|
### request
|
|
2576
2598
|
|
|
2577
|
-
[src/Particle.js:
|
|
2599
|
+
[src/Particle.js:2658-2662](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2658-L2662 "Source code on GitHub")
|
|
2578
2600
|
|
|
2579
2601
|
**Parameters**
|
|
2580
2602
|
|
|
@@ -2594,7 +2616,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2594
2616
|
|
|
2595
2617
|
## Particle
|
|
2596
2618
|
|
|
2597
|
-
[src/Particle.js:23-
|
|
2619
|
+
[src/Particle.js:23-2674](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L23-L2674 "Source code on GitHub")
|
|
2598
2620
|
|
|
2599
2621
|
**Parameters**
|
|
2600
2622
|
|
|
@@ -2602,7 +2624,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2602
2624
|
|
|
2603
2625
|
### constructor
|
|
2604
2626
|
|
|
2605
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
2627
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
2606
2628
|
|
|
2607
2629
|
Contructor for the Cloud API wrapper.
|
|
2608
2630
|
|
|
@@ -2614,7 +2636,7 @@ Create a new Particle object and call methods below on it.
|
|
|
2614
2636
|
|
|
2615
2637
|
### login
|
|
2616
2638
|
|
|
2617
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
2639
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
2618
2640
|
|
|
2619
2641
|
Login to Particle Cloud using an existing Particle acccount.
|
|
2620
2642
|
|
|
@@ -2631,7 +2653,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2631
2653
|
|
|
2632
2654
|
### sendOtp
|
|
2633
2655
|
|
|
2634
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
2656
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
2635
2657
|
|
|
2636
2658
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
2637
2659
|
|
|
@@ -2647,7 +2669,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2647
2669
|
|
|
2648
2670
|
### enableMfa
|
|
2649
2671
|
|
|
2650
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
2672
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
2651
2673
|
|
|
2652
2674
|
Enable MFA on the currently logged in user
|
|
2653
2675
|
|
|
@@ -2662,7 +2684,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2662
2684
|
|
|
2663
2685
|
### confirmMfa
|
|
2664
2686
|
|
|
2665
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
2687
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
2666
2688
|
|
|
2667
2689
|
Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
|
|
2668
2690
|
|
|
@@ -2680,7 +2702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2680
2702
|
|
|
2681
2703
|
### disableMfa
|
|
2682
2704
|
|
|
2683
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
2705
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
2684
2706
|
|
|
2685
2707
|
Disable MFA for the user.
|
|
2686
2708
|
|
|
@@ -2696,7 +2718,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2696
2718
|
|
|
2697
2719
|
### createCustomer
|
|
2698
2720
|
|
|
2699
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
2721
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
2700
2722
|
|
|
2701
2723
|
Create Customer for Product.
|
|
2702
2724
|
|
|
@@ -2713,7 +2735,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2713
2735
|
|
|
2714
2736
|
### loginAsClientOwner
|
|
2715
2737
|
|
|
2716
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
2738
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
2717
2739
|
|
|
2718
2740
|
Login to Particle Cloud using an OAuth client.
|
|
2719
2741
|
|
|
@@ -2727,7 +2749,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2727
2749
|
|
|
2728
2750
|
### createUser
|
|
2729
2751
|
|
|
2730
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
2752
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
2731
2753
|
|
|
2732
2754
|
Create a user account for the Particle Cloud
|
|
2733
2755
|
|
|
@@ -2744,7 +2766,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2744
2766
|
|
|
2745
2767
|
### verifyUser
|
|
2746
2768
|
|
|
2747
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
2769
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
2748
2770
|
|
|
2749
2771
|
Verify new user account via verification email
|
|
2750
2772
|
|
|
@@ -2759,7 +2781,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2759
2781
|
|
|
2760
2782
|
### resetPassword
|
|
2761
2783
|
|
|
2762
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
2784
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
2763
2785
|
|
|
2764
2786
|
Send reset password email for a Particle Cloud user account
|
|
2765
2787
|
|
|
@@ -2774,7 +2796,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2774
2796
|
|
|
2775
2797
|
### deleteAccessToken
|
|
2776
2798
|
|
|
2777
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
2799
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
2778
2800
|
|
|
2779
2801
|
Revoke an access token
|
|
2780
2802
|
|
|
@@ -2791,7 +2813,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2791
2813
|
|
|
2792
2814
|
### deleteCurrentAccessToken
|
|
2793
2815
|
|
|
2794
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
2816
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
2795
2817
|
|
|
2796
2818
|
Revoke the current session access token
|
|
2797
2819
|
|
|
@@ -2806,7 +2828,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2806
2828
|
|
|
2807
2829
|
### deleteActiveAccessTokens
|
|
2808
2830
|
|
|
2809
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
2831
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
2810
2832
|
|
|
2811
2833
|
Revoke all active access tokens
|
|
2812
2834
|
|
|
@@ -2821,7 +2843,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2821
2843
|
|
|
2822
2844
|
### deleteUser
|
|
2823
2845
|
|
|
2824
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
2846
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
2825
2847
|
|
|
2826
2848
|
Delete the current user
|
|
2827
2849
|
|
|
@@ -2837,7 +2859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2837
2859
|
|
|
2838
2860
|
### listAccessTokens
|
|
2839
2861
|
|
|
2840
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
2862
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
2841
2863
|
|
|
2842
2864
|
List all valid access tokens for a Particle Cloud account
|
|
2843
2865
|
|
|
@@ -2854,7 +2876,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2854
2876
|
|
|
2855
2877
|
### trackingIdentity
|
|
2856
2878
|
|
|
2857
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
2879
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
2858
2880
|
|
|
2859
2881
|
Retrieves the information that is used to identify the current login for tracking.
|
|
2860
2882
|
|
|
@@ -2871,7 +2893,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2871
2893
|
|
|
2872
2894
|
### listDevices
|
|
2873
2895
|
|
|
2874
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
2896
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
2875
2897
|
|
|
2876
2898
|
List devices claimed to the account or product
|
|
2877
2899
|
|
|
@@ -2894,7 +2916,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2894
2916
|
|
|
2895
2917
|
### getDevice
|
|
2896
2918
|
|
|
2897
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
2919
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
2898
2920
|
|
|
2899
2921
|
Get detailed informationa about a device
|
|
2900
2922
|
|
|
@@ -2911,7 +2933,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2911
2933
|
|
|
2912
2934
|
### claimDevice
|
|
2913
2935
|
|
|
2914
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
2936
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
2915
2937
|
|
|
2916
2938
|
Claim a device to the account. The device must be online and unclaimed.
|
|
2917
2939
|
|
|
@@ -2928,7 +2950,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2928
2950
|
|
|
2929
2951
|
### addDeviceToProduct
|
|
2930
2952
|
|
|
2931
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
2953
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
2932
2954
|
|
|
2933
2955
|
Add a device to a product or move device out of quarantine.
|
|
2934
2956
|
|
|
@@ -2947,7 +2969,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2947
2969
|
|
|
2948
2970
|
### removeDevice
|
|
2949
2971
|
|
|
2950
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
2972
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
2951
2973
|
|
|
2952
2974
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
2953
2975
|
|
|
@@ -2965,7 +2987,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2965
2987
|
|
|
2966
2988
|
### removeDeviceOwner
|
|
2967
2989
|
|
|
2968
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
2990
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
2969
2991
|
|
|
2970
2992
|
Unclaim a product device its the owner, but keep it in the product
|
|
2971
2993
|
|
|
@@ -2982,7 +3004,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2982
3004
|
|
|
2983
3005
|
### renameDevice
|
|
2984
3006
|
|
|
2985
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
3007
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
2986
3008
|
|
|
2987
3009
|
Rename a device
|
|
2988
3010
|
|
|
@@ -3000,7 +3022,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3000
3022
|
|
|
3001
3023
|
### signalDevice
|
|
3002
3024
|
|
|
3003
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
3025
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
3004
3026
|
|
|
3005
3027
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
3006
3028
|
|
|
@@ -3018,7 +3040,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3018
3040
|
|
|
3019
3041
|
### setDeviceNotes
|
|
3020
3042
|
|
|
3021
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
3043
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
3022
3044
|
|
|
3023
3045
|
Store some notes about device
|
|
3024
3046
|
|
|
@@ -3036,7 +3058,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3036
3058
|
|
|
3037
3059
|
### markAsDevelopmentDevice
|
|
3038
3060
|
|
|
3039
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
3061
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
3040
3062
|
|
|
3041
3063
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
3042
3064
|
|
|
@@ -3054,7 +3076,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3054
3076
|
|
|
3055
3077
|
### lockDeviceProductFirmware
|
|
3056
3078
|
|
|
3057
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
3079
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
3058
3080
|
|
|
3059
3081
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
3060
3082
|
|
|
@@ -3073,7 +3095,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3073
3095
|
|
|
3074
3096
|
### unlockDeviceProductFirmware
|
|
3075
3097
|
|
|
3076
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
3098
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
3077
3099
|
|
|
3078
3100
|
Mark device as receiving automatic firmware updates
|
|
3079
3101
|
|
|
@@ -3090,7 +3112,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3090
3112
|
|
|
3091
3113
|
### updateDevice
|
|
3092
3114
|
|
|
3093
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
3115
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
3094
3116
|
|
|
3095
3117
|
Update multiple device attributes at the same time
|
|
3096
3118
|
|
|
@@ -3114,7 +3136,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3114
3136
|
|
|
3115
3137
|
### provisionDevice
|
|
3116
3138
|
|
|
3117
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
3139
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
3118
3140
|
|
|
3119
3141
|
Provision a new device for products that allow self-provisioning
|
|
3120
3142
|
|
|
@@ -3130,7 +3152,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3130
3152
|
|
|
3131
3153
|
### getClaimCode
|
|
3132
3154
|
|
|
3133
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
3155
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
3134
3156
|
|
|
3135
3157
|
Generate a claim code to use in the device claiming process.
|
|
3136
3158
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -3149,7 +3171,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3149
3171
|
|
|
3150
3172
|
### getVariable
|
|
3151
3173
|
|
|
3152
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
3174
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
3153
3175
|
|
|
3154
3176
|
Get the value of a device variable
|
|
3155
3177
|
|
|
@@ -3167,7 +3189,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3167
3189
|
|
|
3168
3190
|
### flashDevice
|
|
3169
3191
|
|
|
3170
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
3192
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
3171
3193
|
|
|
3172
3194
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
3173
3195
|
|
|
@@ -3186,7 +3208,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3186
3208
|
|
|
3187
3209
|
### flashTinker
|
|
3188
3210
|
|
|
3189
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
3211
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
3190
3212
|
|
|
3191
3213
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
3192
3214
|
|
|
@@ -3202,7 +3224,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3202
3224
|
|
|
3203
3225
|
### compileCode
|
|
3204
3226
|
|
|
3205
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
3227
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
3206
3228
|
|
|
3207
3229
|
Compile firmware using the Particle Cloud
|
|
3208
3230
|
|
|
@@ -3220,7 +3242,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3220
3242
|
|
|
3221
3243
|
### downloadFirmwareBinary
|
|
3222
3244
|
|
|
3223
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
3245
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
3224
3246
|
|
|
3225
3247
|
Download a firmware binary
|
|
3226
3248
|
|
|
@@ -3236,7 +3258,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3236
3258
|
|
|
3237
3259
|
### sendPublicKey
|
|
3238
3260
|
|
|
3239
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
3261
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
3240
3262
|
|
|
3241
3263
|
Send a new device public key to the Particle Cloud
|
|
3242
3264
|
|
|
@@ -3254,7 +3276,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3254
3276
|
|
|
3255
3277
|
### callFunction
|
|
3256
3278
|
|
|
3257
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
3279
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
3258
3280
|
|
|
3259
3281
|
Call a device function
|
|
3260
3282
|
|
|
@@ -3273,7 +3295,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3273
3295
|
|
|
3274
3296
|
### getEventStream
|
|
3275
3297
|
|
|
3276
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
3298
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
3277
3299
|
|
|
3278
3300
|
Get a stream of events
|
|
3279
3301
|
|
|
@@ -3291,7 +3313,7 @@ emit 'event' events.
|
|
|
3291
3313
|
|
|
3292
3314
|
### publishEvent
|
|
3293
3315
|
|
|
3294
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
3316
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
3295
3317
|
|
|
3296
3318
|
Publish a event to the Particle Cloud
|
|
3297
3319
|
|
|
@@ -3310,7 +3332,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3310
3332
|
|
|
3311
3333
|
### createWebhook
|
|
3312
3334
|
|
|
3313
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
3335
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
3314
3336
|
|
|
3315
3337
|
Create a webhook
|
|
3316
3338
|
|
|
@@ -3342,7 +3364,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3342
3364
|
|
|
3343
3365
|
### deleteWebhook
|
|
3344
3366
|
|
|
3345
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
3367
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
3346
3368
|
|
|
3347
3369
|
Delete a webhook
|
|
3348
3370
|
|
|
@@ -3359,7 +3381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3359
3381
|
|
|
3360
3382
|
### listWebhooks
|
|
3361
3383
|
|
|
3362
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
3384
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
3363
3385
|
|
|
3364
3386
|
List all webhooks owned by the account or product
|
|
3365
3387
|
|
|
@@ -3375,7 +3397,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3375
3397
|
|
|
3376
3398
|
### createIntegration
|
|
3377
3399
|
|
|
3378
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
3400
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
3379
3401
|
|
|
3380
3402
|
Create an integration to send events to an external service
|
|
3381
3403
|
|
|
@@ -3396,7 +3418,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3396
3418
|
|
|
3397
3419
|
### editIntegration
|
|
3398
3420
|
|
|
3399
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
3421
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
3400
3422
|
|
|
3401
3423
|
Edit an integration to send events to an external service
|
|
3402
3424
|
|
|
@@ -3418,7 +3440,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3418
3440
|
|
|
3419
3441
|
### deleteIntegration
|
|
3420
3442
|
|
|
3421
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
3443
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
3422
3444
|
|
|
3423
3445
|
Delete an integration to send events to an external service
|
|
3424
3446
|
|
|
@@ -3435,7 +3457,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3435
3457
|
|
|
3436
3458
|
### listIntegrations
|
|
3437
3459
|
|
|
3438
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
3460
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
3439
3461
|
|
|
3440
3462
|
List all integrations owned by the account or product
|
|
3441
3463
|
|
|
@@ -3451,7 +3473,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3451
3473
|
|
|
3452
3474
|
### getUserInfo
|
|
3453
3475
|
|
|
3454
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
3476
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
3455
3477
|
|
|
3456
3478
|
Get details about the current user
|
|
3457
3479
|
|
|
@@ -3466,7 +3488,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3466
3488
|
|
|
3467
3489
|
### setUserInfo
|
|
3468
3490
|
|
|
3469
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
3491
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
3470
3492
|
|
|
3471
3493
|
Set details on the current user
|
|
3472
3494
|
|
|
@@ -3482,7 +3504,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3482
3504
|
|
|
3483
3505
|
### changeUsername
|
|
3484
3506
|
|
|
3485
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
3507
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
3486
3508
|
|
|
3487
3509
|
Change username (i.e, email)
|
|
3488
3510
|
|
|
@@ -3500,7 +3522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3500
3522
|
|
|
3501
3523
|
### changeUserPassword
|
|
3502
3524
|
|
|
3503
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
3525
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
3504
3526
|
|
|
3505
3527
|
Change user's password
|
|
3506
3528
|
|
|
@@ -3518,7 +3540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3518
3540
|
|
|
3519
3541
|
### listSIMs
|
|
3520
3542
|
|
|
3521
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
3543
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
3522
3544
|
|
|
3523
3545
|
List SIM cards owned by a user or product
|
|
3524
3546
|
|
|
@@ -3539,7 +3561,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3539
3561
|
|
|
3540
3562
|
### getSIMDataUsage
|
|
3541
3563
|
|
|
3542
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
3564
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
3543
3565
|
|
|
3544
3566
|
Get data usage for one SIM card for the current billing period
|
|
3545
3567
|
|
|
@@ -3556,7 +3578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3556
3578
|
|
|
3557
3579
|
### getFleetDataUsage
|
|
3558
3580
|
|
|
3559
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
3581
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
3560
3582
|
|
|
3561
3583
|
Get data usage for all SIM cards in a product the current billing period
|
|
3562
3584
|
|
|
@@ -3572,7 +3594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3572
3594
|
|
|
3573
3595
|
### checkSIM
|
|
3574
3596
|
|
|
3575
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
3597
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
3576
3598
|
|
|
3577
3599
|
Check SIM status
|
|
3578
3600
|
|
|
@@ -3588,7 +3610,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3588
3610
|
|
|
3589
3611
|
### activateSIM
|
|
3590
3612
|
|
|
3591
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
3613
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
3592
3614
|
|
|
3593
3615
|
Activate and add SIM cards to an account or product
|
|
3594
3616
|
|
|
@@ -3608,7 +3630,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3608
3630
|
|
|
3609
3631
|
### deactivateSIM
|
|
3610
3632
|
|
|
3611
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
3633
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
3612
3634
|
|
|
3613
3635
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
3614
3636
|
|
|
@@ -3625,7 +3647,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3625
3647
|
|
|
3626
3648
|
### reactivateSIM
|
|
3627
3649
|
|
|
3628
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
3650
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
3629
3651
|
|
|
3630
3652
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
3631
3653
|
|
|
@@ -3643,7 +3665,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3643
3665
|
|
|
3644
3666
|
### updateSIM
|
|
3645
3667
|
|
|
3646
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
3668
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
3647
3669
|
|
|
3648
3670
|
Update SIM card data limit
|
|
3649
3671
|
|
|
@@ -3661,7 +3683,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3661
3683
|
|
|
3662
3684
|
### removeSIM
|
|
3663
3685
|
|
|
3664
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
3686
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
3665
3687
|
|
|
3666
3688
|
Remove a SIM card from an account so it can be activated by a different account
|
|
3667
3689
|
|
|
@@ -3678,7 +3700,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3678
3700
|
|
|
3679
3701
|
### listBuildTargets
|
|
3680
3702
|
|
|
3681
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
3703
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
3682
3704
|
|
|
3683
3705
|
List valid build targets to be used for compiling
|
|
3684
3706
|
|
|
@@ -3694,7 +3716,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3694
3716
|
|
|
3695
3717
|
### listLibraries
|
|
3696
3718
|
|
|
3697
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
3719
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
3698
3720
|
|
|
3699
3721
|
List firmware libraries
|
|
3700
3722
|
|
|
@@ -3723,7 +3745,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3723
3745
|
|
|
3724
3746
|
### getLibrary
|
|
3725
3747
|
|
|
3726
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
3748
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
3727
3749
|
|
|
3728
3750
|
Get firmware library details
|
|
3729
3751
|
|
|
@@ -3740,7 +3762,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3740
3762
|
|
|
3741
3763
|
### getLibraryVersions
|
|
3742
3764
|
|
|
3743
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
3765
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
3744
3766
|
|
|
3745
3767
|
Firmware library details for each version
|
|
3746
3768
|
|
|
@@ -3758,7 +3780,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3758
3780
|
|
|
3759
3781
|
### contributeLibrary
|
|
3760
3782
|
|
|
3761
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
3783
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
3762
3784
|
|
|
3763
3785
|
Contribute a new library version from a compressed archive
|
|
3764
3786
|
|
|
@@ -3775,7 +3797,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3775
3797
|
|
|
3776
3798
|
### publishLibrary
|
|
3777
3799
|
|
|
3778
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
3800
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
3779
3801
|
|
|
3780
3802
|
Publish the latest version of a library to the public
|
|
3781
3803
|
|
|
@@ -3791,7 +3813,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3791
3813
|
|
|
3792
3814
|
### deleteLibrary
|
|
3793
3815
|
|
|
3794
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
3816
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
3795
3817
|
|
|
3796
3818
|
Delete one version of a library or an entire private library
|
|
3797
3819
|
|
|
@@ -3808,7 +3830,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3808
3830
|
|
|
3809
3831
|
### downloadFile
|
|
3810
3832
|
|
|
3811
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
3833
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
3812
3834
|
|
|
3813
3835
|
Download an external file that may not be on the API
|
|
3814
3836
|
|
|
@@ -3823,7 +3845,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3823
3845
|
|
|
3824
3846
|
### listOAuthClients
|
|
3825
3847
|
|
|
3826
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
3848
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
3827
3849
|
|
|
3828
3850
|
List OAuth client created by the account
|
|
3829
3851
|
|
|
@@ -3839,7 +3861,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3839
3861
|
|
|
3840
3862
|
### createOAuthClient
|
|
3841
3863
|
|
|
3842
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
3864
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
3843
3865
|
|
|
3844
3866
|
Create an OAuth client
|
|
3845
3867
|
|
|
@@ -3859,7 +3881,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3859
3881
|
|
|
3860
3882
|
### updateOAuthClient
|
|
3861
3883
|
|
|
3862
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
3884
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
3863
3885
|
|
|
3864
3886
|
Update an OAuth client
|
|
3865
3887
|
|
|
@@ -3878,7 +3900,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3878
3900
|
|
|
3879
3901
|
### deleteOAuthClient
|
|
3880
3902
|
|
|
3881
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
3903
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
3882
3904
|
|
|
3883
3905
|
Delete an OAuth client
|
|
3884
3906
|
|
|
@@ -3895,7 +3917,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3895
3917
|
|
|
3896
3918
|
### listProducts
|
|
3897
3919
|
|
|
3898
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
3920
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
3899
3921
|
|
|
3900
3922
|
List products the account has access to
|
|
3901
3923
|
|
|
@@ -3910,7 +3932,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3910
3932
|
|
|
3911
3933
|
### getProduct
|
|
3912
3934
|
|
|
3913
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
3935
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
3914
3936
|
|
|
3915
3937
|
Get detailed information about a product
|
|
3916
3938
|
|
|
@@ -3926,7 +3948,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3926
3948
|
|
|
3927
3949
|
### listProductFirmware
|
|
3928
3950
|
|
|
3929
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
3951
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
3930
3952
|
|
|
3931
3953
|
List product firmware versions
|
|
3932
3954
|
|
|
@@ -3942,7 +3964,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3942
3964
|
|
|
3943
3965
|
### uploadProductFirmware
|
|
3944
3966
|
|
|
3945
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
3967
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
3946
3968
|
|
|
3947
3969
|
List product firmware versions
|
|
3948
3970
|
|
|
@@ -3963,7 +3985,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3963
3985
|
|
|
3964
3986
|
### getProductFirmware
|
|
3965
3987
|
|
|
3966
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
3988
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
3967
3989
|
|
|
3968
3990
|
Get information about a product firmware version
|
|
3969
3991
|
|
|
@@ -3980,7 +4002,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3980
4002
|
|
|
3981
4003
|
### updateProductFirmware
|
|
3982
4004
|
|
|
3983
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
4005
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
3984
4006
|
|
|
3985
4007
|
Update information for a product firmware version
|
|
3986
4008
|
|
|
@@ -3999,7 +4021,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3999
4021
|
|
|
4000
4022
|
### downloadProductFirmware
|
|
4001
4023
|
|
|
4002
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
4024
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
4003
4025
|
|
|
4004
4026
|
Download a product firmware binary
|
|
4005
4027
|
|
|
@@ -4016,7 +4038,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4016
4038
|
|
|
4017
4039
|
### releaseProductFirmware
|
|
4018
4040
|
|
|
4019
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
4041
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
4020
4042
|
|
|
4021
4043
|
Release a product firmware version as the default version
|
|
4022
4044
|
|
|
@@ -4033,7 +4055,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4033
4055
|
|
|
4034
4056
|
### listTeamMembers
|
|
4035
4057
|
|
|
4036
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
4058
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
4037
4059
|
|
|
4038
4060
|
List product team members
|
|
4039
4061
|
|
|
@@ -4049,7 +4071,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4049
4071
|
|
|
4050
4072
|
### inviteTeamMember
|
|
4051
4073
|
|
|
4052
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
4074
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
4053
4075
|
|
|
4054
4076
|
Invite Particle user to a product team
|
|
4055
4077
|
|
|
@@ -4066,7 +4088,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4066
4088
|
|
|
4067
4089
|
### removeTeamMember
|
|
4068
4090
|
|
|
4069
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
4091
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
4070
4092
|
|
|
4071
4093
|
Remove Particle user to a product team
|
|
4072
4094
|
|
|
@@ -4083,7 +4105,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4083
4105
|
|
|
4084
4106
|
### lookupSerialNumber
|
|
4085
4107
|
|
|
4086
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
4108
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
4087
4109
|
|
|
4088
4110
|
Fetch details about a serial number
|
|
4089
4111
|
|
|
@@ -4099,7 +4121,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4099
4121
|
|
|
4100
4122
|
### createMeshNetwork
|
|
4101
4123
|
|
|
4102
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
4124
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
4103
4125
|
|
|
4104
4126
|
Create a mesh network
|
|
4105
4127
|
|
|
@@ -4117,7 +4139,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4117
4139
|
|
|
4118
4140
|
### removeMeshNetwork
|
|
4119
4141
|
|
|
4120
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
4142
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
4121
4143
|
|
|
4122
4144
|
Remove a mesh network.
|
|
4123
4145
|
|
|
@@ -4133,7 +4155,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4133
4155
|
|
|
4134
4156
|
### listMeshNetworks
|
|
4135
4157
|
|
|
4136
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
4158
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
4137
4159
|
|
|
4138
4160
|
List all mesh networks
|
|
4139
4161
|
|
|
@@ -4150,7 +4172,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4150
4172
|
|
|
4151
4173
|
### getMeshNetwork
|
|
4152
4174
|
|
|
4153
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
4175
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
4154
4176
|
|
|
4155
4177
|
Get information about a mesh network.
|
|
4156
4178
|
|
|
@@ -4166,7 +4188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4166
4188
|
|
|
4167
4189
|
### updateMeshNetwork
|
|
4168
4190
|
|
|
4169
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
4191
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
4170
4192
|
|
|
4171
4193
|
Modify a mesh network.
|
|
4172
4194
|
|
|
@@ -4184,7 +4206,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4184
4206
|
|
|
4185
4207
|
### addMeshNetworkDevice
|
|
4186
4208
|
|
|
4187
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
4209
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
4188
4210
|
|
|
4189
4211
|
Add a device to a mesh network.
|
|
4190
4212
|
|
|
@@ -4201,7 +4223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4201
4223
|
|
|
4202
4224
|
### removeMeshNetworkDevice
|
|
4203
4225
|
|
|
4204
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
4226
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
4205
4227
|
|
|
4206
4228
|
Remove a device from a mesh network.
|
|
4207
4229
|
|
|
@@ -4218,7 +4240,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4218
4240
|
|
|
4219
4241
|
### listMeshNetworkDevices
|
|
4220
4242
|
|
|
4221
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
4243
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
4222
4244
|
|
|
4223
4245
|
List all devices of a mesh network.
|
|
4224
4246
|
|
|
@@ -4237,7 +4259,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4237
4259
|
|
|
4238
4260
|
### getProductConfiguration
|
|
4239
4261
|
|
|
4240
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
4262
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
4241
4263
|
|
|
4242
4264
|
Get product configuration
|
|
4243
4265
|
|
|
@@ -4253,7 +4275,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4253
4275
|
|
|
4254
4276
|
### getProductConfigurationSchema
|
|
4255
4277
|
|
|
4256
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
4278
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
4257
4279
|
|
|
4258
4280
|
Get product configuration schema
|
|
4259
4281
|
|
|
@@ -4269,7 +4291,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4269
4291
|
|
|
4270
4292
|
### getProductDeviceConfiguration
|
|
4271
4293
|
|
|
4272
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
4294
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
4273
4295
|
|
|
4274
4296
|
Get product device's configuration
|
|
4275
4297
|
|
|
@@ -4286,7 +4308,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4286
4308
|
|
|
4287
4309
|
### getProductDeviceConfigurationSchema
|
|
4288
4310
|
|
|
4289
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
4311
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
4290
4312
|
|
|
4291
4313
|
Get product device's configuration schema
|
|
4292
4314
|
|
|
@@ -4303,7 +4325,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4303
4325
|
|
|
4304
4326
|
### setProductConfiguration
|
|
4305
4327
|
|
|
4306
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
4328
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
4307
4329
|
|
|
4308
4330
|
Set product configuration
|
|
4309
4331
|
|
|
@@ -4320,7 +4342,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4320
4342
|
|
|
4321
4343
|
### setProductDeviceConfiguration
|
|
4322
4344
|
|
|
4323
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
4345
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
4324
4346
|
|
|
4325
4347
|
Set product configuration for a specific device within the product
|
|
4326
4348
|
|
|
@@ -4338,7 +4360,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4338
4360
|
|
|
4339
4361
|
### getProductLocations
|
|
4340
4362
|
|
|
4341
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
4363
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
4342
4364
|
|
|
4343
4365
|
Query location for devices within a product
|
|
4344
4366
|
|
|
@@ -4362,7 +4384,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4362
4384
|
|
|
4363
4385
|
### getProductDeviceLocations
|
|
4364
4386
|
|
|
4365
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
4387
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
4366
4388
|
|
|
4367
4389
|
Query location for one device within a product
|
|
4368
4390
|
|
|
@@ -4380,11 +4402,30 @@ Query location for one device within a product
|
|
|
4380
4402
|
|
|
4381
4403
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
4382
4404
|
|
|
4405
|
+
### executeLogic
|
|
4406
|
+
|
|
4407
|
+
[src/Particle.js:2131-2139](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2131-L2139 "Source code on GitHub")
|
|
4408
|
+
|
|
4409
|
+
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
4410
|
+
|
|
4411
|
+
NOTE: Any external interactions such as Particle.publish will actually occur when the logic is executed.
|
|
4412
|
+
|
|
4413
|
+
**Parameters**
|
|
4414
|
+
|
|
4415
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
4416
|
+
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4417
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4418
|
+
- `options.logic` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic "function" which will be executed once
|
|
4419
|
+
- `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.
|
|
4420
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4421
|
+
|
|
4422
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
4423
|
+
|
|
4383
4424
|
### createLogicFunction
|
|
4384
4425
|
|
|
4385
|
-
[src/Particle.js:
|
|
4426
|
+
[src/Particle.js:2159-2167](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2159-L2167 "Source code on GitHub")
|
|
4386
4427
|
|
|
4387
|
-
Creates a new logic function in the specified organization using the provided function data.
|
|
4428
|
+
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
4388
4429
|
|
|
4389
4430
|
When you create a logic function with Event logic triggers, events will immediately
|
|
4390
4431
|
start being handled by the function code.
|
|
@@ -4396,7 +4437,7 @@ according to the cron and start_at properties.
|
|
|
4396
4437
|
|
|
4397
4438
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
4398
4439
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4399
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4440
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4400
4441
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
4401
4442
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
4402
4443
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -4405,15 +4446,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4405
4446
|
|
|
4406
4447
|
### getLogicFunction
|
|
4407
4448
|
|
|
4408
|
-
[src/Particle.js:
|
|
4449
|
+
[src/Particle.js:2181-2188](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2181-L2188 "Source code on GitHub")
|
|
4409
4450
|
|
|
4410
|
-
Get a logic function in the specified organization by logic function ID.
|
|
4451
|
+
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
4411
4452
|
|
|
4412
4453
|
**Parameters**
|
|
4413
4454
|
|
|
4414
4455
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
4415
4456
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4416
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4457
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4417
4458
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
4418
4459
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
4419
4460
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -4422,9 +4463,9 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4422
4463
|
|
|
4423
4464
|
### updateLogicFunction
|
|
4424
4465
|
|
|
4425
|
-
[src/Particle.js:
|
|
4466
|
+
[src/Particle.js:2205-2213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2205-L2213 "Source code on GitHub")
|
|
4426
4467
|
|
|
4427
|
-
Updates an existing logic function in the specified organization using the provided function data.
|
|
4468
|
+
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
4428
4469
|
|
|
4429
4470
|
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
4430
4471
|
|
|
@@ -4432,7 +4473,7 @@ If you include an id on a logic trigger, it will update the logic trigger in pla
|
|
|
4432
4473
|
|
|
4433
4474
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
4434
4475
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4435
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4476
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4436
4477
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
4437
4478
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
4438
4479
|
- `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.
|
|
@@ -4442,15 +4483,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4442
4483
|
|
|
4443
4484
|
### deleteLogicFunction
|
|
4444
4485
|
|
|
4445
|
-
[src/Particle.js:
|
|
4486
|
+
[src/Particle.js:2227-2234](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2227-L2234 "Source code on GitHub")
|
|
4446
4487
|
|
|
4447
|
-
Deletes a logic function in the specified organization by logic function ID.
|
|
4488
|
+
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
4448
4489
|
|
|
4449
4490
|
**Parameters**
|
|
4450
4491
|
|
|
4451
4492
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
4452
4493
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4453
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4494
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4454
4495
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
4455
4496
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
4456
4497
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -4459,15 +4500,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4459
4500
|
|
|
4460
4501
|
### listLogicFunctions
|
|
4461
4502
|
|
|
4462
|
-
[src/Particle.js:
|
|
4503
|
+
[src/Particle.js:2247-2254](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2247-L2254 "Source code on GitHub")
|
|
4463
4504
|
|
|
4464
|
-
Lists all logic functions in the specified organization.
|
|
4505
|
+
Lists all logic functions in the specified organization or sandbox.
|
|
4465
4506
|
|
|
4466
4507
|
**Parameters**
|
|
4467
4508
|
|
|
4468
4509
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
4469
4510
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4470
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4511
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4471
4512
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
4472
4513
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4473
4514
|
|
|
@@ -4475,15 +4516,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4475
4516
|
|
|
4476
4517
|
### listLogicRuns
|
|
4477
4518
|
|
|
4478
|
-
[src/Particle.js:
|
|
4519
|
+
[src/Particle.js:2268-2275](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2268-L2275 "Source code on GitHub")
|
|
4479
4520
|
|
|
4480
|
-
Lists all logic runs for the specified logic function.
|
|
4521
|
+
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
4481
4522
|
|
|
4482
4523
|
**Parameters**
|
|
4483
4524
|
|
|
4484
4525
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4485
4526
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4486
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4527
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4487
4528
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
4488
4529
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
4489
4530
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -4492,15 +4533,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4492
4533
|
|
|
4493
4534
|
### getLogicRun
|
|
4494
4535
|
|
|
4495
|
-
[src/Particle.js:
|
|
4536
|
+
[src/Particle.js:2290-2297](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2290-L2297 "Source code on GitHub")
|
|
4496
4537
|
|
|
4497
|
-
Retrieves a logic run by its ID for the specified logic function.
|
|
4538
|
+
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
4498
4539
|
|
|
4499
4540
|
**Parameters**
|
|
4500
4541
|
|
|
4501
4542
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4502
4543
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4503
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4544
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4504
4545
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
4505
4546
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
4506
4547
|
- `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.
|
|
@@ -4510,15 +4551,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4510
4551
|
|
|
4511
4552
|
### getLogicRunLogs
|
|
4512
4553
|
|
|
4513
|
-
[src/Particle.js:
|
|
4554
|
+
[src/Particle.js:2312-2319](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2312-L2319 "Source code on GitHub")
|
|
4514
4555
|
|
|
4515
|
-
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
4556
|
+
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
4516
4557
|
|
|
4517
4558
|
**Parameters**
|
|
4518
4559
|
|
|
4519
4560
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4520
4561
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4521
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4562
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The unique identifier of the organization.
|
|
4522
4563
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
4523
4564
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
4524
4565
|
- `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.
|
|
@@ -4528,15 +4569,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4528
4569
|
|
|
4529
4570
|
### createLedger
|
|
4530
4571
|
|
|
4531
|
-
[src/Particle.js:
|
|
4572
|
+
[src/Particle.js:2334-2342](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2334-L2342 "Source code on GitHub")
|
|
4532
4573
|
|
|
4533
|
-
Creates a new ledger definition in the specified organization.
|
|
4574
|
+
Creates a new ledger definition in the specified organization or sandbox.
|
|
4534
4575
|
|
|
4535
4576
|
**Parameters**
|
|
4536
4577
|
|
|
4537
4578
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
|
|
4538
4579
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4539
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4580
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4540
4581
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
4541
4582
|
- `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.
|
|
4542
4583
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -4546,15 +4587,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4546
4587
|
|
|
4547
4588
|
### getLedger
|
|
4548
4589
|
|
|
4549
|
-
[src/Particle.js:
|
|
4590
|
+
[src/Particle.js:2356-2363](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2356-L2363 "Source code on GitHub")
|
|
4550
4591
|
|
|
4551
|
-
Get a ledger definition in the specified organization by ledger name.
|
|
4592
|
+
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
4552
4593
|
|
|
4553
4594
|
**Parameters**
|
|
4554
4595
|
|
|
4555
4596
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
|
|
4556
4597
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4557
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4598
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4558
4599
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
|
|
4559
4600
|
- `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.
|
|
4560
4601
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -4563,15 +4604,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4563
4604
|
|
|
4564
4605
|
### updateLedger
|
|
4565
4606
|
|
|
4566
|
-
[src/Particle.js:
|
|
4607
|
+
[src/Particle.js:2378-2386](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2378-L2386 "Source code on GitHub")
|
|
4567
4608
|
|
|
4568
|
-
Updates an existing ledger definition in the specified organization.
|
|
4609
|
+
Updates an existing ledger definition in the specified organization or sandbox.
|
|
4569
4610
|
|
|
4570
4611
|
**Parameters**
|
|
4571
4612
|
|
|
4572
4613
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
|
|
4573
4614
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4574
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4615
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4575
4616
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
|
|
4576
4617
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
4577
4618
|
- `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.
|
|
@@ -4581,15 +4622,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4581
4622
|
|
|
4582
4623
|
### archiveLedger
|
|
4583
4624
|
|
|
4584
|
-
[src/Particle.js:
|
|
4625
|
+
[src/Particle.js:2400-2407](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2400-L2407 "Source code on GitHub")
|
|
4585
4626
|
|
|
4586
|
-
Archives a ledger definition in the specified organization by ledger name.
|
|
4627
|
+
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
4587
4628
|
|
|
4588
4629
|
**Parameters**
|
|
4589
4630
|
|
|
4590
4631
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
|
|
4591
4632
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4592
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4633
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4593
4634
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
|
|
4594
4635
|
- `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.
|
|
4595
4636
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -4598,15 +4639,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4598
4639
|
|
|
4599
4640
|
### listLedgers
|
|
4600
4641
|
|
|
4601
|
-
[src/Particle.js:
|
|
4642
|
+
[src/Particle.js:2420-2427](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2420-L2427 "Source code on GitHub")
|
|
4602
4643
|
|
|
4603
|
-
Lists all ledger definitions in the specified organization.
|
|
4644
|
+
Lists all ledger definitions in the specified organization or sandbox.
|
|
4604
4645
|
|
|
4605
4646
|
**Parameters**
|
|
4606
4647
|
|
|
4607
4648
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
|
|
4608
4649
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4609
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4650
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4610
4651
|
- `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.
|
|
4611
4652
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4612
4653
|
|
|
@@ -4614,7 +4655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4614
4655
|
|
|
4615
4656
|
### getLedgerInstance
|
|
4616
4657
|
|
|
4617
|
-
[src/Particle.js:
|
|
4658
|
+
[src/Particle.js:2442-2449](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2442-L2449 "Source code on GitHub")
|
|
4618
4659
|
|
|
4619
4660
|
Get ledger instance data.
|
|
4620
4661
|
|
|
@@ -4622,7 +4663,7 @@ Get ledger instance data.
|
|
|
4622
4663
|
|
|
4623
4664
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
4624
4665
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4625
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4666
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4626
4667
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
4627
4668
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
4628
4669
|
- `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.
|
|
@@ -4632,7 +4673,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4632
4673
|
|
|
4633
4674
|
### setLedgerInstance
|
|
4634
4675
|
|
|
4635
|
-
[src/Particle.js:
|
|
4676
|
+
[src/Particle.js:2466-2474](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2466-L2474 "Source code on GitHub")
|
|
4636
4677
|
|
|
4637
4678
|
Set ledger instance data.
|
|
4638
4679
|
|
|
@@ -4640,7 +4681,7 @@ Set ledger instance data.
|
|
|
4640
4681
|
|
|
4641
4682
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
|
|
4642
4683
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4643
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4684
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4644
4685
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
4645
4686
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
4646
4687
|
- `options.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The data to set to the instance
|
|
@@ -4652,15 +4693,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4652
4693
|
|
|
4653
4694
|
### deleteLedgerInstance
|
|
4654
4695
|
|
|
4655
|
-
[src/Particle.js:
|
|
4696
|
+
[src/Particle.js:2489-2496](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2489-L2496 "Source code on GitHub")
|
|
4656
4697
|
|
|
4657
|
-
Delete a ledger instance in the specified organization by ledger name.
|
|
4698
|
+
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
4658
4699
|
|
|
4659
4700
|
**Parameters**
|
|
4660
4701
|
|
|
4661
4702
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
|
|
4662
4703
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4663
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
4704
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
4664
4705
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
4665
4706
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
4666
4707
|
- `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.
|
|
@@ -4670,15 +4711,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4670
4711
|
|
|
4671
4712
|
### listLedgerInstances
|
|
4672
4713
|
|
|
4673
|
-
[src/Particle.js:
|
|
4714
|
+
[src/Particle.js:2510-2517](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2510-L2517 "Source code on GitHub")
|
|
4674
4715
|
|
|
4675
|
-
Lists ledger instances.
|
|
4716
|
+
Lists ledger instances in the specified organization or sandbox.
|
|
4676
4717
|
|
|
4677
4718
|
**Parameters**
|
|
4678
4719
|
|
|
4679
4720
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
|
|
4680
4721
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4681
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
4722
|
+
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
4682
4723
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
4683
4724
|
- `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.
|
|
4684
4725
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -4687,7 +4728,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4687
4728
|
|
|
4688
4729
|
### setDefaultAuth
|
|
4689
4730
|
|
|
4690
|
-
[src/Particle.js:
|
|
4731
|
+
[src/Particle.js:2524-2530](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2524-L2530 "Source code on GitHub")
|
|
4691
4732
|
|
|
4692
4733
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
4693
4734
|
|
|
@@ -4700,7 +4741,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
4700
4741
|
|
|
4701
4742
|
### get
|
|
4702
4743
|
|
|
4703
|
-
[src/Particle.js:
|
|
4744
|
+
[src/Particle.js:2573-2577](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2573-L2577 "Source code on GitHub")
|
|
4704
4745
|
|
|
4705
4746
|
Make a GET request
|
|
4706
4747
|
|
|
@@ -4717,7 +4758,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4717
4758
|
|
|
4718
4759
|
### head
|
|
4719
4760
|
|
|
4720
|
-
[src/Particle.js:
|
|
4761
|
+
[src/Particle.js:2589-2593](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2589-L2593 "Source code on GitHub")
|
|
4721
4762
|
|
|
4722
4763
|
Make a HEAD request
|
|
4723
4764
|
|
|
@@ -4734,7 +4775,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4734
4775
|
|
|
4735
4776
|
### post
|
|
4736
4777
|
|
|
4737
|
-
[src/Particle.js:
|
|
4778
|
+
[src/Particle.js:2605-2609](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2605-L2609 "Source code on GitHub")
|
|
4738
4779
|
|
|
4739
4780
|
Make a POST request
|
|
4740
4781
|
|
|
@@ -4751,7 +4792,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4751
4792
|
|
|
4752
4793
|
### put
|
|
4753
4794
|
|
|
4754
|
-
[src/Particle.js:
|
|
4795
|
+
[src/Particle.js:2621-2625](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2621-L2625 "Source code on GitHub")
|
|
4755
4796
|
|
|
4756
4797
|
Make a PUT request
|
|
4757
4798
|
|
|
@@ -4768,7 +4809,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4768
4809
|
|
|
4769
4810
|
### delete
|
|
4770
4811
|
|
|
4771
|
-
[src/Particle.js:
|
|
4812
|
+
[src/Particle.js:2637-2641](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2637-L2641 "Source code on GitHub")
|
|
4772
4813
|
|
|
4773
4814
|
Make a DELETE request
|
|
4774
4815
|
|
|
@@ -4785,7 +4826,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4785
4826
|
|
|
4786
4827
|
### request
|
|
4787
4828
|
|
|
4788
|
-
[src/Particle.js:
|
|
4829
|
+
[src/Particle.js:2658-2662](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2658-L2662 "Source code on GitHub")
|
|
4789
4830
|
|
|
4790
4831
|
**Parameters**
|
|
4791
4832
|
|
|
@@ -4805,7 +4846,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4805
4846
|
|
|
4806
4847
|
## Particle
|
|
4807
4848
|
|
|
4808
|
-
[src/Particle.js:23-
|
|
4849
|
+
[src/Particle.js:23-2674](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L23-L2674 "Source code on GitHub")
|
|
4809
4850
|
|
|
4810
4851
|
Particle Cloud API wrapper.
|
|
4811
4852
|
|
|
@@ -4821,7 +4862,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
4821
4862
|
|
|
4822
4863
|
### constructor
|
|
4823
4864
|
|
|
4824
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
4865
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
4825
4866
|
|
|
4826
4867
|
Contructor for the Cloud API wrapper.
|
|
4827
4868
|
|
|
@@ -4833,7 +4874,7 @@ Create a new Particle object and call methods below on it.
|
|
|
4833
4874
|
|
|
4834
4875
|
### login
|
|
4835
4876
|
|
|
4836
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
4877
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
4837
4878
|
|
|
4838
4879
|
Login to Particle Cloud using an existing Particle acccount.
|
|
4839
4880
|
|
|
@@ -4850,7 +4891,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4850
4891
|
|
|
4851
4892
|
### sendOtp
|
|
4852
4893
|
|
|
4853
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
4894
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
4854
4895
|
|
|
4855
4896
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
4856
4897
|
|
|
@@ -4866,7 +4907,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4866
4907
|
|
|
4867
4908
|
### enableMfa
|
|
4868
4909
|
|
|
4869
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
4910
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
4870
4911
|
|
|
4871
4912
|
Enable MFA on the currently logged in user
|
|
4872
4913
|
|
|
@@ -4881,7 +4922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4881
4922
|
|
|
4882
4923
|
### confirmMfa
|
|
4883
4924
|
|
|
4884
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
4925
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
4885
4926
|
|
|
4886
4927
|
Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
|
|
4887
4928
|
|
|
@@ -4899,7 +4940,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4899
4940
|
|
|
4900
4941
|
### disableMfa
|
|
4901
4942
|
|
|
4902
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
4943
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
4903
4944
|
|
|
4904
4945
|
Disable MFA for the user.
|
|
4905
4946
|
|
|
@@ -4915,7 +4956,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4915
4956
|
|
|
4916
4957
|
### createCustomer
|
|
4917
4958
|
|
|
4918
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
4959
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
4919
4960
|
|
|
4920
4961
|
Create Customer for Product.
|
|
4921
4962
|
|
|
@@ -4932,7 +4973,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4932
4973
|
|
|
4933
4974
|
### loginAsClientOwner
|
|
4934
4975
|
|
|
4935
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
4976
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
4936
4977
|
|
|
4937
4978
|
Login to Particle Cloud using an OAuth client.
|
|
4938
4979
|
|
|
@@ -4946,7 +4987,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4946
4987
|
|
|
4947
4988
|
### createUser
|
|
4948
4989
|
|
|
4949
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
4990
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
4950
4991
|
|
|
4951
4992
|
Create a user account for the Particle Cloud
|
|
4952
4993
|
|
|
@@ -4963,7 +5004,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4963
5004
|
|
|
4964
5005
|
### verifyUser
|
|
4965
5006
|
|
|
4966
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
5007
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
4967
5008
|
|
|
4968
5009
|
Verify new user account via verification email
|
|
4969
5010
|
|
|
@@ -4978,7 +5019,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4978
5019
|
|
|
4979
5020
|
### resetPassword
|
|
4980
5021
|
|
|
4981
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
5022
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
4982
5023
|
|
|
4983
5024
|
Send reset password email for a Particle Cloud user account
|
|
4984
5025
|
|
|
@@ -4993,7 +5034,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4993
5034
|
|
|
4994
5035
|
### deleteAccessToken
|
|
4995
5036
|
|
|
4996
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
5037
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
4997
5038
|
|
|
4998
5039
|
Revoke an access token
|
|
4999
5040
|
|
|
@@ -5010,7 +5051,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5010
5051
|
|
|
5011
5052
|
### deleteCurrentAccessToken
|
|
5012
5053
|
|
|
5013
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
5054
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
5014
5055
|
|
|
5015
5056
|
Revoke the current session access token
|
|
5016
5057
|
|
|
@@ -5025,7 +5066,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5025
5066
|
|
|
5026
5067
|
### deleteActiveAccessTokens
|
|
5027
5068
|
|
|
5028
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
5069
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
5029
5070
|
|
|
5030
5071
|
Revoke all active access tokens
|
|
5031
5072
|
|
|
@@ -5040,7 +5081,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5040
5081
|
|
|
5041
5082
|
### deleteUser
|
|
5042
5083
|
|
|
5043
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
5084
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
5044
5085
|
|
|
5045
5086
|
Delete the current user
|
|
5046
5087
|
|
|
@@ -5056,7 +5097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5056
5097
|
|
|
5057
5098
|
### listAccessTokens
|
|
5058
5099
|
|
|
5059
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
5100
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
5060
5101
|
|
|
5061
5102
|
List all valid access tokens for a Particle Cloud account
|
|
5062
5103
|
|
|
@@ -5073,7 +5114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5073
5114
|
|
|
5074
5115
|
### trackingIdentity
|
|
5075
5116
|
|
|
5076
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
5117
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
5077
5118
|
|
|
5078
5119
|
Retrieves the information that is used to identify the current login for tracking.
|
|
5079
5120
|
|
|
@@ -5090,7 +5131,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5090
5131
|
|
|
5091
5132
|
### listDevices
|
|
5092
5133
|
|
|
5093
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
5134
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
5094
5135
|
|
|
5095
5136
|
List devices claimed to the account or product
|
|
5096
5137
|
|
|
@@ -5113,7 +5154,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5113
5154
|
|
|
5114
5155
|
### getDevice
|
|
5115
5156
|
|
|
5116
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
5157
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
5117
5158
|
|
|
5118
5159
|
Get detailed informationa about a device
|
|
5119
5160
|
|
|
@@ -5130,7 +5171,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5130
5171
|
|
|
5131
5172
|
### claimDevice
|
|
5132
5173
|
|
|
5133
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
5174
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
5134
5175
|
|
|
5135
5176
|
Claim a device to the account. The device must be online and unclaimed.
|
|
5136
5177
|
|
|
@@ -5147,7 +5188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5147
5188
|
|
|
5148
5189
|
### addDeviceToProduct
|
|
5149
5190
|
|
|
5150
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
5191
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
5151
5192
|
|
|
5152
5193
|
Add a device to a product or move device out of quarantine.
|
|
5153
5194
|
|
|
@@ -5166,7 +5207,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5166
5207
|
|
|
5167
5208
|
### removeDevice
|
|
5168
5209
|
|
|
5169
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
5210
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
5170
5211
|
|
|
5171
5212
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
5172
5213
|
|
|
@@ -5184,7 +5225,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5184
5225
|
|
|
5185
5226
|
### removeDeviceOwner
|
|
5186
5227
|
|
|
5187
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
5228
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
5188
5229
|
|
|
5189
5230
|
Unclaim a product device its the owner, but keep it in the product
|
|
5190
5231
|
|
|
@@ -5201,7 +5242,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5201
5242
|
|
|
5202
5243
|
### renameDevice
|
|
5203
5244
|
|
|
5204
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
5245
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
5205
5246
|
|
|
5206
5247
|
Rename a device
|
|
5207
5248
|
|
|
@@ -5219,7 +5260,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5219
5260
|
|
|
5220
5261
|
### signalDevice
|
|
5221
5262
|
|
|
5222
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
5263
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
5223
5264
|
|
|
5224
5265
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
5225
5266
|
|
|
@@ -5237,7 +5278,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5237
5278
|
|
|
5238
5279
|
### setDeviceNotes
|
|
5239
5280
|
|
|
5240
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
5281
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
5241
5282
|
|
|
5242
5283
|
Store some notes about device
|
|
5243
5284
|
|
|
@@ -5255,7 +5296,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5255
5296
|
|
|
5256
5297
|
### markAsDevelopmentDevice
|
|
5257
5298
|
|
|
5258
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
5299
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
5259
5300
|
|
|
5260
5301
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
5261
5302
|
|
|
@@ -5273,7 +5314,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5273
5314
|
|
|
5274
5315
|
### lockDeviceProductFirmware
|
|
5275
5316
|
|
|
5276
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
5317
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
5277
5318
|
|
|
5278
5319
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
5279
5320
|
|
|
@@ -5292,7 +5333,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5292
5333
|
|
|
5293
5334
|
### unlockDeviceProductFirmware
|
|
5294
5335
|
|
|
5295
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
5336
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
5296
5337
|
|
|
5297
5338
|
Mark device as receiving automatic firmware updates
|
|
5298
5339
|
|
|
@@ -5309,7 +5350,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5309
5350
|
|
|
5310
5351
|
### updateDevice
|
|
5311
5352
|
|
|
5312
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
5353
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
5313
5354
|
|
|
5314
5355
|
Update multiple device attributes at the same time
|
|
5315
5356
|
|
|
@@ -5333,7 +5374,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5333
5374
|
|
|
5334
5375
|
### provisionDevice
|
|
5335
5376
|
|
|
5336
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
5377
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
5337
5378
|
|
|
5338
5379
|
Provision a new device for products that allow self-provisioning
|
|
5339
5380
|
|
|
@@ -5349,7 +5390,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5349
5390
|
|
|
5350
5391
|
### getClaimCode
|
|
5351
5392
|
|
|
5352
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
5393
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
5353
5394
|
|
|
5354
5395
|
Generate a claim code to use in the device claiming process.
|
|
5355
5396
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -5368,7 +5409,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5368
5409
|
|
|
5369
5410
|
### getVariable
|
|
5370
5411
|
|
|
5371
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
5412
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
5372
5413
|
|
|
5373
5414
|
Get the value of a device variable
|
|
5374
5415
|
|
|
@@ -5386,7 +5427,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5386
5427
|
|
|
5387
5428
|
### flashDevice
|
|
5388
5429
|
|
|
5389
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
5430
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
5390
5431
|
|
|
5391
5432
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
5392
5433
|
|
|
@@ -5405,7 +5446,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5405
5446
|
|
|
5406
5447
|
### flashTinker
|
|
5407
5448
|
|
|
5408
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
5449
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
5409
5450
|
|
|
5410
5451
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
5411
5452
|
|
|
@@ -5421,7 +5462,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5421
5462
|
|
|
5422
5463
|
### compileCode
|
|
5423
5464
|
|
|
5424
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
5465
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
5425
5466
|
|
|
5426
5467
|
Compile firmware using the Particle Cloud
|
|
5427
5468
|
|
|
@@ -5439,7 +5480,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5439
5480
|
|
|
5440
5481
|
### downloadFirmwareBinary
|
|
5441
5482
|
|
|
5442
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
5483
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
5443
5484
|
|
|
5444
5485
|
Download a firmware binary
|
|
5445
5486
|
|
|
@@ -5455,7 +5496,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5455
5496
|
|
|
5456
5497
|
### sendPublicKey
|
|
5457
5498
|
|
|
5458
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
5499
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
5459
5500
|
|
|
5460
5501
|
Send a new device public key to the Particle Cloud
|
|
5461
5502
|
|
|
@@ -5473,7 +5514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5473
5514
|
|
|
5474
5515
|
### callFunction
|
|
5475
5516
|
|
|
5476
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
5517
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
5477
5518
|
|
|
5478
5519
|
Call a device function
|
|
5479
5520
|
|
|
@@ -5492,7 +5533,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5492
5533
|
|
|
5493
5534
|
### getEventStream
|
|
5494
5535
|
|
|
5495
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
5536
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
5496
5537
|
|
|
5497
5538
|
Get a stream of events
|
|
5498
5539
|
|
|
@@ -5510,7 +5551,7 @@ emit 'event' events.
|
|
|
5510
5551
|
|
|
5511
5552
|
### publishEvent
|
|
5512
5553
|
|
|
5513
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
5554
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
5514
5555
|
|
|
5515
5556
|
Publish a event to the Particle Cloud
|
|
5516
5557
|
|
|
@@ -5529,7 +5570,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5529
5570
|
|
|
5530
5571
|
### createWebhook
|
|
5531
5572
|
|
|
5532
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
5573
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
5533
5574
|
|
|
5534
5575
|
Create a webhook
|
|
5535
5576
|
|
|
@@ -5561,7 +5602,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5561
5602
|
|
|
5562
5603
|
### deleteWebhook
|
|
5563
5604
|
|
|
5564
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
5605
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
5565
5606
|
|
|
5566
5607
|
Delete a webhook
|
|
5567
5608
|
|
|
@@ -5578,7 +5619,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5578
5619
|
|
|
5579
5620
|
### listWebhooks
|
|
5580
5621
|
|
|
5581
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
5622
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
5582
5623
|
|
|
5583
5624
|
List all webhooks owned by the account or product
|
|
5584
5625
|
|
|
@@ -5594,7 +5635,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5594
5635
|
|
|
5595
5636
|
### createIntegration
|
|
5596
5637
|
|
|
5597
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
5638
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
5598
5639
|
|
|
5599
5640
|
Create an integration to send events to an external service
|
|
5600
5641
|
|
|
@@ -5615,7 +5656,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5615
5656
|
|
|
5616
5657
|
### editIntegration
|
|
5617
5658
|
|
|
5618
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
5659
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
5619
5660
|
|
|
5620
5661
|
Edit an integration to send events to an external service
|
|
5621
5662
|
|
|
@@ -5637,7 +5678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5637
5678
|
|
|
5638
5679
|
### deleteIntegration
|
|
5639
5680
|
|
|
5640
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
5681
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
5641
5682
|
|
|
5642
5683
|
Delete an integration to send events to an external service
|
|
5643
5684
|
|
|
@@ -5654,7 +5695,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5654
5695
|
|
|
5655
5696
|
### listIntegrations
|
|
5656
5697
|
|
|
5657
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
5698
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
5658
5699
|
|
|
5659
5700
|
List all integrations owned by the account or product
|
|
5660
5701
|
|
|
@@ -5670,7 +5711,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5670
5711
|
|
|
5671
5712
|
### getUserInfo
|
|
5672
5713
|
|
|
5673
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
5714
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
5674
5715
|
|
|
5675
5716
|
Get details about the current user
|
|
5676
5717
|
|
|
@@ -5685,7 +5726,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5685
5726
|
|
|
5686
5727
|
### setUserInfo
|
|
5687
5728
|
|
|
5688
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
5729
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
5689
5730
|
|
|
5690
5731
|
Set details on the current user
|
|
5691
5732
|
|
|
@@ -5701,7 +5742,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5701
5742
|
|
|
5702
5743
|
### changeUsername
|
|
5703
5744
|
|
|
5704
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
5745
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
5705
5746
|
|
|
5706
5747
|
Change username (i.e, email)
|
|
5707
5748
|
|
|
@@ -5719,7 +5760,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5719
5760
|
|
|
5720
5761
|
### changeUserPassword
|
|
5721
5762
|
|
|
5722
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
5763
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
5723
5764
|
|
|
5724
5765
|
Change user's password
|
|
5725
5766
|
|
|
@@ -5737,7 +5778,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5737
5778
|
|
|
5738
5779
|
### listSIMs
|
|
5739
5780
|
|
|
5740
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
5781
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
5741
5782
|
|
|
5742
5783
|
List SIM cards owned by a user or product
|
|
5743
5784
|
|
|
@@ -5758,7 +5799,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5758
5799
|
|
|
5759
5800
|
### getSIMDataUsage
|
|
5760
5801
|
|
|
5761
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
5802
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
5762
5803
|
|
|
5763
5804
|
Get data usage for one SIM card for the current billing period
|
|
5764
5805
|
|
|
@@ -5775,7 +5816,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5775
5816
|
|
|
5776
5817
|
### getFleetDataUsage
|
|
5777
5818
|
|
|
5778
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
5819
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
5779
5820
|
|
|
5780
5821
|
Get data usage for all SIM cards in a product the current billing period
|
|
5781
5822
|
|
|
@@ -5791,7 +5832,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5791
5832
|
|
|
5792
5833
|
### checkSIM
|
|
5793
5834
|
|
|
5794
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
5835
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
5795
5836
|
|
|
5796
5837
|
Check SIM status
|
|
5797
5838
|
|
|
@@ -5807,7 +5848,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5807
5848
|
|
|
5808
5849
|
### activateSIM
|
|
5809
5850
|
|
|
5810
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
5851
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
5811
5852
|
|
|
5812
5853
|
Activate and add SIM cards to an account or product
|
|
5813
5854
|
|
|
@@ -5827,7 +5868,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5827
5868
|
|
|
5828
5869
|
### deactivateSIM
|
|
5829
5870
|
|
|
5830
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
5871
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
5831
5872
|
|
|
5832
5873
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
5833
5874
|
|
|
@@ -5844,7 +5885,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5844
5885
|
|
|
5845
5886
|
### reactivateSIM
|
|
5846
5887
|
|
|
5847
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
5888
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
5848
5889
|
|
|
5849
5890
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
5850
5891
|
|
|
@@ -5862,7 +5903,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5862
5903
|
|
|
5863
5904
|
### updateSIM
|
|
5864
5905
|
|
|
5865
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
5906
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
5866
5907
|
|
|
5867
5908
|
Update SIM card data limit
|
|
5868
5909
|
|
|
@@ -5880,7 +5921,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5880
5921
|
|
|
5881
5922
|
### removeSIM
|
|
5882
5923
|
|
|
5883
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
5924
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
5884
5925
|
|
|
5885
5926
|
Remove a SIM card from an account so it can be activated by a different account
|
|
5886
5927
|
|
|
@@ -5897,7 +5938,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5897
5938
|
|
|
5898
5939
|
### listBuildTargets
|
|
5899
5940
|
|
|
5900
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
5941
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
5901
5942
|
|
|
5902
5943
|
List valid build targets to be used for compiling
|
|
5903
5944
|
|
|
@@ -5913,7 +5954,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5913
5954
|
|
|
5914
5955
|
### listLibraries
|
|
5915
5956
|
|
|
5916
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
5957
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
5917
5958
|
|
|
5918
5959
|
List firmware libraries
|
|
5919
5960
|
|
|
@@ -5942,7 +5983,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5942
5983
|
|
|
5943
5984
|
### getLibrary
|
|
5944
5985
|
|
|
5945
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
5986
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
5946
5987
|
|
|
5947
5988
|
Get firmware library details
|
|
5948
5989
|
|
|
@@ -5959,7 +6000,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5959
6000
|
|
|
5960
6001
|
### getLibraryVersions
|
|
5961
6002
|
|
|
5962
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
6003
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
5963
6004
|
|
|
5964
6005
|
Firmware library details for each version
|
|
5965
6006
|
|
|
@@ -5977,7 +6018,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5977
6018
|
|
|
5978
6019
|
### contributeLibrary
|
|
5979
6020
|
|
|
5980
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
6021
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
5981
6022
|
|
|
5982
6023
|
Contribute a new library version from a compressed archive
|
|
5983
6024
|
|
|
@@ -5994,7 +6035,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5994
6035
|
|
|
5995
6036
|
### publishLibrary
|
|
5996
6037
|
|
|
5997
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
6038
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
5998
6039
|
|
|
5999
6040
|
Publish the latest version of a library to the public
|
|
6000
6041
|
|
|
@@ -6010,7 +6051,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6010
6051
|
|
|
6011
6052
|
### deleteLibrary
|
|
6012
6053
|
|
|
6013
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
6054
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
6014
6055
|
|
|
6015
6056
|
Delete one version of a library or an entire private library
|
|
6016
6057
|
|
|
@@ -6027,7 +6068,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6027
6068
|
|
|
6028
6069
|
### downloadFile
|
|
6029
6070
|
|
|
6030
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
6071
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
6031
6072
|
|
|
6032
6073
|
Download an external file that may not be on the API
|
|
6033
6074
|
|
|
@@ -6042,7 +6083,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6042
6083
|
|
|
6043
6084
|
### listOAuthClients
|
|
6044
6085
|
|
|
6045
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
6086
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
6046
6087
|
|
|
6047
6088
|
List OAuth client created by the account
|
|
6048
6089
|
|
|
@@ -6058,7 +6099,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6058
6099
|
|
|
6059
6100
|
### createOAuthClient
|
|
6060
6101
|
|
|
6061
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
6102
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
6062
6103
|
|
|
6063
6104
|
Create an OAuth client
|
|
6064
6105
|
|
|
@@ -6078,7 +6119,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6078
6119
|
|
|
6079
6120
|
### updateOAuthClient
|
|
6080
6121
|
|
|
6081
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
6122
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
6082
6123
|
|
|
6083
6124
|
Update an OAuth client
|
|
6084
6125
|
|
|
@@ -6097,7 +6138,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6097
6138
|
|
|
6098
6139
|
### deleteOAuthClient
|
|
6099
6140
|
|
|
6100
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
6141
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
6101
6142
|
|
|
6102
6143
|
Delete an OAuth client
|
|
6103
6144
|
|
|
@@ -6114,7 +6155,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6114
6155
|
|
|
6115
6156
|
### listProducts
|
|
6116
6157
|
|
|
6117
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
6158
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
6118
6159
|
|
|
6119
6160
|
List products the account has access to
|
|
6120
6161
|
|
|
@@ -6129,7 +6170,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6129
6170
|
|
|
6130
6171
|
### getProduct
|
|
6131
6172
|
|
|
6132
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
6173
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
6133
6174
|
|
|
6134
6175
|
Get detailed information about a product
|
|
6135
6176
|
|
|
@@ -6145,7 +6186,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6145
6186
|
|
|
6146
6187
|
### listProductFirmware
|
|
6147
6188
|
|
|
6148
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
6189
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
6149
6190
|
|
|
6150
6191
|
List product firmware versions
|
|
6151
6192
|
|
|
@@ -6161,7 +6202,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6161
6202
|
|
|
6162
6203
|
### uploadProductFirmware
|
|
6163
6204
|
|
|
6164
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
6205
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
6165
6206
|
|
|
6166
6207
|
List product firmware versions
|
|
6167
6208
|
|
|
@@ -6182,7 +6223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6182
6223
|
|
|
6183
6224
|
### getProductFirmware
|
|
6184
6225
|
|
|
6185
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
6226
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
6186
6227
|
|
|
6187
6228
|
Get information about a product firmware version
|
|
6188
6229
|
|
|
@@ -6199,7 +6240,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6199
6240
|
|
|
6200
6241
|
### updateProductFirmware
|
|
6201
6242
|
|
|
6202
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
6243
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
6203
6244
|
|
|
6204
6245
|
Update information for a product firmware version
|
|
6205
6246
|
|
|
@@ -6218,7 +6259,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6218
6259
|
|
|
6219
6260
|
### downloadProductFirmware
|
|
6220
6261
|
|
|
6221
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
6262
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
6222
6263
|
|
|
6223
6264
|
Download a product firmware binary
|
|
6224
6265
|
|
|
@@ -6235,7 +6276,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6235
6276
|
|
|
6236
6277
|
### releaseProductFirmware
|
|
6237
6278
|
|
|
6238
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
6279
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
6239
6280
|
|
|
6240
6281
|
Release a product firmware version as the default version
|
|
6241
6282
|
|
|
@@ -6252,7 +6293,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6252
6293
|
|
|
6253
6294
|
### listTeamMembers
|
|
6254
6295
|
|
|
6255
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
6296
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
6256
6297
|
|
|
6257
6298
|
List product team members
|
|
6258
6299
|
|
|
@@ -6268,7 +6309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6268
6309
|
|
|
6269
6310
|
### inviteTeamMember
|
|
6270
6311
|
|
|
6271
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
6312
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
6272
6313
|
|
|
6273
6314
|
Invite Particle user to a product team
|
|
6274
6315
|
|
|
@@ -6285,7 +6326,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6285
6326
|
|
|
6286
6327
|
### removeTeamMember
|
|
6287
6328
|
|
|
6288
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
6329
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
6289
6330
|
|
|
6290
6331
|
Remove Particle user to a product team
|
|
6291
6332
|
|
|
@@ -6302,7 +6343,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6302
6343
|
|
|
6303
6344
|
### lookupSerialNumber
|
|
6304
6345
|
|
|
6305
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
6346
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
6306
6347
|
|
|
6307
6348
|
Fetch details about a serial number
|
|
6308
6349
|
|
|
@@ -6318,7 +6359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6318
6359
|
|
|
6319
6360
|
### createMeshNetwork
|
|
6320
6361
|
|
|
6321
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
6362
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
6322
6363
|
|
|
6323
6364
|
Create a mesh network
|
|
6324
6365
|
|
|
@@ -6336,7 +6377,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6336
6377
|
|
|
6337
6378
|
### removeMeshNetwork
|
|
6338
6379
|
|
|
6339
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
6380
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
6340
6381
|
|
|
6341
6382
|
Remove a mesh network.
|
|
6342
6383
|
|
|
@@ -6352,7 +6393,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6352
6393
|
|
|
6353
6394
|
### listMeshNetworks
|
|
6354
6395
|
|
|
6355
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
6396
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
6356
6397
|
|
|
6357
6398
|
List all mesh networks
|
|
6358
6399
|
|
|
@@ -6369,7 +6410,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6369
6410
|
|
|
6370
6411
|
### getMeshNetwork
|
|
6371
6412
|
|
|
6372
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
6413
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
6373
6414
|
|
|
6374
6415
|
Get information about a mesh network.
|
|
6375
6416
|
|
|
@@ -6385,7 +6426,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6385
6426
|
|
|
6386
6427
|
### updateMeshNetwork
|
|
6387
6428
|
|
|
6388
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
6429
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
6389
6430
|
|
|
6390
6431
|
Modify a mesh network.
|
|
6391
6432
|
|
|
@@ -6403,7 +6444,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6403
6444
|
|
|
6404
6445
|
### addMeshNetworkDevice
|
|
6405
6446
|
|
|
6406
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
6447
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
6407
6448
|
|
|
6408
6449
|
Add a device to a mesh network.
|
|
6409
6450
|
|
|
@@ -6420,7 +6461,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6420
6461
|
|
|
6421
6462
|
### removeMeshNetworkDevice
|
|
6422
6463
|
|
|
6423
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
6464
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
6424
6465
|
|
|
6425
6466
|
Remove a device from a mesh network.
|
|
6426
6467
|
|
|
@@ -6437,7 +6478,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6437
6478
|
|
|
6438
6479
|
### listMeshNetworkDevices
|
|
6439
6480
|
|
|
6440
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
6481
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
6441
6482
|
|
|
6442
6483
|
List all devices of a mesh network.
|
|
6443
6484
|
|
|
@@ -6456,7 +6497,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6456
6497
|
|
|
6457
6498
|
### getProductConfiguration
|
|
6458
6499
|
|
|
6459
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
6500
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
6460
6501
|
|
|
6461
6502
|
Get product configuration
|
|
6462
6503
|
|
|
@@ -6472,7 +6513,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6472
6513
|
|
|
6473
6514
|
### getProductConfigurationSchema
|
|
6474
6515
|
|
|
6475
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
6516
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
6476
6517
|
|
|
6477
6518
|
Get product configuration schema
|
|
6478
6519
|
|
|
@@ -6488,7 +6529,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6488
6529
|
|
|
6489
6530
|
### getProductDeviceConfiguration
|
|
6490
6531
|
|
|
6491
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
6532
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
6492
6533
|
|
|
6493
6534
|
Get product device's configuration
|
|
6494
6535
|
|
|
@@ -6505,7 +6546,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6505
6546
|
|
|
6506
6547
|
### getProductDeviceConfigurationSchema
|
|
6507
6548
|
|
|
6508
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
6549
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
6509
6550
|
|
|
6510
6551
|
Get product device's configuration schema
|
|
6511
6552
|
|
|
@@ -6522,7 +6563,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6522
6563
|
|
|
6523
6564
|
### setProductConfiguration
|
|
6524
6565
|
|
|
6525
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
6566
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
6526
6567
|
|
|
6527
6568
|
Set product configuration
|
|
6528
6569
|
|
|
@@ -6539,7 +6580,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6539
6580
|
|
|
6540
6581
|
### setProductDeviceConfiguration
|
|
6541
6582
|
|
|
6542
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
6583
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
6543
6584
|
|
|
6544
6585
|
Set product configuration for a specific device within the product
|
|
6545
6586
|
|
|
@@ -6557,7 +6598,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6557
6598
|
|
|
6558
6599
|
### getProductLocations
|
|
6559
6600
|
|
|
6560
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
6601
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
6561
6602
|
|
|
6562
6603
|
Query location for devices within a product
|
|
6563
6604
|
|
|
@@ -6581,7 +6622,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6581
6622
|
|
|
6582
6623
|
### getProductDeviceLocations
|
|
6583
6624
|
|
|
6584
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
6625
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
6585
6626
|
|
|
6586
6627
|
Query location for one device within a product
|
|
6587
6628
|
|
|
@@ -6599,11 +6640,30 @@ Query location for one device within a product
|
|
|
6599
6640
|
|
|
6600
6641
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
6601
6642
|
|
|
6643
|
+
### executeLogic
|
|
6644
|
+
|
|
6645
|
+
[src/Particle.js:2131-2139](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2131-L2139 "Source code on GitHub")
|
|
6646
|
+
|
|
6647
|
+
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
6648
|
+
|
|
6649
|
+
NOTE: Any external interactions such as Particle.publish will actually occur when the logic is executed.
|
|
6650
|
+
|
|
6651
|
+
**Parameters**
|
|
6652
|
+
|
|
6653
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
6654
|
+
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6655
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6656
|
+
- `options.logic` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic "function" which will be executed once
|
|
6657
|
+
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6658
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6659
|
+
|
|
6660
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
6661
|
+
|
|
6602
6662
|
### createLogicFunction
|
|
6603
6663
|
|
|
6604
|
-
[src/Particle.js:
|
|
6664
|
+
[src/Particle.js:2159-2167](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2159-L2167 "Source code on GitHub")
|
|
6605
6665
|
|
|
6606
|
-
Creates a new logic function in the specified organization using the provided function data.
|
|
6666
|
+
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
6607
6667
|
|
|
6608
6668
|
When you create a logic function with Event logic triggers, events will immediately
|
|
6609
6669
|
start being handled by the function code.
|
|
@@ -6615,7 +6675,7 @@ according to the cron and start_at properties.
|
|
|
6615
6675
|
|
|
6616
6676
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
6617
6677
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6618
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6678
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6619
6679
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
6620
6680
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6621
6681
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -6624,15 +6684,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6624
6684
|
|
|
6625
6685
|
### getLogicFunction
|
|
6626
6686
|
|
|
6627
|
-
[src/Particle.js:
|
|
6687
|
+
[src/Particle.js:2181-2188](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2181-L2188 "Source code on GitHub")
|
|
6628
6688
|
|
|
6629
|
-
Get a logic function in the specified organization by logic function ID.
|
|
6689
|
+
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
6630
6690
|
|
|
6631
6691
|
**Parameters**
|
|
6632
6692
|
|
|
6633
6693
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
6634
6694
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6635
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6695
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6636
6696
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
6637
6697
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6638
6698
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -6641,9 +6701,9 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6641
6701
|
|
|
6642
6702
|
### updateLogicFunction
|
|
6643
6703
|
|
|
6644
|
-
[src/Particle.js:
|
|
6704
|
+
[src/Particle.js:2205-2213](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2205-L2213 "Source code on GitHub")
|
|
6645
6705
|
|
|
6646
|
-
Updates an existing logic function in the specified organization using the provided function data.
|
|
6706
|
+
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
6647
6707
|
|
|
6648
6708
|
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
6649
6709
|
|
|
@@ -6651,7 +6711,7 @@ If you include an id on a logic trigger, it will update the logic trigger in pla
|
|
|
6651
6711
|
|
|
6652
6712
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
6653
6713
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6654
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6714
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6655
6715
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
6656
6716
|
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
6657
6717
|
- `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.
|
|
@@ -6661,15 +6721,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6661
6721
|
|
|
6662
6722
|
### deleteLogicFunction
|
|
6663
6723
|
|
|
6664
|
-
[src/Particle.js:
|
|
6724
|
+
[src/Particle.js:2227-2234](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2227-L2234 "Source code on GitHub")
|
|
6665
6725
|
|
|
6666
|
-
Deletes a logic function in the specified organization by logic function ID.
|
|
6726
|
+
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
6667
6727
|
|
|
6668
6728
|
**Parameters**
|
|
6669
6729
|
|
|
6670
6730
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
6671
6731
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6672
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6732
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6673
6733
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
6674
6734
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6675
6735
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -6678,15 +6738,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6678
6738
|
|
|
6679
6739
|
### listLogicFunctions
|
|
6680
6740
|
|
|
6681
|
-
[src/Particle.js:
|
|
6741
|
+
[src/Particle.js:2247-2254](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2247-L2254 "Source code on GitHub")
|
|
6682
6742
|
|
|
6683
|
-
Lists all logic functions in the specified organization.
|
|
6743
|
+
Lists all logic functions in the specified organization or sandbox.
|
|
6684
6744
|
|
|
6685
6745
|
**Parameters**
|
|
6686
6746
|
|
|
6687
6747
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
6688
6748
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6689
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6749
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6690
6750
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6691
6751
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
6692
6752
|
|
|
@@ -6694,15 +6754,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6694
6754
|
|
|
6695
6755
|
### listLogicRuns
|
|
6696
6756
|
|
|
6697
|
-
[src/Particle.js:
|
|
6757
|
+
[src/Particle.js:2268-2275](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2268-L2275 "Source code on GitHub")
|
|
6698
6758
|
|
|
6699
|
-
Lists all logic runs for the specified logic function.
|
|
6759
|
+
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
6700
6760
|
|
|
6701
6761
|
**Parameters**
|
|
6702
6762
|
|
|
6703
6763
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6704
6764
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6705
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6765
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6706
6766
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
6707
6767
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
6708
6768
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -6711,15 +6771,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6711
6771
|
|
|
6712
6772
|
### getLogicRun
|
|
6713
6773
|
|
|
6714
|
-
[src/Particle.js:
|
|
6774
|
+
[src/Particle.js:2290-2297](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2290-L2297 "Source code on GitHub")
|
|
6715
6775
|
|
|
6716
|
-
Retrieves a logic run by its ID for the specified logic function.
|
|
6776
|
+
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
6717
6777
|
|
|
6718
6778
|
**Parameters**
|
|
6719
6779
|
|
|
6720
6780
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6721
6781
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6722
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6782
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6723
6783
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
6724
6784
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
6725
6785
|
- `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.
|
|
@@ -6729,15 +6789,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6729
6789
|
|
|
6730
6790
|
### getLogicRunLogs
|
|
6731
6791
|
|
|
6732
|
-
[src/Particle.js:
|
|
6792
|
+
[src/Particle.js:2312-2319](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2312-L2319 "Source code on GitHub")
|
|
6733
6793
|
|
|
6734
|
-
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
6794
|
+
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
6735
6795
|
|
|
6736
6796
|
**Parameters**
|
|
6737
6797
|
|
|
6738
6798
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6739
6799
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6740
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6800
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The unique identifier of the organization.
|
|
6741
6801
|
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
6742
6802
|
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
6743
6803
|
- `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.
|
|
@@ -6747,15 +6807,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6747
6807
|
|
|
6748
6808
|
### createLedger
|
|
6749
6809
|
|
|
6750
|
-
[src/Particle.js:
|
|
6810
|
+
[src/Particle.js:2334-2342](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2334-L2342 "Source code on GitHub")
|
|
6751
6811
|
|
|
6752
|
-
Creates a new ledger definition in the specified organization.
|
|
6812
|
+
Creates a new ledger definition in the specified organization or sandbox.
|
|
6753
6813
|
|
|
6754
6814
|
**Parameters**
|
|
6755
6815
|
|
|
6756
6816
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
|
|
6757
6817
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6758
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6818
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6759
6819
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
6760
6820
|
- `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.
|
|
6761
6821
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -6765,15 +6825,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6765
6825
|
|
|
6766
6826
|
### getLedger
|
|
6767
6827
|
|
|
6768
|
-
[src/Particle.js:
|
|
6828
|
+
[src/Particle.js:2356-2363](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2356-L2363 "Source code on GitHub")
|
|
6769
6829
|
|
|
6770
|
-
Get a ledger definition in the specified organization by ledger name.
|
|
6830
|
+
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
6771
6831
|
|
|
6772
6832
|
**Parameters**
|
|
6773
6833
|
|
|
6774
6834
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
|
|
6775
6835
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6776
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6836
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6777
6837
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
|
|
6778
6838
|
- `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.
|
|
6779
6839
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -6782,15 +6842,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6782
6842
|
|
|
6783
6843
|
### updateLedger
|
|
6784
6844
|
|
|
6785
|
-
[src/Particle.js:
|
|
6845
|
+
[src/Particle.js:2378-2386](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2378-L2386 "Source code on GitHub")
|
|
6786
6846
|
|
|
6787
|
-
Updates an existing ledger definition in the specified organization.
|
|
6847
|
+
Updates an existing ledger definition in the specified organization or sandbox.
|
|
6788
6848
|
|
|
6789
6849
|
**Parameters**
|
|
6790
6850
|
|
|
6791
6851
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
|
|
6792
6852
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6793
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6853
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6794
6854
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
|
|
6795
6855
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
6796
6856
|
- `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.
|
|
@@ -6800,15 +6860,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6800
6860
|
|
|
6801
6861
|
### archiveLedger
|
|
6802
6862
|
|
|
6803
|
-
[src/Particle.js:
|
|
6863
|
+
[src/Particle.js:2400-2407](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2400-L2407 "Source code on GitHub")
|
|
6804
6864
|
|
|
6805
|
-
Archives a ledger definition in the specified organization by ledger name.
|
|
6865
|
+
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
6806
6866
|
|
|
6807
6867
|
**Parameters**
|
|
6808
6868
|
|
|
6809
6869
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
|
|
6810
6870
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6811
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6871
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6812
6872
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
|
|
6813
6873
|
- `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.
|
|
6814
6874
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -6817,15 +6877,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6817
6877
|
|
|
6818
6878
|
### listLedgers
|
|
6819
6879
|
|
|
6820
|
-
[src/Particle.js:
|
|
6880
|
+
[src/Particle.js:2420-2427](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2420-L2427 "Source code on GitHub")
|
|
6821
6881
|
|
|
6822
|
-
Lists all ledger definitions in the specified organization.
|
|
6882
|
+
Lists all ledger definitions in the specified organization or sandbox.
|
|
6823
6883
|
|
|
6824
6884
|
**Parameters**
|
|
6825
6885
|
|
|
6826
6886
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
|
|
6827
6887
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6828
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6888
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6829
6889
|
- `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.
|
|
6830
6890
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
6831
6891
|
|
|
@@ -6833,7 +6893,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6833
6893
|
|
|
6834
6894
|
### getLedgerInstance
|
|
6835
6895
|
|
|
6836
|
-
[src/Particle.js:
|
|
6896
|
+
[src/Particle.js:2442-2449](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2442-L2449 "Source code on GitHub")
|
|
6837
6897
|
|
|
6838
6898
|
Get ledger instance data.
|
|
6839
6899
|
|
|
@@ -6841,7 +6901,7 @@ Get ledger instance data.
|
|
|
6841
6901
|
|
|
6842
6902
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
6843
6903
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6844
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6904
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6845
6905
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
6846
6906
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
6847
6907
|
- `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.
|
|
@@ -6851,7 +6911,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6851
6911
|
|
|
6852
6912
|
### setLedgerInstance
|
|
6853
6913
|
|
|
6854
|
-
[src/Particle.js:
|
|
6914
|
+
[src/Particle.js:2466-2474](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2466-L2474 "Source code on GitHub")
|
|
6855
6915
|
|
|
6856
6916
|
Set ledger instance data.
|
|
6857
6917
|
|
|
@@ -6859,7 +6919,7 @@ Set ledger instance data.
|
|
|
6859
6919
|
|
|
6860
6920
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
|
|
6861
6921
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6862
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6922
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6863
6923
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
6864
6924
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
6865
6925
|
- `options.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The data to set to the instance
|
|
@@ -6871,15 +6931,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6871
6931
|
|
|
6872
6932
|
### deleteLedgerInstance
|
|
6873
6933
|
|
|
6874
|
-
[src/Particle.js:
|
|
6934
|
+
[src/Particle.js:2489-2496](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2489-L2496 "Source code on GitHub")
|
|
6875
6935
|
|
|
6876
|
-
Delete a ledger instance in the specified organization by ledger name.
|
|
6936
|
+
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
6877
6937
|
|
|
6878
6938
|
**Parameters**
|
|
6879
6939
|
|
|
6880
6940
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
|
|
6881
6941
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6882
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The
|
|
6942
|
+
- `options.org` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
6883
6943
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
6884
6944
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
6885
6945
|
- `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.
|
|
@@ -6889,15 +6949,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6889
6949
|
|
|
6890
6950
|
### listLedgerInstances
|
|
6891
6951
|
|
|
6892
|
-
[src/Particle.js:
|
|
6952
|
+
[src/Particle.js:2510-2517](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2510-L2517 "Source code on GitHub")
|
|
6893
6953
|
|
|
6894
|
-
Lists ledger instances.
|
|
6954
|
+
Lists ledger instances in the specified organization or sandbox.
|
|
6895
6955
|
|
|
6896
6956
|
**Parameters**
|
|
6897
6957
|
|
|
6898
6958
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
|
|
6899
6959
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6900
|
-
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
6960
|
+
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
6901
6961
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
6902
6962
|
- `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.
|
|
6903
6963
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
@@ -6906,7 +6966,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6906
6966
|
|
|
6907
6967
|
### setDefaultAuth
|
|
6908
6968
|
|
|
6909
|
-
[src/Particle.js:
|
|
6969
|
+
[src/Particle.js:2524-2530](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2524-L2530 "Source code on GitHub")
|
|
6910
6970
|
|
|
6911
6971
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
6912
6972
|
|
|
@@ -6919,7 +6979,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
6919
6979
|
|
|
6920
6980
|
### get
|
|
6921
6981
|
|
|
6922
|
-
[src/Particle.js:
|
|
6982
|
+
[src/Particle.js:2573-2577](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2573-L2577 "Source code on GitHub")
|
|
6923
6983
|
|
|
6924
6984
|
Make a GET request
|
|
6925
6985
|
|
|
@@ -6936,7 +6996,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6936
6996
|
|
|
6937
6997
|
### head
|
|
6938
6998
|
|
|
6939
|
-
[src/Particle.js:
|
|
6999
|
+
[src/Particle.js:2589-2593](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2589-L2593 "Source code on GitHub")
|
|
6940
7000
|
|
|
6941
7001
|
Make a HEAD request
|
|
6942
7002
|
|
|
@@ -6953,7 +7013,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6953
7013
|
|
|
6954
7014
|
### post
|
|
6955
7015
|
|
|
6956
|
-
[src/Particle.js:
|
|
7016
|
+
[src/Particle.js:2605-2609](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2605-L2609 "Source code on GitHub")
|
|
6957
7017
|
|
|
6958
7018
|
Make a POST request
|
|
6959
7019
|
|
|
@@ -6970,7 +7030,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6970
7030
|
|
|
6971
7031
|
### put
|
|
6972
7032
|
|
|
6973
|
-
[src/Particle.js:
|
|
7033
|
+
[src/Particle.js:2621-2625](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2621-L2625 "Source code on GitHub")
|
|
6974
7034
|
|
|
6975
7035
|
Make a PUT request
|
|
6976
7036
|
|
|
@@ -6987,7 +7047,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6987
7047
|
|
|
6988
7048
|
### delete
|
|
6989
7049
|
|
|
6990
|
-
[src/Particle.js:
|
|
7050
|
+
[src/Particle.js:2637-2641](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2637-L2641 "Source code on GitHub")
|
|
6991
7051
|
|
|
6992
7052
|
Make a DELETE request
|
|
6993
7053
|
|
|
@@ -7004,7 +7064,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7004
7064
|
|
|
7005
7065
|
### request
|
|
7006
7066
|
|
|
7007
|
-
[src/Particle.js:
|
|
7067
|
+
[src/Particle.js:2658-2662](https://github.com/particle-iot/particle-api-js/blob/3cb9e78d8e679de9e807348f0ce17ffca6307618/src/Particle.js#L2658-L2662 "Source code on GitHub")
|
|
7008
7068
|
|
|
7009
7069
|
**Parameters**
|
|
7010
7070
|
|