particle-api-js 11.1.2 → 11.1.3
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/.circleci/config.yml +6 -3
- package/CHANGELOG.md +3 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +137 -137
- package/package.json +7 -7
- package/test/Agent.integration.js +1 -1
package/docs/api.md
CHANGED
|
@@ -142,7 +142,7 @@
|
|
|
142
142
|
|
|
143
143
|
## Particle
|
|
144
144
|
|
|
145
|
-
[src/Particle.js:19-2846](https://github.com/particle-iot/particle-api-js/blob/
|
|
145
|
+
[src/Particle.js:19-2846](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L19-L2846 "Source code on GitHub")
|
|
146
146
|
|
|
147
147
|
Particle Cloud API wrapper.
|
|
148
148
|
|
|
@@ -158,7 +158,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
158
158
|
|
|
159
159
|
### constructor
|
|
160
160
|
|
|
161
|
-
[src/Particle.js:32-42](https://github.com/particle-iot/particle-api-js/blob/
|
|
161
|
+
[src/Particle.js:32-42](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L32-L42 "Source code on GitHub")
|
|
162
162
|
|
|
163
163
|
Contructor for the Cloud API wrapper.
|
|
164
164
|
|
|
@@ -175,7 +175,7 @@ Create a new Particle object and call methods below on it.
|
|
|
175
175
|
|
|
176
176
|
### ToolContext
|
|
177
177
|
|
|
178
|
-
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/
|
|
178
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
179
179
|
|
|
180
180
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
181
181
|
|
|
@@ -192,7 +192,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
192
192
|
|
|
193
193
|
### ProjectContext
|
|
194
194
|
|
|
195
|
-
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/
|
|
195
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
196
196
|
|
|
197
197
|
Type: Record<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), ([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))>
|
|
198
198
|
|
|
@@ -207,7 +207,7 @@ Type: Record<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript
|
|
|
207
207
|
|
|
208
208
|
### setContext
|
|
209
209
|
|
|
210
|
-
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/
|
|
210
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
211
211
|
|
|
212
212
|
Allows setting a tool or project context which will be sent as headers with every request.
|
|
213
213
|
Tool- x-particle-tool
|
|
@@ -220,7 +220,7 @@ Project- x-particle-project
|
|
|
220
220
|
|
|
221
221
|
### login
|
|
222
222
|
|
|
223
|
-
[src/Particle.js:98-115](https://github.com/particle-iot/particle-api-js/blob/
|
|
223
|
+
[src/Particle.js:98-115](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L98-L115 "Source code on GitHub")
|
|
224
224
|
|
|
225
225
|
Login to Particle Cloud using an existing Particle acccount.
|
|
226
226
|
|
|
@@ -237,7 +237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
237
237
|
|
|
238
238
|
### sendOtp
|
|
239
239
|
|
|
240
|
-
[src/Particle.js:126-142](https://github.com/particle-iot/particle-api-js/blob/
|
|
240
|
+
[src/Particle.js:126-142](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L126-L142 "Source code on GitHub")
|
|
241
241
|
|
|
242
242
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
243
243
|
|
|
@@ -253,7 +253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
253
253
|
|
|
254
254
|
### enableMfa
|
|
255
255
|
|
|
256
|
-
[src/Particle.js:152-154](https://github.com/particle-iot/particle-api-js/blob/
|
|
256
|
+
[src/Particle.js:152-154](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L152-L154 "Source code on GitHub")
|
|
257
257
|
|
|
258
258
|
Enable MFA on the currently logged in user
|
|
259
259
|
|
|
@@ -268,7 +268,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
268
268
|
|
|
269
269
|
### confirmMfa
|
|
270
270
|
|
|
271
|
-
[src/Particle.js:167-181](https://github.com/particle-iot/particle-api-js/blob/
|
|
271
|
+
[src/Particle.js:167-181](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L167-L181 "Source code on GitHub")
|
|
272
272
|
|
|
273
273
|
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.
|
|
274
274
|
|
|
@@ -286,7 +286,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
286
286
|
|
|
287
287
|
### disableMfa
|
|
288
288
|
|
|
289
|
-
[src/Particle.js:192-200](https://github.com/particle-iot/particle-api-js/blob/
|
|
289
|
+
[src/Particle.js:192-200](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L192-L200 "Source code on GitHub")
|
|
290
290
|
|
|
291
291
|
Disable MFA for the user.
|
|
292
292
|
|
|
@@ -302,7 +302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
302
302
|
|
|
303
303
|
### createCustomer
|
|
304
304
|
|
|
305
|
-
[src/Particle.js:212-228](https://github.com/particle-iot/particle-api-js/blob/
|
|
305
|
+
[src/Particle.js:212-228](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L212-L228 "Source code on GitHub")
|
|
306
306
|
|
|
307
307
|
Create Customer for Product.
|
|
308
308
|
|
|
@@ -319,7 +319,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
319
319
|
|
|
320
320
|
### loginAsClientOwner
|
|
321
321
|
|
|
322
|
-
[src/Particle.js:237-251](https://github.com/particle-iot/particle-api-js/blob/
|
|
322
|
+
[src/Particle.js:237-251](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L237-L251 "Source code on GitHub")
|
|
323
323
|
|
|
324
324
|
Login to Particle Cloud using an OAuth client.
|
|
325
325
|
|
|
@@ -333,7 +333,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
333
333
|
|
|
334
334
|
### createUser
|
|
335
335
|
|
|
336
|
-
[src/Particle.js:264-276](https://github.com/particle-iot/particle-api-js/blob/
|
|
336
|
+
[src/Particle.js:264-276](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L264-L276 "Source code on GitHub")
|
|
337
337
|
|
|
338
338
|
Create a user account for the Particle Cloud
|
|
339
339
|
|
|
@@ -351,7 +351,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
351
351
|
|
|
352
352
|
### verifyUser
|
|
353
353
|
|
|
354
|
-
[src/Particle.js:286-293](https://github.com/particle-iot/particle-api-js/blob/
|
|
354
|
+
[src/Particle.js:286-293](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L286-L293 "Source code on GitHub")
|
|
355
355
|
|
|
356
356
|
Verify new user account via verification email
|
|
357
357
|
|
|
@@ -366,7 +366,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
366
366
|
|
|
367
367
|
### resetPassword
|
|
368
368
|
|
|
369
|
-
[src/Particle.js:303-310](https://github.com/particle-iot/particle-api-js/blob/
|
|
369
|
+
[src/Particle.js:303-310](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L303-L310 "Source code on GitHub")
|
|
370
370
|
|
|
371
371
|
Send reset password email for a Particle Cloud user account
|
|
372
372
|
|
|
@@ -381,7 +381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
381
381
|
|
|
382
382
|
### deleteAccessToken
|
|
383
383
|
|
|
384
|
-
[src/Particle.js:320-326](https://github.com/particle-iot/particle-api-js/blob/
|
|
384
|
+
[src/Particle.js:320-326](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L320-L326 "Source code on GitHub")
|
|
385
385
|
|
|
386
386
|
Revoke an access token
|
|
387
387
|
|
|
@@ -396,7 +396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
396
396
|
|
|
397
397
|
### deleteCurrentAccessToken
|
|
398
398
|
|
|
399
|
-
[src/Particle.js:336-343](https://github.com/particle-iot/particle-api-js/blob/
|
|
399
|
+
[src/Particle.js:336-343](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L336-L343 "Source code on GitHub")
|
|
400
400
|
|
|
401
401
|
Revoke the current session access token
|
|
402
402
|
|
|
@@ -411,7 +411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
411
411
|
|
|
412
412
|
### deleteActiveAccessTokens
|
|
413
413
|
|
|
414
|
-
[src/Particle.js:353-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
414
|
+
[src/Particle.js:353-360](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L353-L360 "Source code on GitHub")
|
|
415
415
|
|
|
416
416
|
Revoke all active access tokens
|
|
417
417
|
|
|
@@ -426,7 +426,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
426
426
|
|
|
427
427
|
### deleteUser
|
|
428
428
|
|
|
429
|
-
[src/Particle.js:371-379](https://github.com/particle-iot/particle-api-js/blob/
|
|
429
|
+
[src/Particle.js:371-379](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L371-L379 "Source code on GitHub")
|
|
430
430
|
|
|
431
431
|
Delete the current user
|
|
432
432
|
|
|
@@ -442,7 +442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
442
442
|
|
|
443
443
|
### trackingIdentity
|
|
444
444
|
|
|
445
|
-
[src/Particle.js:391-399](https://github.com/particle-iot/particle-api-js/blob/
|
|
445
|
+
[src/Particle.js:391-399](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L391-L399 "Source code on GitHub")
|
|
446
446
|
|
|
447
447
|
Retrieves the information that is used to identify the current login for tracking.
|
|
448
448
|
|
|
@@ -459,7 +459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
459
459
|
|
|
460
460
|
### listDevices
|
|
461
461
|
|
|
462
|
-
[src/Particle.js:417-436](https://github.com/particle-iot/particle-api-js/blob/
|
|
462
|
+
[src/Particle.js:417-436](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L417-L436 "Source code on GitHub")
|
|
463
463
|
|
|
464
464
|
List devices claimed to the account or product
|
|
465
465
|
|
|
@@ -482,7 +482,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
482
482
|
|
|
483
483
|
### getDevice
|
|
484
484
|
|
|
485
|
-
[src/Particle.js:448-451](https://github.com/particle-iot/particle-api-js/blob/
|
|
485
|
+
[src/Particle.js:448-451](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L448-L451 "Source code on GitHub")
|
|
486
486
|
|
|
487
487
|
Get detailed informationa about a device
|
|
488
488
|
|
|
@@ -499,7 +499,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
499
499
|
|
|
500
500
|
### claimDevice
|
|
501
501
|
|
|
502
|
-
[src/Particle.js:463-474](https://github.com/particle-iot/particle-api-js/blob/
|
|
502
|
+
[src/Particle.js:463-474](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L463-L474 "Source code on GitHub")
|
|
503
503
|
|
|
504
504
|
Claim a device to the account. The device must be online and unclaimed.
|
|
505
505
|
|
|
@@ -516,7 +516,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
516
516
|
|
|
517
517
|
### addDeviceToProduct
|
|
518
518
|
|
|
519
|
-
[src/Particle.js:488-506](https://github.com/particle-iot/particle-api-js/blob/
|
|
519
|
+
[src/Particle.js:488-506](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L488-L506 "Source code on GitHub")
|
|
520
520
|
|
|
521
521
|
Add a device to a product or move device out of quarantine.
|
|
522
522
|
|
|
@@ -535,7 +535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
535
535
|
|
|
536
536
|
### removeDevice
|
|
537
537
|
|
|
538
|
-
[src/Particle.js:519-523](https://github.com/particle-iot/particle-api-js/blob/
|
|
538
|
+
[src/Particle.js:519-523](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L519-L523 "Source code on GitHub")
|
|
539
539
|
|
|
540
540
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
541
541
|
|
|
@@ -553,7 +553,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
553
553
|
|
|
554
554
|
### removeDeviceOwner
|
|
555
555
|
|
|
556
|
-
[src/Particle.js:535-538](https://github.com/particle-iot/particle-api-js/blob/
|
|
556
|
+
[src/Particle.js:535-538](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L535-L538 "Source code on GitHub")
|
|
557
557
|
|
|
558
558
|
Unclaim a product device its the owner, but keep it in the product
|
|
559
559
|
|
|
@@ -570,7 +570,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
570
570
|
|
|
571
571
|
### renameDevice
|
|
572
572
|
|
|
573
|
-
[src/Particle.js:551-553](https://github.com/particle-iot/particle-api-js/blob/
|
|
573
|
+
[src/Particle.js:551-553](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L551-L553 "Source code on GitHub")
|
|
574
574
|
|
|
575
575
|
Rename a device
|
|
576
576
|
|
|
@@ -588,7 +588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
588
588
|
|
|
589
589
|
### signalDevice
|
|
590
590
|
|
|
591
|
-
[src/Particle.js:566-568](https://github.com/particle-iot/particle-api-js/blob/
|
|
591
|
+
[src/Particle.js:566-568](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L566-L568 "Source code on GitHub")
|
|
592
592
|
|
|
593
593
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
594
594
|
|
|
@@ -606,7 +606,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
606
606
|
|
|
607
607
|
### setDeviceNotes
|
|
608
608
|
|
|
609
|
-
[src/Particle.js:581-583](https://github.com/particle-iot/particle-api-js/blob/
|
|
609
|
+
[src/Particle.js:581-583](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L581-L583 "Source code on GitHub")
|
|
610
610
|
|
|
611
611
|
Store some notes about device
|
|
612
612
|
|
|
@@ -624,7 +624,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
624
624
|
|
|
625
625
|
### markAsDevelopmentDevice
|
|
626
626
|
|
|
627
|
-
[src/Particle.js:596-598](https://github.com/particle-iot/particle-api-js/blob/
|
|
627
|
+
[src/Particle.js:596-598](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L596-L598 "Source code on GitHub")
|
|
628
628
|
|
|
629
629
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
630
630
|
|
|
@@ -642,7 +642,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
642
642
|
|
|
643
643
|
### lockDeviceProductFirmware
|
|
644
644
|
|
|
645
|
-
[src/Particle.js:612-614](https://github.com/particle-iot/particle-api-js/blob/
|
|
645
|
+
[src/Particle.js:612-614](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L612-L614 "Source code on GitHub")
|
|
646
646
|
|
|
647
647
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
648
648
|
|
|
@@ -661,7 +661,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
661
661
|
|
|
662
662
|
### unlockDeviceProductFirmware
|
|
663
663
|
|
|
664
|
-
[src/Particle.js:626-628](https://github.com/particle-iot/particle-api-js/blob/
|
|
664
|
+
[src/Particle.js:626-628](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L626-L628 "Source code on GitHub")
|
|
665
665
|
|
|
666
666
|
Mark device as receiving automatic firmware updates
|
|
667
667
|
|
|
@@ -678,7 +678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
678
678
|
|
|
679
679
|
### updateDevice
|
|
680
680
|
|
|
681
|
-
[src/Particle.js:647-659](https://github.com/particle-iot/particle-api-js/blob/
|
|
681
|
+
[src/Particle.js:647-659](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L647-L659 "Source code on GitHub")
|
|
682
682
|
|
|
683
683
|
Update multiple device attributes at the same time
|
|
684
684
|
|
|
@@ -702,7 +702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
702
702
|
|
|
703
703
|
### unprotectDevice
|
|
704
704
|
|
|
705
|
-
[src/Particle.js:679-695](https://github.com/particle-iot/particle-api-js/blob/
|
|
705
|
+
[src/Particle.js:679-695](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L679-L695 "Source code on GitHub")
|
|
706
706
|
|
|
707
707
|
Disable device protection.
|
|
708
708
|
|
|
@@ -726,7 +726,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
726
726
|
|
|
727
727
|
### provisionDevice
|
|
728
728
|
|
|
729
|
-
[src/Particle.js:706-714](https://github.com/particle-iot/particle-api-js/blob/
|
|
729
|
+
[src/Particle.js:706-714](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L706-L714 "Source code on GitHub")
|
|
730
730
|
|
|
731
731
|
Provision a new device for products that allow self-provisioning
|
|
732
732
|
|
|
@@ -742,7 +742,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
742
742
|
|
|
743
743
|
### getClaimCode
|
|
744
744
|
|
|
745
|
-
[src/Particle.js:728-731](https://github.com/particle-iot/particle-api-js/blob/
|
|
745
|
+
[src/Particle.js:728-731](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L728-L731 "Source code on GitHub")
|
|
746
746
|
|
|
747
747
|
Generate a claim code to use in the device claiming process.
|
|
748
748
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -761,7 +761,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
761
761
|
|
|
762
762
|
### getVariable
|
|
763
763
|
|
|
764
|
-
[src/Particle.js:753-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
764
|
+
[src/Particle.js:753-759](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L753-L759 "Source code on GitHub")
|
|
765
765
|
|
|
766
766
|
Get the value of a device variable
|
|
767
767
|
|
|
@@ -779,7 +779,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
779
779
|
|
|
780
780
|
### flashDevice
|
|
781
781
|
|
|
782
|
-
[src/Particle.js:773-784](https://github.com/particle-iot/particle-api-js/blob/
|
|
782
|
+
[src/Particle.js:773-784](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L773-L784 "Source code on GitHub")
|
|
783
783
|
|
|
784
784
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
785
785
|
|
|
@@ -798,7 +798,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
798
798
|
|
|
799
799
|
### flashTinker
|
|
800
800
|
|
|
801
|
-
[src/Particle.js:795-810](https://github.com/particle-iot/particle-api-js/blob/
|
|
801
|
+
[src/Particle.js:795-810](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L795-L810 "Source code on GitHub")
|
|
802
802
|
|
|
803
803
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
804
804
|
|
|
@@ -814,7 +814,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
814
814
|
|
|
815
815
|
### compileCode
|
|
816
816
|
|
|
817
|
-
[src/Particle.js:823-841](https://github.com/particle-iot/particle-api-js/blob/
|
|
817
|
+
[src/Particle.js:823-841](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L823-L841 "Source code on GitHub")
|
|
818
818
|
|
|
819
819
|
Compile firmware using the Particle Cloud
|
|
820
820
|
|
|
@@ -832,7 +832,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
832
832
|
|
|
833
833
|
### downloadFirmwareBinary
|
|
834
834
|
|
|
835
|
-
[src/Particle.js:852-861](https://github.com/particle-iot/particle-api-js/blob/
|
|
835
|
+
[src/Particle.js:852-861](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L852-L861 "Source code on GitHub")
|
|
836
836
|
|
|
837
837
|
Download a firmware binary
|
|
838
838
|
|
|
@@ -848,7 +848,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
848
848
|
|
|
849
849
|
### sendPublicKey
|
|
850
850
|
|
|
851
|
-
[src/Particle.js:874-888](https://github.com/particle-iot/particle-api-js/blob/
|
|
851
|
+
[src/Particle.js:874-888](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L874-L888 "Source code on GitHub")
|
|
852
852
|
|
|
853
853
|
Send a new device public key to the Particle Cloud
|
|
854
854
|
|
|
@@ -866,7 +866,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
866
866
|
|
|
867
867
|
### callFunction
|
|
868
868
|
|
|
869
|
-
[src/Particle.js:902-907](https://github.com/particle-iot/particle-api-js/blob/
|
|
869
|
+
[src/Particle.js:902-907](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L902-L907 "Source code on GitHub")
|
|
870
870
|
|
|
871
871
|
Call a device function
|
|
872
872
|
|
|
@@ -885,7 +885,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
885
885
|
|
|
886
886
|
### getEventStream
|
|
887
887
|
|
|
888
|
-
[src/Particle.js:920-945](https://github.com/particle-iot/particle-api-js/blob/
|
|
888
|
+
[src/Particle.js:920-945](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L920-L945 "Source code on GitHub")
|
|
889
889
|
|
|
890
890
|
Get a stream of events
|
|
891
891
|
|
|
@@ -903,7 +903,7 @@ emit 'event' events.
|
|
|
903
903
|
|
|
904
904
|
### publishEvent
|
|
905
905
|
|
|
906
|
-
[src/Particle.js:959-963](https://github.com/particle-iot/particle-api-js/blob/
|
|
906
|
+
[src/Particle.js:959-963](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L959-L963 "Source code on GitHub")
|
|
907
907
|
|
|
908
908
|
Publish a event to the Particle Cloud
|
|
909
909
|
|
|
@@ -922,7 +922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
922
922
|
|
|
923
923
|
### Hook
|
|
924
924
|
|
|
925
|
-
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
925
|
+
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L994-L1016 "Source code on GitHub")
|
|
926
926
|
|
|
927
927
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
928
928
|
|
|
@@ -955,7 +955,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
955
955
|
|
|
956
956
|
### createWebhook
|
|
957
957
|
|
|
958
|
-
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
958
|
+
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L994-L1016 "Source code on GitHub")
|
|
959
959
|
|
|
960
960
|
Create a webhook
|
|
961
961
|
|
|
@@ -977,7 +977,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
977
977
|
|
|
978
978
|
### deleteWebhook
|
|
979
979
|
|
|
980
|
-
[src/Particle.js:1028-1031](https://github.com/particle-iot/particle-api-js/blob/
|
|
980
|
+
[src/Particle.js:1028-1031](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1028-L1031 "Source code on GitHub")
|
|
981
981
|
|
|
982
982
|
Delete a webhook
|
|
983
983
|
|
|
@@ -994,7 +994,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
994
994
|
|
|
995
995
|
### listWebhooks
|
|
996
996
|
|
|
997
|
-
[src/Particle.js:1042-1045](https://github.com/particle-iot/particle-api-js/blob/
|
|
997
|
+
[src/Particle.js:1042-1045](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1042-L1045 "Source code on GitHub")
|
|
998
998
|
|
|
999
999
|
List all webhooks owned by the account or product
|
|
1000
1000
|
|
|
@@ -1010,7 +1010,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1010
1010
|
|
|
1011
1011
|
### createIntegration
|
|
1012
1012
|
|
|
1013
|
-
[src/Particle.js:1062-1066](https://github.com/particle-iot/particle-api-js/blob/
|
|
1013
|
+
[src/Particle.js:1062-1066](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1062-L1066 "Source code on GitHub")
|
|
1014
1014
|
|
|
1015
1015
|
Create an integration to send events to an external service
|
|
1016
1016
|
|
|
@@ -1031,7 +1031,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1031
1031
|
|
|
1032
1032
|
### editIntegration
|
|
1033
1033
|
|
|
1034
|
-
[src/Particle.js:1084-1088](https://github.com/particle-iot/particle-api-js/blob/
|
|
1034
|
+
[src/Particle.js:1084-1088](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1084-L1088 "Source code on GitHub")
|
|
1035
1035
|
|
|
1036
1036
|
Edit an integration to send events to an external service
|
|
1037
1037
|
|
|
@@ -1053,7 +1053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1053
1053
|
|
|
1054
1054
|
### deleteIntegration
|
|
1055
1055
|
|
|
1056
|
-
[src/Particle.js:1101-1104](https://github.com/particle-iot/particle-api-js/blob/
|
|
1056
|
+
[src/Particle.js:1101-1104](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1101-L1104 "Source code on GitHub")
|
|
1057
1057
|
|
|
1058
1058
|
Delete an integration to send events to an external service
|
|
1059
1059
|
|
|
@@ -1070,7 +1070,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1070
1070
|
|
|
1071
1071
|
### listIntegrations
|
|
1072
1072
|
|
|
1073
|
-
[src/Particle.js:1115-1118](https://github.com/particle-iot/particle-api-js/blob/
|
|
1073
|
+
[src/Particle.js:1115-1118](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1115-L1118 "Source code on GitHub")
|
|
1074
1074
|
|
|
1075
1075
|
List all integrations owned by the account or product
|
|
1076
1076
|
|
|
@@ -1086,7 +1086,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1086
1086
|
|
|
1087
1087
|
### getUserInfo
|
|
1088
1088
|
|
|
1089
|
-
[src/Particle.js:1128-1130](https://github.com/particle-iot/particle-api-js/blob/
|
|
1089
|
+
[src/Particle.js:1128-1130](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1128-L1130 "Source code on GitHub")
|
|
1090
1090
|
|
|
1091
1091
|
Get details about the current user
|
|
1092
1092
|
|
|
@@ -1101,7 +1101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1101
1101
|
|
|
1102
1102
|
### setUserInfo
|
|
1103
1103
|
|
|
1104
|
-
[src/Particle.js:1141-1144](https://github.com/particle-iot/particle-api-js/blob/
|
|
1104
|
+
[src/Particle.js:1141-1144](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1141-L1144 "Source code on GitHub")
|
|
1105
1105
|
|
|
1106
1106
|
Set details on the current user
|
|
1107
1107
|
|
|
@@ -1117,7 +1117,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1117
1117
|
|
|
1118
1118
|
### changeUsername
|
|
1119
1119
|
|
|
1120
|
-
[src/Particle.js:1157-1165](https://github.com/particle-iot/particle-api-js/blob/
|
|
1120
|
+
[src/Particle.js:1157-1165](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1157-L1165 "Source code on GitHub")
|
|
1121
1121
|
|
|
1122
1122
|
Change username (i.e, email)
|
|
1123
1123
|
|
|
@@ -1135,7 +1135,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1135
1135
|
|
|
1136
1136
|
### changeUserPassword
|
|
1137
1137
|
|
|
1138
|
-
[src/Particle.js:1178-1186](https://github.com/particle-iot/particle-api-js/blob/
|
|
1138
|
+
[src/Particle.js:1178-1186](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1178-L1186 "Source code on GitHub")
|
|
1139
1139
|
|
|
1140
1140
|
Change user's password
|
|
1141
1141
|
|
|
@@ -1153,7 +1153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1153
1153
|
|
|
1154
1154
|
### listSIMs
|
|
1155
1155
|
|
|
1156
|
-
[src/Particle.js:1202-1206](https://github.com/particle-iot/particle-api-js/blob/
|
|
1156
|
+
[src/Particle.js:1202-1206](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1202-L1206 "Source code on GitHub")
|
|
1157
1157
|
|
|
1158
1158
|
List SIM cards owned by a user or product
|
|
1159
1159
|
|
|
@@ -1174,7 +1174,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1174
1174
|
|
|
1175
1175
|
### getSIMDataUsage
|
|
1176
1176
|
|
|
1177
|
-
[src/Particle.js:1218-1224](https://github.com/particle-iot/particle-api-js/blob/
|
|
1177
|
+
[src/Particle.js:1218-1224](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1218-L1224 "Source code on GitHub")
|
|
1178
1178
|
|
|
1179
1179
|
Get data usage for one SIM card for the current billing period
|
|
1180
1180
|
|
|
@@ -1191,7 +1191,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1191
1191
|
|
|
1192
1192
|
### getFleetDataUsage
|
|
1193
1193
|
|
|
1194
|
-
[src/Particle.js:1235-1242](https://github.com/particle-iot/particle-api-js/blob/
|
|
1194
|
+
[src/Particle.js:1235-1242](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1235-L1242 "Source code on GitHub")
|
|
1195
1195
|
|
|
1196
1196
|
Get data usage for all SIM cards in a product the current billing period
|
|
1197
1197
|
|
|
@@ -1207,7 +1207,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1207
1207
|
|
|
1208
1208
|
### checkSIM
|
|
1209
1209
|
|
|
1210
|
-
[src/Particle.js:1253-1255](https://github.com/particle-iot/particle-api-js/blob/
|
|
1210
|
+
[src/Particle.js:1253-1255](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1253-L1255 "Source code on GitHub")
|
|
1211
1211
|
|
|
1212
1212
|
Check SIM status
|
|
1213
1213
|
|
|
@@ -1223,7 +1223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1223
1223
|
|
|
1224
1224
|
### activateSIM
|
|
1225
1225
|
|
|
1226
|
-
[src/Particle.js:1270-1280](https://github.com/particle-iot/particle-api-js/blob/
|
|
1226
|
+
[src/Particle.js:1270-1280](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1270-L1280 "Source code on GitHub")
|
|
1227
1227
|
|
|
1228
1228
|
Activate and add SIM cards to an account or product
|
|
1229
1229
|
|
|
@@ -1243,7 +1243,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1243
1243
|
|
|
1244
1244
|
### deactivateSIM
|
|
1245
1245
|
|
|
1246
|
-
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/
|
|
1246
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
1247
1247
|
|
|
1248
1248
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1249
1249
|
|
|
@@ -1260,7 +1260,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1260
1260
|
|
|
1261
1261
|
### reactivateSIM
|
|
1262
1262
|
|
|
1263
|
-
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/
|
|
1263
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
1264
1264
|
|
|
1265
1265
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1266
1266
|
|
|
@@ -1278,7 +1278,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1278
1278
|
|
|
1279
1279
|
### updateSIM
|
|
1280
1280
|
|
|
1281
|
-
[src/Particle.js:1326-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
1281
|
+
[src/Particle.js:1326-1330](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1326-L1330 "Source code on GitHub")
|
|
1282
1282
|
|
|
1283
1283
|
Update SIM card data limit
|
|
1284
1284
|
|
|
@@ -1296,7 +1296,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1296
1296
|
|
|
1297
1297
|
### removeSIM
|
|
1298
1298
|
|
|
1299
|
-
[src/Particle.js:1342-1345](https://github.com/particle-iot/particle-api-js/blob/
|
|
1299
|
+
[src/Particle.js:1342-1345](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1342-L1345 "Source code on GitHub")
|
|
1300
1300
|
|
|
1301
1301
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1302
1302
|
|
|
@@ -1313,7 +1313,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1313
1313
|
|
|
1314
1314
|
### listBuildTargets
|
|
1315
1315
|
|
|
1316
|
-
[src/Particle.js:1356-1359](https://github.com/particle-iot/particle-api-js/blob/
|
|
1316
|
+
[src/Particle.js:1356-1359](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1356-L1359 "Source code on GitHub")
|
|
1317
1317
|
|
|
1318
1318
|
List valid build targets to be used for compiling
|
|
1319
1319
|
|
|
@@ -1329,7 +1329,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1329
1329
|
|
|
1330
1330
|
### listLibraries
|
|
1331
1331
|
|
|
1332
|
-
[src/Particle.js:1385-1402](https://github.com/particle-iot/particle-api-js/blob/
|
|
1332
|
+
[src/Particle.js:1385-1402](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1385-L1402 "Source code on GitHub")
|
|
1333
1333
|
|
|
1334
1334
|
List firmware libraries
|
|
1335
1335
|
|
|
@@ -1359,7 +1359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1359
1359
|
|
|
1360
1360
|
### getLibrary
|
|
1361
1361
|
|
|
1362
|
-
[src/Particle.js:1418-1426](https://github.com/particle-iot/particle-api-js/blob/
|
|
1362
|
+
[src/Particle.js:1418-1426](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1418-L1426 "Source code on GitHub")
|
|
1363
1363
|
|
|
1364
1364
|
Get firmware library details
|
|
1365
1365
|
|
|
@@ -1376,7 +1376,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1376
1376
|
|
|
1377
1377
|
### getLibraryVersions
|
|
1378
1378
|
|
|
1379
|
-
[src/Particle.js:1439-1447](https://github.com/particle-iot/particle-api-js/blob/
|
|
1379
|
+
[src/Particle.js:1439-1447](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1439-L1447 "Source code on GitHub")
|
|
1380
1380
|
|
|
1381
1381
|
Firmware library details for each version
|
|
1382
1382
|
|
|
@@ -1394,7 +1394,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1394
1394
|
|
|
1395
1395
|
### contributeLibrary
|
|
1396
1396
|
|
|
1397
|
-
[src/Particle.js:1459-1472](https://github.com/particle-iot/particle-api-js/blob/
|
|
1397
|
+
[src/Particle.js:1459-1472](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1459-L1472 "Source code on GitHub")
|
|
1398
1398
|
|
|
1399
1399
|
Contribute a new library version from a compressed archive
|
|
1400
1400
|
|
|
@@ -1411,7 +1411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1411
1411
|
|
|
1412
1412
|
### publishLibrary
|
|
1413
1413
|
|
|
1414
|
-
[src/Particle.js:1483-1492](https://github.com/particle-iot/particle-api-js/blob/
|
|
1414
|
+
[src/Particle.js:1483-1492](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1483-L1492 "Source code on GitHub")
|
|
1415
1415
|
|
|
1416
1416
|
Publish the latest version of a library to the public
|
|
1417
1417
|
|
|
@@ -1427,7 +1427,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1427
1427
|
|
|
1428
1428
|
### deleteLibrary
|
|
1429
1429
|
|
|
1430
|
-
[src/Particle.js:1504-1512](https://github.com/particle-iot/particle-api-js/blob/
|
|
1430
|
+
[src/Particle.js:1504-1512](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1504-L1512 "Source code on GitHub")
|
|
1431
1431
|
|
|
1432
1432
|
Delete one version of a library or an entire private library
|
|
1433
1433
|
|
|
@@ -1444,7 +1444,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1444
1444
|
|
|
1445
1445
|
### downloadFile
|
|
1446
1446
|
|
|
1447
|
-
[src/Particle.js:1522-1524](https://github.com/particle-iot/particle-api-js/blob/
|
|
1447
|
+
[src/Particle.js:1522-1524](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1522-L1524 "Source code on GitHub")
|
|
1448
1448
|
|
|
1449
1449
|
Download an external file that may not be on the API
|
|
1450
1450
|
|
|
@@ -1459,7 +1459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1459
1459
|
|
|
1460
1460
|
### listOAuthClients
|
|
1461
1461
|
|
|
1462
|
-
[src/Particle.js:1535-1538](https://github.com/particle-iot/particle-api-js/blob/
|
|
1462
|
+
[src/Particle.js:1535-1538](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1535-L1538 "Source code on GitHub")
|
|
1463
1463
|
|
|
1464
1464
|
List OAuth client created by the account
|
|
1465
1465
|
|
|
@@ -1475,7 +1475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1475
1475
|
|
|
1476
1476
|
### createOAuthClient
|
|
1477
1477
|
|
|
1478
|
-
[src/Particle.js:1553-1557](https://github.com/particle-iot/particle-api-js/blob/
|
|
1478
|
+
[src/Particle.js:1553-1557](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1553-L1557 "Source code on GitHub")
|
|
1479
1479
|
|
|
1480
1480
|
Create an OAuth client
|
|
1481
1481
|
|
|
@@ -1495,7 +1495,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1495
1495
|
|
|
1496
1496
|
### updateOAuthClient
|
|
1497
1497
|
|
|
1498
|
-
[src/Particle.js:1571-1575](https://github.com/particle-iot/particle-api-js/blob/
|
|
1498
|
+
[src/Particle.js:1571-1575](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1571-L1575 "Source code on GitHub")
|
|
1499
1499
|
|
|
1500
1500
|
Update an OAuth client
|
|
1501
1501
|
|
|
@@ -1514,7 +1514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1514
1514
|
|
|
1515
1515
|
### deleteOAuthClient
|
|
1516
1516
|
|
|
1517
|
-
[src/Particle.js:1587-1590](https://github.com/particle-iot/particle-api-js/blob/
|
|
1517
|
+
[src/Particle.js:1587-1590](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1587-L1590 "Source code on GitHub")
|
|
1518
1518
|
|
|
1519
1519
|
Delete an OAuth client
|
|
1520
1520
|
|
|
@@ -1531,7 +1531,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1531
1531
|
|
|
1532
1532
|
### listProducts
|
|
1533
1533
|
|
|
1534
|
-
[src/Particle.js:1600-1602](https://github.com/particle-iot/particle-api-js/blob/
|
|
1534
|
+
[src/Particle.js:1600-1602](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1600-L1602 "Source code on GitHub")
|
|
1535
1535
|
|
|
1536
1536
|
List products the account has access to
|
|
1537
1537
|
|
|
@@ -1546,7 +1546,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1546
1546
|
|
|
1547
1547
|
### getProduct
|
|
1548
1548
|
|
|
1549
|
-
[src/Particle.js:1613-1615](https://github.com/particle-iot/particle-api-js/blob/
|
|
1549
|
+
[src/Particle.js:1613-1615](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1613-L1615 "Source code on GitHub")
|
|
1550
1550
|
|
|
1551
1551
|
Get detailed information about a product
|
|
1552
1552
|
|
|
@@ -1562,7 +1562,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1562
1562
|
|
|
1563
1563
|
### listProductFirmware
|
|
1564
1564
|
|
|
1565
|
-
[src/Particle.js:1626-1628](https://github.com/particle-iot/particle-api-js/blob/
|
|
1565
|
+
[src/Particle.js:1626-1628](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1626-L1628 "Source code on GitHub")
|
|
1566
1566
|
|
|
1567
1567
|
List product firmware versions
|
|
1568
1568
|
|
|
@@ -1578,7 +1578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1578
1578
|
|
|
1579
1579
|
### uploadProductFirmware
|
|
1580
1580
|
|
|
1581
|
-
[src/Particle.js:1644-1660](https://github.com/particle-iot/particle-api-js/blob/
|
|
1581
|
+
[src/Particle.js:1644-1660](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1644-L1660 "Source code on GitHub")
|
|
1582
1582
|
|
|
1583
1583
|
List product firmware versions
|
|
1584
1584
|
|
|
@@ -1599,7 +1599,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1599
1599
|
|
|
1600
1600
|
### getProductFirmware
|
|
1601
1601
|
|
|
1602
|
-
[src/Particle.js:1672-1679](https://github.com/particle-iot/particle-api-js/blob/
|
|
1602
|
+
[src/Particle.js:1672-1679](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1672-L1679 "Source code on GitHub")
|
|
1603
1603
|
|
|
1604
1604
|
Get information about a product firmware version
|
|
1605
1605
|
|
|
@@ -1616,7 +1616,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1616
1616
|
|
|
1617
1617
|
### updateProductFirmware
|
|
1618
1618
|
|
|
1619
|
-
[src/Particle.js:1693-1696](https://github.com/particle-iot/particle-api-js/blob/
|
|
1619
|
+
[src/Particle.js:1693-1696](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1693-L1696 "Source code on GitHub")
|
|
1620
1620
|
|
|
1621
1621
|
Update information for a product firmware version
|
|
1622
1622
|
|
|
@@ -1635,7 +1635,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1635
1635
|
|
|
1636
1636
|
### downloadProductFirmware
|
|
1637
1637
|
|
|
1638
|
-
[src/Particle.js:1708-1717](https://github.com/particle-iot/particle-api-js/blob/
|
|
1638
|
+
[src/Particle.js:1708-1717](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1708-L1717 "Source code on GitHub")
|
|
1639
1639
|
|
|
1640
1640
|
Download a product firmware binary
|
|
1641
1641
|
|
|
@@ -1652,7 +1652,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1652
1652
|
|
|
1653
1653
|
### releaseProductFirmware
|
|
1654
1654
|
|
|
1655
|
-
[src/Particle.js:1729-1732](https://github.com/particle-iot/particle-api-js/blob/
|
|
1655
|
+
[src/Particle.js:1729-1732](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1729-L1732 "Source code on GitHub")
|
|
1656
1656
|
|
|
1657
1657
|
Release a product firmware version as the default version
|
|
1658
1658
|
|
|
@@ -1669,7 +1669,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1669
1669
|
|
|
1670
1670
|
### listTeamMembers
|
|
1671
1671
|
|
|
1672
|
-
[src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/
|
|
1672
|
+
[src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1743-L1750 "Source code on GitHub")
|
|
1673
1673
|
|
|
1674
1674
|
List product team members
|
|
1675
1675
|
|
|
@@ -1685,7 +1685,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1685
1685
|
|
|
1686
1686
|
### inviteTeamMember
|
|
1687
1687
|
|
|
1688
|
-
[src/Particle.js:1762-1770](https://github.com/particle-iot/particle-api-js/blob/
|
|
1688
|
+
[src/Particle.js:1762-1770](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1762-L1770 "Source code on GitHub")
|
|
1689
1689
|
|
|
1690
1690
|
Invite Particle user to a product team
|
|
1691
1691
|
|
|
@@ -1702,7 +1702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1702
1702
|
|
|
1703
1703
|
### removeTeamMember
|
|
1704
1704
|
|
|
1705
|
-
[src/Particle.js:1782-1789](https://github.com/particle-iot/particle-api-js/blob/
|
|
1705
|
+
[src/Particle.js:1782-1789](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1782-L1789 "Source code on GitHub")
|
|
1706
1706
|
|
|
1707
1707
|
Remove Particle user to a product team
|
|
1708
1708
|
|
|
@@ -1719,7 +1719,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1719
1719
|
|
|
1720
1720
|
### lookupSerialNumber
|
|
1721
1721
|
|
|
1722
|
-
[src/Particle.js:1800-1807](https://github.com/particle-iot/particle-api-js/blob/
|
|
1722
|
+
[src/Particle.js:1800-1807](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1800-L1807 "Source code on GitHub")
|
|
1723
1723
|
|
|
1724
1724
|
Fetch details about a serial number
|
|
1725
1725
|
|
|
@@ -1735,7 +1735,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1735
1735
|
|
|
1736
1736
|
### createMeshNetwork
|
|
1737
1737
|
|
|
1738
|
-
[src/Particle.js:1820-1828](https://github.com/particle-iot/particle-api-js/blob/
|
|
1738
|
+
[src/Particle.js:1820-1828](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1820-L1828 "Source code on GitHub")
|
|
1739
1739
|
|
|
1740
1740
|
Create a mesh network
|
|
1741
1741
|
|
|
@@ -1753,7 +1753,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1753
1753
|
|
|
1754
1754
|
### removeMeshNetwork
|
|
1755
1755
|
|
|
1756
|
-
[src/Particle.js:1839-1841](https://github.com/particle-iot/particle-api-js/blob/
|
|
1756
|
+
[src/Particle.js:1839-1841](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1839-L1841 "Source code on GitHub")
|
|
1757
1757
|
|
|
1758
1758
|
Remove a mesh network.
|
|
1759
1759
|
|
|
@@ -1769,7 +1769,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1769
1769
|
|
|
1770
1770
|
### listMeshNetworks
|
|
1771
1771
|
|
|
1772
|
-
[src/Particle.js:1853-1856](https://github.com/particle-iot/particle-api-js/blob/
|
|
1772
|
+
[src/Particle.js:1853-1856](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1853-L1856 "Source code on GitHub")
|
|
1773
1773
|
|
|
1774
1774
|
List all mesh networks
|
|
1775
1775
|
|
|
@@ -1786,7 +1786,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1786
1786
|
|
|
1787
1787
|
### getMeshNetwork
|
|
1788
1788
|
|
|
1789
|
-
[src/Particle.js:1867-1869](https://github.com/particle-iot/particle-api-js/blob/
|
|
1789
|
+
[src/Particle.js:1867-1869](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1867-L1869 "Source code on GitHub")
|
|
1790
1790
|
|
|
1791
1791
|
Get information about a mesh network.
|
|
1792
1792
|
|
|
@@ -1802,7 +1802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1802
1802
|
|
|
1803
1803
|
### updateMeshNetwork
|
|
1804
1804
|
|
|
1805
|
-
[src/Particle.js:1882-1890](https://github.com/particle-iot/particle-api-js/blob/
|
|
1805
|
+
[src/Particle.js:1882-1890](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1882-L1890 "Source code on GitHub")
|
|
1806
1806
|
|
|
1807
1807
|
Modify a mesh network.
|
|
1808
1808
|
|
|
@@ -1820,7 +1820,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1820
1820
|
|
|
1821
1821
|
### addMeshNetworkDevice
|
|
1822
1822
|
|
|
1823
|
-
[src/Particle.js:1902-1911](https://github.com/particle-iot/particle-api-js/blob/
|
|
1823
|
+
[src/Particle.js:1902-1911](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1902-L1911 "Source code on GitHub")
|
|
1824
1824
|
|
|
1825
1825
|
Add a device to a mesh network.
|
|
1826
1826
|
|
|
@@ -1837,7 +1837,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1837
1837
|
|
|
1838
1838
|
### removeMeshNetworkDevice
|
|
1839
1839
|
|
|
1840
|
-
[src/Particle.js:1923-1939](https://github.com/particle-iot/particle-api-js/blob/
|
|
1840
|
+
[src/Particle.js:1923-1939](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1923-L1939 "Source code on GitHub")
|
|
1841
1841
|
|
|
1842
1842
|
Remove a device from a mesh network.
|
|
1843
1843
|
|
|
@@ -1854,7 +1854,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1854
1854
|
|
|
1855
1855
|
### listMeshNetworkDevices
|
|
1856
1856
|
|
|
1857
|
-
[src/Particle.js:1953-1962](https://github.com/particle-iot/particle-api-js/blob/
|
|
1857
|
+
[src/Particle.js:1953-1962](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1953-L1962 "Source code on GitHub")
|
|
1858
1858
|
|
|
1859
1859
|
List all devices of a mesh network.
|
|
1860
1860
|
|
|
@@ -1873,7 +1873,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1873
1873
|
|
|
1874
1874
|
### getProductConfiguration
|
|
1875
1875
|
|
|
1876
|
-
[src/Particle.js:1973-1980](https://github.com/particle-iot/particle-api-js/blob/
|
|
1876
|
+
[src/Particle.js:1973-1980](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1973-L1980 "Source code on GitHub")
|
|
1877
1877
|
|
|
1878
1878
|
Get product configuration
|
|
1879
1879
|
|
|
@@ -1889,7 +1889,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1889
1889
|
|
|
1890
1890
|
### getProductConfigurationSchema
|
|
1891
1891
|
|
|
1892
|
-
[src/Particle.js:1991-1999](https://github.com/particle-iot/particle-api-js/blob/
|
|
1892
|
+
[src/Particle.js:1991-1999](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L1991-L1999 "Source code on GitHub")
|
|
1893
1893
|
|
|
1894
1894
|
Get product configuration schema
|
|
1895
1895
|
|
|
@@ -1905,7 +1905,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1905
1905
|
|
|
1906
1906
|
### getProductDeviceConfiguration
|
|
1907
1907
|
|
|
1908
|
-
[src/Particle.js:2011-2018](https://github.com/particle-iot/particle-api-js/blob/
|
|
1908
|
+
[src/Particle.js:2011-2018](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2011-L2018 "Source code on GitHub")
|
|
1909
1909
|
|
|
1910
1910
|
Get product device's configuration
|
|
1911
1911
|
|
|
@@ -1922,7 +1922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1922
1922
|
|
|
1923
1923
|
### getProductDeviceConfigurationSchema
|
|
1924
1924
|
|
|
1925
|
-
[src/Particle.js:2030-2038](https://github.com/particle-iot/particle-api-js/blob/
|
|
1925
|
+
[src/Particle.js:2030-2038](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2030-L2038 "Source code on GitHub")
|
|
1926
1926
|
|
|
1927
1927
|
Get product device's configuration schema
|
|
1928
1928
|
|
|
@@ -1939,7 +1939,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1939
1939
|
|
|
1940
1940
|
### setProductConfiguration
|
|
1941
1941
|
|
|
1942
|
-
[src/Particle.js:2050-2058](https://github.com/particle-iot/particle-api-js/blob/
|
|
1942
|
+
[src/Particle.js:2050-2058](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2050-L2058 "Source code on GitHub")
|
|
1943
1943
|
|
|
1944
1944
|
Set product configuration
|
|
1945
1945
|
|
|
@@ -1956,7 +1956,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1956
1956
|
|
|
1957
1957
|
### setProductDeviceConfiguration
|
|
1958
1958
|
|
|
1959
|
-
[src/Particle.js:2071-2079](https://github.com/particle-iot/particle-api-js/blob/
|
|
1959
|
+
[src/Particle.js:2071-2079](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2071-L2079 "Source code on GitHub")
|
|
1960
1960
|
|
|
1961
1961
|
Set product configuration for a specific device within the product
|
|
1962
1962
|
|
|
@@ -1974,7 +1974,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1974
1974
|
|
|
1975
1975
|
### getProductLocations
|
|
1976
1976
|
|
|
1977
|
-
[src/Particle.js:2098-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
1977
|
+
[src/Particle.js:2098-2115](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2098-L2115 "Source code on GitHub")
|
|
1978
1978
|
|
|
1979
1979
|
Query location for devices within a product
|
|
1980
1980
|
|
|
@@ -1998,7 +1998,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1998
1998
|
|
|
1999
1999
|
### getProductDeviceLocations
|
|
2000
2000
|
|
|
2001
|
-
[src/Particle.js:2132-2144](https://github.com/particle-iot/particle-api-js/blob/
|
|
2001
|
+
[src/Particle.js:2132-2144](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2132-L2144 "Source code on GitHub")
|
|
2002
2002
|
|
|
2003
2003
|
Query location for one device within a product
|
|
2004
2004
|
|
|
@@ -2018,7 +2018,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2018
2018
|
|
|
2019
2019
|
### executeLogic
|
|
2020
2020
|
|
|
2021
|
-
[src/Particle.js:2160-2168](https://github.com/particle-iot/particle-api-js/blob/
|
|
2021
|
+
[src/Particle.js:2160-2168](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2160-L2168 "Source code on GitHub")
|
|
2022
2022
|
|
|
2023
2023
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
2024
2024
|
|
|
@@ -2037,7 +2037,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2037
2037
|
|
|
2038
2038
|
### createLogicFunction
|
|
2039
2039
|
|
|
2040
|
-
[src/Particle.js:2188-2196](https://github.com/particle-iot/particle-api-js/blob/
|
|
2040
|
+
[src/Particle.js:2188-2196](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2188-L2196 "Source code on GitHub")
|
|
2041
2041
|
|
|
2042
2042
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2043
2043
|
|
|
@@ -2060,7 +2060,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2060
2060
|
|
|
2061
2061
|
### getLogicFunction
|
|
2062
2062
|
|
|
2063
|
-
[src/Particle.js:2210-2217](https://github.com/particle-iot/particle-api-js/blob/
|
|
2063
|
+
[src/Particle.js:2210-2217](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2210-L2217 "Source code on GitHub")
|
|
2064
2064
|
|
|
2065
2065
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2066
2066
|
|
|
@@ -2077,7 +2077,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2077
2077
|
|
|
2078
2078
|
### updateLogicFunction
|
|
2079
2079
|
|
|
2080
|
-
[src/Particle.js:2234-2242](https://github.com/particle-iot/particle-api-js/blob/
|
|
2080
|
+
[src/Particle.js:2234-2242](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2234-L2242 "Source code on GitHub")
|
|
2081
2081
|
|
|
2082
2082
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2083
2083
|
|
|
@@ -2097,7 +2097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2097
2097
|
|
|
2098
2098
|
### deleteLogicFunction
|
|
2099
2099
|
|
|
2100
|
-
[src/Particle.js:2256-2263](https://github.com/particle-iot/particle-api-js/blob/
|
|
2100
|
+
[src/Particle.js:2256-2263](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2256-L2263 "Source code on GitHub")
|
|
2101
2101
|
|
|
2102
2102
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2103
2103
|
|
|
@@ -2114,7 +2114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2114
2114
|
|
|
2115
2115
|
### listLogicFunctions
|
|
2116
2116
|
|
|
2117
|
-
[src/Particle.js:2277-2287](https://github.com/particle-iot/particle-api-js/blob/
|
|
2117
|
+
[src/Particle.js:2277-2287](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2277-L2287 "Source code on GitHub")
|
|
2118
2118
|
|
|
2119
2119
|
Lists all logic functions in the specified organization or sandbox.
|
|
2120
2120
|
|
|
@@ -2131,7 +2131,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2131
2131
|
|
|
2132
2132
|
### listLogicRuns
|
|
2133
2133
|
|
|
2134
|
-
[src/Particle.js:2301-2308](https://github.com/particle-iot/particle-api-js/blob/
|
|
2134
|
+
[src/Particle.js:2301-2308](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2301-L2308 "Source code on GitHub")
|
|
2135
2135
|
|
|
2136
2136
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2137
2137
|
|
|
@@ -2148,7 +2148,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2148
2148
|
|
|
2149
2149
|
### getLogicRun
|
|
2150
2150
|
|
|
2151
|
-
[src/Particle.js:2323-2330](https://github.com/particle-iot/particle-api-js/blob/
|
|
2151
|
+
[src/Particle.js:2323-2330](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2323-L2330 "Source code on GitHub")
|
|
2152
2152
|
|
|
2153
2153
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2154
2154
|
|
|
@@ -2166,7 +2166,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2166
2166
|
|
|
2167
2167
|
### getLogicRunLogs
|
|
2168
2168
|
|
|
2169
|
-
[src/Particle.js:2345-2352](https://github.com/particle-iot/particle-api-js/blob/
|
|
2169
|
+
[src/Particle.js:2345-2352](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2345-L2352 "Source code on GitHub")
|
|
2170
2170
|
|
|
2171
2171
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2172
2172
|
|
|
@@ -2184,7 +2184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2184
2184
|
|
|
2185
2185
|
### createLedger
|
|
2186
2186
|
|
|
2187
|
-
[src/Particle.js:2366-2374](https://github.com/particle-iot/particle-api-js/blob/
|
|
2187
|
+
[src/Particle.js:2366-2374](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2366-L2374 "Source code on GitHub")
|
|
2188
2188
|
|
|
2189
2189
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2190
2190
|
|
|
@@ -2201,7 +2201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2201
2201
|
|
|
2202
2202
|
### getLedger
|
|
2203
2203
|
|
|
2204
|
-
[src/Particle.js:2388-2395](https://github.com/particle-iot/particle-api-js/blob/
|
|
2204
|
+
[src/Particle.js:2388-2395](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2388-L2395 "Source code on GitHub")
|
|
2205
2205
|
|
|
2206
2206
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2207
2207
|
|
|
@@ -2218,7 +2218,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2218
2218
|
|
|
2219
2219
|
### updateLedger
|
|
2220
2220
|
|
|
2221
|
-
[src/Particle.js:2410-2418](https://github.com/particle-iot/particle-api-js/blob/
|
|
2221
|
+
[src/Particle.js:2410-2418](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2410-L2418 "Source code on GitHub")
|
|
2222
2222
|
|
|
2223
2223
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2224
2224
|
|
|
@@ -2236,7 +2236,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2236
2236
|
|
|
2237
2237
|
### archiveLedger
|
|
2238
2238
|
|
|
2239
|
-
[src/Particle.js:2432-2439](https://github.com/particle-iot/particle-api-js/blob/
|
|
2239
|
+
[src/Particle.js:2432-2439](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2432-L2439 "Source code on GitHub")
|
|
2240
2240
|
|
|
2241
2241
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2242
2242
|
|
|
@@ -2253,7 +2253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2253
2253
|
|
|
2254
2254
|
### Scope
|
|
2255
2255
|
|
|
2256
|
-
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/
|
|
2256
|
+
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2460-L2473 "Source code on GitHub")
|
|
2257
2257
|
|
|
2258
2258
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2259
2259
|
|
|
@@ -2271,7 +2271,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2271
2271
|
|
|
2272
2272
|
### listLedgers
|
|
2273
2273
|
|
|
2274
|
-
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/
|
|
2274
|
+
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2460-L2473 "Source code on GitHub")
|
|
2275
2275
|
|
|
2276
2276
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2277
2277
|
|
|
@@ -2291,7 +2291,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2291
2291
|
|
|
2292
2292
|
### getLedgerInstance
|
|
2293
2293
|
|
|
2294
|
-
[src/Particle.js:2488-2495](https://github.com/particle-iot/particle-api-js/blob/
|
|
2294
|
+
[src/Particle.js:2488-2495](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2488-L2495 "Source code on GitHub")
|
|
2295
2295
|
|
|
2296
2296
|
Get ledger instance data.
|
|
2297
2297
|
|
|
@@ -2309,7 +2309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2309
2309
|
|
|
2310
2310
|
### SetMode
|
|
2311
2311
|
|
|
2312
|
-
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/
|
|
2312
|
+
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2516-L2527 "Source code on GitHub")
|
|
2313
2313
|
|
|
2314
2314
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2315
2315
|
|
|
@@ -2327,7 +2327,7 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2327
2327
|
|
|
2328
2328
|
### setLedgerInstance
|
|
2329
2329
|
|
|
2330
|
-
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/
|
|
2330
|
+
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2516-L2527 "Source code on GitHub")
|
|
2331
2331
|
|
|
2332
2332
|
Set ledger instance data.
|
|
2333
2333
|
|
|
@@ -2347,7 +2347,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2347
2347
|
|
|
2348
2348
|
### deleteLedgerInstance
|
|
2349
2349
|
|
|
2350
|
-
[src/Particle.js:2542-2549](https://github.com/particle-iot/particle-api-js/blob/
|
|
2350
|
+
[src/Particle.js:2542-2549](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2542-L2549 "Source code on GitHub")
|
|
2351
2351
|
|
|
2352
2352
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2353
2353
|
|
|
@@ -2365,7 +2365,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2365
2365
|
|
|
2366
2366
|
### listLedgerInstances
|
|
2367
2367
|
|
|
2368
|
-
[src/Particle.js:2565-2576](https://github.com/particle-iot/particle-api-js/blob/
|
|
2368
|
+
[src/Particle.js:2565-2576](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2565-L2576 "Source code on GitHub")
|
|
2369
2369
|
|
|
2370
2370
|
Lists ledger instances in the specified organization or sandbox.
|
|
2371
2371
|
|
|
@@ -2384,7 +2384,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2384
2384
|
|
|
2385
2385
|
### listLedgerInstanceVersions
|
|
2386
2386
|
|
|
2387
|
-
[src/Particle.js:2593-2604](https://github.com/particle-iot/particle-api-js/blob/
|
|
2387
|
+
[src/Particle.js:2593-2604](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2593-L2604 "Source code on GitHub")
|
|
2388
2388
|
|
|
2389
2389
|
List ledger instance versions
|
|
2390
2390
|
|
|
@@ -2404,7 +2404,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2404
2404
|
|
|
2405
2405
|
### getLedgerInstanceVersion
|
|
2406
2406
|
|
|
2407
|
-
[src/Particle.js:2620-2627](https://github.com/particle-iot/particle-api-js/blob/
|
|
2407
|
+
[src/Particle.js:2620-2627](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2620-L2627 "Source code on GitHub")
|
|
2408
2408
|
|
|
2409
2409
|
Get specific ledger instance version
|
|
2410
2410
|
|
|
@@ -2423,7 +2423,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2423
2423
|
|
|
2424
2424
|
### listDeviceOsVersions
|
|
2425
2425
|
|
|
2426
|
-
[src/Particle.js:2643-2658](https://github.com/particle-iot/particle-api-js/blob/
|
|
2426
|
+
[src/Particle.js:2643-2658](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2643-L2658 "Source code on GitHub")
|
|
2427
2427
|
|
|
2428
2428
|
List Device OS versions
|
|
2429
2429
|
|
|
@@ -2442,7 +2442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2442
2442
|
|
|
2443
2443
|
### getDeviceOsVersion
|
|
2444
2444
|
|
|
2445
|
-
[src/Particle.js:2672-2681](https://github.com/particle-iot/particle-api-js/blob/
|
|
2445
|
+
[src/Particle.js:2672-2681](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2672-L2681 "Source code on GitHub")
|
|
2446
2446
|
|
|
2447
2447
|
Get a specific Device OS version
|
|
2448
2448
|
|
|
@@ -2459,7 +2459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2459
2459
|
|
|
2460
2460
|
### setDefaultAuth
|
|
2461
2461
|
|
|
2462
|
-
[src/Particle.js:2688-2694](https://github.com/particle-iot/particle-api-js/blob/
|
|
2462
|
+
[src/Particle.js:2688-2694](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2688-L2694 "Source code on GitHub")
|
|
2463
2463
|
|
|
2464
2464
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2465
2465
|
|
|
@@ -2472,7 +2472,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2472
2472
|
|
|
2473
2473
|
### get
|
|
2474
2474
|
|
|
2475
|
-
[src/Particle.js:2744-2748](https://github.com/particle-iot/particle-api-js/blob/
|
|
2475
|
+
[src/Particle.js:2744-2748](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2744-L2748 "Source code on GitHub")
|
|
2476
2476
|
|
|
2477
2477
|
Make a GET request
|
|
2478
2478
|
|
|
@@ -2489,7 +2489,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2489
2489
|
|
|
2490
2490
|
### head
|
|
2491
2491
|
|
|
2492
|
-
[src/Particle.js:2760-2764](https://github.com/particle-iot/particle-api-js/blob/
|
|
2492
|
+
[src/Particle.js:2760-2764](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2760-L2764 "Source code on GitHub")
|
|
2493
2493
|
|
|
2494
2494
|
Make a HEAD request
|
|
2495
2495
|
|
|
@@ -2506,7 +2506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2506
2506
|
|
|
2507
2507
|
### post
|
|
2508
2508
|
|
|
2509
|
-
[src/Particle.js:2776-2780](https://github.com/particle-iot/particle-api-js/blob/
|
|
2509
|
+
[src/Particle.js:2776-2780](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2776-L2780 "Source code on GitHub")
|
|
2510
2510
|
|
|
2511
2511
|
Make a POST request
|
|
2512
2512
|
|
|
@@ -2523,7 +2523,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2523
2523
|
|
|
2524
2524
|
### put
|
|
2525
2525
|
|
|
2526
|
-
[src/Particle.js:2793-2797](https://github.com/particle-iot/particle-api-js/blob/
|
|
2526
|
+
[src/Particle.js:2793-2797](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2793-L2797 "Source code on GitHub")
|
|
2527
2527
|
|
|
2528
2528
|
Make a PUT request
|
|
2529
2529
|
|
|
@@ -2541,7 +2541,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2541
2541
|
|
|
2542
2542
|
### delete
|
|
2543
2543
|
|
|
2544
|
-
[src/Particle.js:2809-2813](https://github.com/particle-iot/particle-api-js/blob/
|
|
2544
|
+
[src/Particle.js:2809-2813](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2809-L2813 "Source code on GitHub")
|
|
2545
2545
|
|
|
2546
2546
|
Make a DELETE request
|
|
2547
2547
|
|
|
@@ -2558,7 +2558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2558
2558
|
|
|
2559
2559
|
### request
|
|
2560
2560
|
|
|
2561
|
-
[src/Particle.js:2830-2834](https://github.com/particle-iot/particle-api-js/blob/
|
|
2561
|
+
[src/Particle.js:2830-2834](https://github.com/particle-iot/particle-api-js/blob/25c8d3c14a54e31e935b1fe65bdaf0b1a191911b/src/Particle.js#L2830-L2834 "Source code on GitHub")
|
|
2562
2562
|
|
|
2563
2563
|
**Parameters**
|
|
2564
2564
|
|