particle-api-js 11.1.0 → 11.1.2
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 +6 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +182 -134
- package/package.json +1 -1
- package/src/EventStream.js +3 -1
- package/src/Particle.js +22 -2
- package/test/EventStream.spec.js +1 -1
package/docs/api.md
CHANGED
|
@@ -4,6 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
- [Particle](#particle)
|
|
6
6
|
- [constructor](#constructor)
|
|
7
|
+
- [ToolContext](#toolcontext)
|
|
8
|
+
- [ProjectContext](#projectcontext)
|
|
9
|
+
- [setContext](#setcontext)
|
|
7
10
|
- [login](#login)
|
|
8
11
|
- [sendOtp](#sendotp)
|
|
9
12
|
- [enableMfa](#enablemfa)
|
|
@@ -139,7 +142,7 @@
|
|
|
139
142
|
|
|
140
143
|
## Particle
|
|
141
144
|
|
|
142
|
-
[src/Particle.js:19-
|
|
145
|
+
[src/Particle.js:19-2846](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L19-L2846 "Source code on GitHub")
|
|
143
146
|
|
|
144
147
|
Particle Cloud API wrapper.
|
|
145
148
|
|
|
@@ -155,7 +158,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
155
158
|
|
|
156
159
|
### constructor
|
|
157
160
|
|
|
158
|
-
[src/Particle.js:32-
|
|
161
|
+
[src/Particle.js:32-42](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L32-L42 "Source code on GitHub")
|
|
159
162
|
|
|
160
163
|
Contructor for the Cloud API wrapper.
|
|
161
164
|
|
|
@@ -170,9 +173,54 @@ Create a new Particle object and call methods below on it.
|
|
|
170
173
|
- `options.tokenDuration` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?**
|
|
171
174
|
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. If not specified here, will have to be added to every request
|
|
172
175
|
|
|
176
|
+
### ToolContext
|
|
177
|
+
|
|
178
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
179
|
+
|
|
180
|
+
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
181
|
+
|
|
182
|
+
**Parameters**
|
|
183
|
+
|
|
184
|
+
- `name`
|
|
185
|
+
- `context`
|
|
186
|
+
|
|
187
|
+
**Properties**
|
|
188
|
+
|
|
189
|
+
- `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
190
|
+
- `version` **([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))?**
|
|
191
|
+
- `components` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<Omit<ToolContext, `"components"`>>?**
|
|
192
|
+
|
|
193
|
+
### ProjectContext
|
|
194
|
+
|
|
195
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
196
|
+
|
|
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
|
+
|
|
199
|
+
**Parameters**
|
|
200
|
+
|
|
201
|
+
- `name`
|
|
202
|
+
- `context`
|
|
203
|
+
|
|
204
|
+
**Properties**
|
|
205
|
+
|
|
206
|
+
- `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
207
|
+
|
|
208
|
+
### setContext
|
|
209
|
+
|
|
210
|
+
[src/Particle.js:67-75](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L67-L75 "Source code on GitHub")
|
|
211
|
+
|
|
212
|
+
Allows setting a tool or project context which will be sent as headers with every request.
|
|
213
|
+
Tool- x-particle-tool
|
|
214
|
+
Project- x-particle-project
|
|
215
|
+
|
|
216
|
+
**Parameters**
|
|
217
|
+
|
|
218
|
+
- `name` **(`"tool"` \| `"project"`)**
|
|
219
|
+
- `context` **(ToolContext | ProjectContext | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))**
|
|
220
|
+
|
|
173
221
|
### login
|
|
174
222
|
|
|
175
|
-
[src/Particle.js:
|
|
223
|
+
[src/Particle.js:98-115](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L98-L115 "Source code on GitHub")
|
|
176
224
|
|
|
177
225
|
Login to Particle Cloud using an existing Particle acccount.
|
|
178
226
|
|
|
@@ -189,7 +237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
189
237
|
|
|
190
238
|
### sendOtp
|
|
191
239
|
|
|
192
|
-
[src/Particle.js:
|
|
240
|
+
[src/Particle.js:126-142](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L126-L142 "Source code on GitHub")
|
|
193
241
|
|
|
194
242
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
195
243
|
|
|
@@ -205,7 +253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
205
253
|
|
|
206
254
|
### enableMfa
|
|
207
255
|
|
|
208
|
-
[src/Particle.js:
|
|
256
|
+
[src/Particle.js:152-154](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L152-L154 "Source code on GitHub")
|
|
209
257
|
|
|
210
258
|
Enable MFA on the currently logged in user
|
|
211
259
|
|
|
@@ -220,7 +268,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
220
268
|
|
|
221
269
|
### confirmMfa
|
|
222
270
|
|
|
223
|
-
[src/Particle.js:
|
|
271
|
+
[src/Particle.js:167-181](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L167-L181 "Source code on GitHub")
|
|
224
272
|
|
|
225
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.
|
|
226
274
|
|
|
@@ -238,7 +286,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
238
286
|
|
|
239
287
|
### disableMfa
|
|
240
288
|
|
|
241
|
-
[src/Particle.js:
|
|
289
|
+
[src/Particle.js:192-200](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L192-L200 "Source code on GitHub")
|
|
242
290
|
|
|
243
291
|
Disable MFA for the user.
|
|
244
292
|
|
|
@@ -254,7 +302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
254
302
|
|
|
255
303
|
### createCustomer
|
|
256
304
|
|
|
257
|
-
[src/Particle.js:
|
|
305
|
+
[src/Particle.js:212-228](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L212-L228 "Source code on GitHub")
|
|
258
306
|
|
|
259
307
|
Create Customer for Product.
|
|
260
308
|
|
|
@@ -271,7 +319,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
271
319
|
|
|
272
320
|
### loginAsClientOwner
|
|
273
321
|
|
|
274
|
-
[src/Particle.js:
|
|
322
|
+
[src/Particle.js:237-251](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L237-L251 "Source code on GitHub")
|
|
275
323
|
|
|
276
324
|
Login to Particle Cloud using an OAuth client.
|
|
277
325
|
|
|
@@ -285,7 +333,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
285
333
|
|
|
286
334
|
### createUser
|
|
287
335
|
|
|
288
|
-
[src/Particle.js:
|
|
336
|
+
[src/Particle.js:264-276](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L264-L276 "Source code on GitHub")
|
|
289
337
|
|
|
290
338
|
Create a user account for the Particle Cloud
|
|
291
339
|
|
|
@@ -303,7 +351,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
303
351
|
|
|
304
352
|
### verifyUser
|
|
305
353
|
|
|
306
|
-
[src/Particle.js:
|
|
354
|
+
[src/Particle.js:286-293](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L286-L293 "Source code on GitHub")
|
|
307
355
|
|
|
308
356
|
Verify new user account via verification email
|
|
309
357
|
|
|
@@ -318,7 +366,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
318
366
|
|
|
319
367
|
### resetPassword
|
|
320
368
|
|
|
321
|
-
[src/Particle.js:
|
|
369
|
+
[src/Particle.js:303-310](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L303-L310 "Source code on GitHub")
|
|
322
370
|
|
|
323
371
|
Send reset password email for a Particle Cloud user account
|
|
324
372
|
|
|
@@ -333,7 +381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
333
381
|
|
|
334
382
|
### deleteAccessToken
|
|
335
383
|
|
|
336
|
-
[src/Particle.js:
|
|
384
|
+
[src/Particle.js:320-326](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L320-L326 "Source code on GitHub")
|
|
337
385
|
|
|
338
386
|
Revoke an access token
|
|
339
387
|
|
|
@@ -348,7 +396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
348
396
|
|
|
349
397
|
### deleteCurrentAccessToken
|
|
350
398
|
|
|
351
|
-
[src/Particle.js:
|
|
399
|
+
[src/Particle.js:336-343](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L336-L343 "Source code on GitHub")
|
|
352
400
|
|
|
353
401
|
Revoke the current session access token
|
|
354
402
|
|
|
@@ -363,7 +411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
363
411
|
|
|
364
412
|
### deleteActiveAccessTokens
|
|
365
413
|
|
|
366
|
-
[src/Particle.js:
|
|
414
|
+
[src/Particle.js:353-360](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L353-L360 "Source code on GitHub")
|
|
367
415
|
|
|
368
416
|
Revoke all active access tokens
|
|
369
417
|
|
|
@@ -378,7 +426,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
378
426
|
|
|
379
427
|
### deleteUser
|
|
380
428
|
|
|
381
|
-
[src/Particle.js:
|
|
429
|
+
[src/Particle.js:371-379](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L371-L379 "Source code on GitHub")
|
|
382
430
|
|
|
383
431
|
Delete the current user
|
|
384
432
|
|
|
@@ -394,7 +442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
394
442
|
|
|
395
443
|
### trackingIdentity
|
|
396
444
|
|
|
397
|
-
[src/Particle.js:
|
|
445
|
+
[src/Particle.js:391-399](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L391-L399 "Source code on GitHub")
|
|
398
446
|
|
|
399
447
|
Retrieves the information that is used to identify the current login for tracking.
|
|
400
448
|
|
|
@@ -411,7 +459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
411
459
|
|
|
412
460
|
### listDevices
|
|
413
461
|
|
|
414
|
-
[src/Particle.js:
|
|
462
|
+
[src/Particle.js:417-436](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L417-L436 "Source code on GitHub")
|
|
415
463
|
|
|
416
464
|
List devices claimed to the account or product
|
|
417
465
|
|
|
@@ -434,7 +482,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
434
482
|
|
|
435
483
|
### getDevice
|
|
436
484
|
|
|
437
|
-
[src/Particle.js:
|
|
485
|
+
[src/Particle.js:448-451](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L448-L451 "Source code on GitHub")
|
|
438
486
|
|
|
439
487
|
Get detailed informationa about a device
|
|
440
488
|
|
|
@@ -451,7 +499,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
451
499
|
|
|
452
500
|
### claimDevice
|
|
453
501
|
|
|
454
|
-
[src/Particle.js:
|
|
502
|
+
[src/Particle.js:463-474](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L463-L474 "Source code on GitHub")
|
|
455
503
|
|
|
456
504
|
Claim a device to the account. The device must be online and unclaimed.
|
|
457
505
|
|
|
@@ -468,7 +516,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
468
516
|
|
|
469
517
|
### addDeviceToProduct
|
|
470
518
|
|
|
471
|
-
[src/Particle.js:
|
|
519
|
+
[src/Particle.js:488-506](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L488-L506 "Source code on GitHub")
|
|
472
520
|
|
|
473
521
|
Add a device to a product or move device out of quarantine.
|
|
474
522
|
|
|
@@ -487,7 +535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
487
535
|
|
|
488
536
|
### removeDevice
|
|
489
537
|
|
|
490
|
-
[src/Particle.js:
|
|
538
|
+
[src/Particle.js:519-523](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L519-L523 "Source code on GitHub")
|
|
491
539
|
|
|
492
540
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
493
541
|
|
|
@@ -505,7 +553,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
505
553
|
|
|
506
554
|
### removeDeviceOwner
|
|
507
555
|
|
|
508
|
-
[src/Particle.js:
|
|
556
|
+
[src/Particle.js:535-538](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L535-L538 "Source code on GitHub")
|
|
509
557
|
|
|
510
558
|
Unclaim a product device its the owner, but keep it in the product
|
|
511
559
|
|
|
@@ -522,7 +570,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
522
570
|
|
|
523
571
|
### renameDevice
|
|
524
572
|
|
|
525
|
-
[src/Particle.js:
|
|
573
|
+
[src/Particle.js:551-553](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L551-L553 "Source code on GitHub")
|
|
526
574
|
|
|
527
575
|
Rename a device
|
|
528
576
|
|
|
@@ -540,7 +588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
540
588
|
|
|
541
589
|
### signalDevice
|
|
542
590
|
|
|
543
|
-
[src/Particle.js:
|
|
591
|
+
[src/Particle.js:566-568](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L566-L568 "Source code on GitHub")
|
|
544
592
|
|
|
545
593
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
546
594
|
|
|
@@ -558,7 +606,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
558
606
|
|
|
559
607
|
### setDeviceNotes
|
|
560
608
|
|
|
561
|
-
[src/Particle.js:
|
|
609
|
+
[src/Particle.js:581-583](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L581-L583 "Source code on GitHub")
|
|
562
610
|
|
|
563
611
|
Store some notes about device
|
|
564
612
|
|
|
@@ -576,7 +624,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
576
624
|
|
|
577
625
|
### markAsDevelopmentDevice
|
|
578
626
|
|
|
579
|
-
[src/Particle.js:
|
|
627
|
+
[src/Particle.js:596-598](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L596-L598 "Source code on GitHub")
|
|
580
628
|
|
|
581
629
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
582
630
|
|
|
@@ -594,7 +642,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
594
642
|
|
|
595
643
|
### lockDeviceProductFirmware
|
|
596
644
|
|
|
597
|
-
[src/Particle.js:
|
|
645
|
+
[src/Particle.js:612-614](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L612-L614 "Source code on GitHub")
|
|
598
646
|
|
|
599
647
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
600
648
|
|
|
@@ -613,7 +661,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
613
661
|
|
|
614
662
|
### unlockDeviceProductFirmware
|
|
615
663
|
|
|
616
|
-
[src/Particle.js:
|
|
664
|
+
[src/Particle.js:626-628](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L626-L628 "Source code on GitHub")
|
|
617
665
|
|
|
618
666
|
Mark device as receiving automatic firmware updates
|
|
619
667
|
|
|
@@ -630,7 +678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
630
678
|
|
|
631
679
|
### updateDevice
|
|
632
680
|
|
|
633
|
-
[src/Particle.js:
|
|
681
|
+
[src/Particle.js:647-659](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L647-L659 "Source code on GitHub")
|
|
634
682
|
|
|
635
683
|
Update multiple device attributes at the same time
|
|
636
684
|
|
|
@@ -654,7 +702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
654
702
|
|
|
655
703
|
### unprotectDevice
|
|
656
704
|
|
|
657
|
-
[src/Particle.js:
|
|
705
|
+
[src/Particle.js:679-695](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L679-L695 "Source code on GitHub")
|
|
658
706
|
|
|
659
707
|
Disable device protection.
|
|
660
708
|
|
|
@@ -678,7 +726,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
678
726
|
|
|
679
727
|
### provisionDevice
|
|
680
728
|
|
|
681
|
-
[src/Particle.js:
|
|
729
|
+
[src/Particle.js:706-714](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L706-L714 "Source code on GitHub")
|
|
682
730
|
|
|
683
731
|
Provision a new device for products that allow self-provisioning
|
|
684
732
|
|
|
@@ -694,7 +742,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
694
742
|
|
|
695
743
|
### getClaimCode
|
|
696
744
|
|
|
697
|
-
[src/Particle.js:
|
|
745
|
+
[src/Particle.js:728-731](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L728-L731 "Source code on GitHub")
|
|
698
746
|
|
|
699
747
|
Generate a claim code to use in the device claiming process.
|
|
700
748
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -713,7 +761,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
713
761
|
|
|
714
762
|
### getVariable
|
|
715
763
|
|
|
716
|
-
[src/Particle.js:
|
|
764
|
+
[src/Particle.js:753-759](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L753-L759 "Source code on GitHub")
|
|
717
765
|
|
|
718
766
|
Get the value of a device variable
|
|
719
767
|
|
|
@@ -731,7 +779,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
731
779
|
|
|
732
780
|
### flashDevice
|
|
733
781
|
|
|
734
|
-
[src/Particle.js:
|
|
782
|
+
[src/Particle.js:773-784](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L773-L784 "Source code on GitHub")
|
|
735
783
|
|
|
736
784
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
737
785
|
|
|
@@ -750,7 +798,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
750
798
|
|
|
751
799
|
### flashTinker
|
|
752
800
|
|
|
753
|
-
[src/Particle.js:
|
|
801
|
+
[src/Particle.js:795-810](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L795-L810 "Source code on GitHub")
|
|
754
802
|
|
|
755
803
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
756
804
|
|
|
@@ -766,7 +814,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
766
814
|
|
|
767
815
|
### compileCode
|
|
768
816
|
|
|
769
|
-
[src/Particle.js:
|
|
817
|
+
[src/Particle.js:823-841](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L823-L841 "Source code on GitHub")
|
|
770
818
|
|
|
771
819
|
Compile firmware using the Particle Cloud
|
|
772
820
|
|
|
@@ -784,7 +832,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
784
832
|
|
|
785
833
|
### downloadFirmwareBinary
|
|
786
834
|
|
|
787
|
-
[src/Particle.js:
|
|
835
|
+
[src/Particle.js:852-861](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L852-L861 "Source code on GitHub")
|
|
788
836
|
|
|
789
837
|
Download a firmware binary
|
|
790
838
|
|
|
@@ -800,7 +848,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
800
848
|
|
|
801
849
|
### sendPublicKey
|
|
802
850
|
|
|
803
|
-
[src/Particle.js:
|
|
851
|
+
[src/Particle.js:874-888](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L874-L888 "Source code on GitHub")
|
|
804
852
|
|
|
805
853
|
Send a new device public key to the Particle Cloud
|
|
806
854
|
|
|
@@ -818,7 +866,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
818
866
|
|
|
819
867
|
### callFunction
|
|
820
868
|
|
|
821
|
-
[src/Particle.js:
|
|
869
|
+
[src/Particle.js:902-907](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L902-L907 "Source code on GitHub")
|
|
822
870
|
|
|
823
871
|
Call a device function
|
|
824
872
|
|
|
@@ -837,7 +885,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
837
885
|
|
|
838
886
|
### getEventStream
|
|
839
887
|
|
|
840
|
-
[src/Particle.js:
|
|
888
|
+
[src/Particle.js:920-945](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L920-L945 "Source code on GitHub")
|
|
841
889
|
|
|
842
890
|
Get a stream of events
|
|
843
891
|
|
|
@@ -855,7 +903,7 @@ emit 'event' events.
|
|
|
855
903
|
|
|
856
904
|
### publishEvent
|
|
857
905
|
|
|
858
|
-
[src/Particle.js:
|
|
906
|
+
[src/Particle.js:959-963](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L959-L963 "Source code on GitHub")
|
|
859
907
|
|
|
860
908
|
Publish a event to the Particle Cloud
|
|
861
909
|
|
|
@@ -874,7 +922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
874
922
|
|
|
875
923
|
### Hook
|
|
876
924
|
|
|
877
|
-
[src/Particle.js:
|
|
925
|
+
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L994-L1016 "Source code on GitHub")
|
|
878
926
|
|
|
879
927
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
880
928
|
|
|
@@ -907,7 +955,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
907
955
|
|
|
908
956
|
### createWebhook
|
|
909
957
|
|
|
910
|
-
[src/Particle.js:
|
|
958
|
+
[src/Particle.js:994-1016](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L994-L1016 "Source code on GitHub")
|
|
911
959
|
|
|
912
960
|
Create a webhook
|
|
913
961
|
|
|
@@ -929,7 +977,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
929
977
|
|
|
930
978
|
### deleteWebhook
|
|
931
979
|
|
|
932
|
-
[src/Particle.js:
|
|
980
|
+
[src/Particle.js:1028-1031](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1028-L1031 "Source code on GitHub")
|
|
933
981
|
|
|
934
982
|
Delete a webhook
|
|
935
983
|
|
|
@@ -946,7 +994,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
946
994
|
|
|
947
995
|
### listWebhooks
|
|
948
996
|
|
|
949
|
-
[src/Particle.js:
|
|
997
|
+
[src/Particle.js:1042-1045](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1042-L1045 "Source code on GitHub")
|
|
950
998
|
|
|
951
999
|
List all webhooks owned by the account or product
|
|
952
1000
|
|
|
@@ -962,7 +1010,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
962
1010
|
|
|
963
1011
|
### createIntegration
|
|
964
1012
|
|
|
965
|
-
[src/Particle.js:
|
|
1013
|
+
[src/Particle.js:1062-1066](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1062-L1066 "Source code on GitHub")
|
|
966
1014
|
|
|
967
1015
|
Create an integration to send events to an external service
|
|
968
1016
|
|
|
@@ -983,7 +1031,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
983
1031
|
|
|
984
1032
|
### editIntegration
|
|
985
1033
|
|
|
986
|
-
[src/Particle.js:
|
|
1034
|
+
[src/Particle.js:1084-1088](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1084-L1088 "Source code on GitHub")
|
|
987
1035
|
|
|
988
1036
|
Edit an integration to send events to an external service
|
|
989
1037
|
|
|
@@ -1005,7 +1053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1005
1053
|
|
|
1006
1054
|
### deleteIntegration
|
|
1007
1055
|
|
|
1008
|
-
[src/Particle.js:
|
|
1056
|
+
[src/Particle.js:1101-1104](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1101-L1104 "Source code on GitHub")
|
|
1009
1057
|
|
|
1010
1058
|
Delete an integration to send events to an external service
|
|
1011
1059
|
|
|
@@ -1022,7 +1070,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1022
1070
|
|
|
1023
1071
|
### listIntegrations
|
|
1024
1072
|
|
|
1025
|
-
[src/Particle.js:
|
|
1073
|
+
[src/Particle.js:1115-1118](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1115-L1118 "Source code on GitHub")
|
|
1026
1074
|
|
|
1027
1075
|
List all integrations owned by the account or product
|
|
1028
1076
|
|
|
@@ -1038,7 +1086,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1038
1086
|
|
|
1039
1087
|
### getUserInfo
|
|
1040
1088
|
|
|
1041
|
-
[src/Particle.js:
|
|
1089
|
+
[src/Particle.js:1128-1130](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1128-L1130 "Source code on GitHub")
|
|
1042
1090
|
|
|
1043
1091
|
Get details about the current user
|
|
1044
1092
|
|
|
@@ -1053,7 +1101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1053
1101
|
|
|
1054
1102
|
### setUserInfo
|
|
1055
1103
|
|
|
1056
|
-
[src/Particle.js:
|
|
1104
|
+
[src/Particle.js:1141-1144](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1141-L1144 "Source code on GitHub")
|
|
1057
1105
|
|
|
1058
1106
|
Set details on the current user
|
|
1059
1107
|
|
|
@@ -1069,7 +1117,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1069
1117
|
|
|
1070
1118
|
### changeUsername
|
|
1071
1119
|
|
|
1072
|
-
[src/Particle.js:
|
|
1120
|
+
[src/Particle.js:1157-1165](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1157-L1165 "Source code on GitHub")
|
|
1073
1121
|
|
|
1074
1122
|
Change username (i.e, email)
|
|
1075
1123
|
|
|
@@ -1087,7 +1135,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1087
1135
|
|
|
1088
1136
|
### changeUserPassword
|
|
1089
1137
|
|
|
1090
|
-
[src/Particle.js:
|
|
1138
|
+
[src/Particle.js:1178-1186](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1178-L1186 "Source code on GitHub")
|
|
1091
1139
|
|
|
1092
1140
|
Change user's password
|
|
1093
1141
|
|
|
@@ -1105,7 +1153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1105
1153
|
|
|
1106
1154
|
### listSIMs
|
|
1107
1155
|
|
|
1108
|
-
[src/Particle.js:
|
|
1156
|
+
[src/Particle.js:1202-1206](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1202-L1206 "Source code on GitHub")
|
|
1109
1157
|
|
|
1110
1158
|
List SIM cards owned by a user or product
|
|
1111
1159
|
|
|
@@ -1126,7 +1174,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1126
1174
|
|
|
1127
1175
|
### getSIMDataUsage
|
|
1128
1176
|
|
|
1129
|
-
[src/Particle.js:
|
|
1177
|
+
[src/Particle.js:1218-1224](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1218-L1224 "Source code on GitHub")
|
|
1130
1178
|
|
|
1131
1179
|
Get data usage for one SIM card for the current billing period
|
|
1132
1180
|
|
|
@@ -1143,7 +1191,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1143
1191
|
|
|
1144
1192
|
### getFleetDataUsage
|
|
1145
1193
|
|
|
1146
|
-
[src/Particle.js:
|
|
1194
|
+
[src/Particle.js:1235-1242](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1235-L1242 "Source code on GitHub")
|
|
1147
1195
|
|
|
1148
1196
|
Get data usage for all SIM cards in a product the current billing period
|
|
1149
1197
|
|
|
@@ -1159,7 +1207,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1159
1207
|
|
|
1160
1208
|
### checkSIM
|
|
1161
1209
|
|
|
1162
|
-
[src/Particle.js:
|
|
1210
|
+
[src/Particle.js:1253-1255](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1253-L1255 "Source code on GitHub")
|
|
1163
1211
|
|
|
1164
1212
|
Check SIM status
|
|
1165
1213
|
|
|
@@ -1175,7 +1223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1175
1223
|
|
|
1176
1224
|
### activateSIM
|
|
1177
1225
|
|
|
1178
|
-
[src/Particle.js:
|
|
1226
|
+
[src/Particle.js:1270-1280](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1270-L1280 "Source code on GitHub")
|
|
1179
1227
|
|
|
1180
1228
|
Activate and add SIM cards to an account or product
|
|
1181
1229
|
|
|
@@ -1195,7 +1243,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1195
1243
|
|
|
1196
1244
|
### deactivateSIM
|
|
1197
1245
|
|
|
1198
|
-
[src/Particle.js:
|
|
1246
|
+
[src/Particle.js:1292-1296](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1292-L1296 "Source code on GitHub")
|
|
1199
1247
|
|
|
1200
1248
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1201
1249
|
|
|
@@ -1212,7 +1260,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1212
1260
|
|
|
1213
1261
|
### reactivateSIM
|
|
1214
1262
|
|
|
1215
|
-
[src/Particle.js:
|
|
1263
|
+
[src/Particle.js:1309-1313](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1309-L1313 "Source code on GitHub")
|
|
1216
1264
|
|
|
1217
1265
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1218
1266
|
|
|
@@ -1230,7 +1278,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1230
1278
|
|
|
1231
1279
|
### updateSIM
|
|
1232
1280
|
|
|
1233
|
-
[src/Particle.js:
|
|
1281
|
+
[src/Particle.js:1326-1330](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1326-L1330 "Source code on GitHub")
|
|
1234
1282
|
|
|
1235
1283
|
Update SIM card data limit
|
|
1236
1284
|
|
|
@@ -1248,7 +1296,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1248
1296
|
|
|
1249
1297
|
### removeSIM
|
|
1250
1298
|
|
|
1251
|
-
[src/Particle.js:
|
|
1299
|
+
[src/Particle.js:1342-1345](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1342-L1345 "Source code on GitHub")
|
|
1252
1300
|
|
|
1253
1301
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1254
1302
|
|
|
@@ -1265,7 +1313,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1265
1313
|
|
|
1266
1314
|
### listBuildTargets
|
|
1267
1315
|
|
|
1268
|
-
[src/Particle.js:
|
|
1316
|
+
[src/Particle.js:1356-1359](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1356-L1359 "Source code on GitHub")
|
|
1269
1317
|
|
|
1270
1318
|
List valid build targets to be used for compiling
|
|
1271
1319
|
|
|
@@ -1281,7 +1329,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1281
1329
|
|
|
1282
1330
|
### listLibraries
|
|
1283
1331
|
|
|
1284
|
-
[src/Particle.js:
|
|
1332
|
+
[src/Particle.js:1385-1402](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1385-L1402 "Source code on GitHub")
|
|
1285
1333
|
|
|
1286
1334
|
List firmware libraries
|
|
1287
1335
|
|
|
@@ -1311,7 +1359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1311
1359
|
|
|
1312
1360
|
### getLibrary
|
|
1313
1361
|
|
|
1314
|
-
[src/Particle.js:
|
|
1362
|
+
[src/Particle.js:1418-1426](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1418-L1426 "Source code on GitHub")
|
|
1315
1363
|
|
|
1316
1364
|
Get firmware library details
|
|
1317
1365
|
|
|
@@ -1328,7 +1376,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1328
1376
|
|
|
1329
1377
|
### getLibraryVersions
|
|
1330
1378
|
|
|
1331
|
-
[src/Particle.js:
|
|
1379
|
+
[src/Particle.js:1439-1447](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1439-L1447 "Source code on GitHub")
|
|
1332
1380
|
|
|
1333
1381
|
Firmware library details for each version
|
|
1334
1382
|
|
|
@@ -1346,7 +1394,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1346
1394
|
|
|
1347
1395
|
### contributeLibrary
|
|
1348
1396
|
|
|
1349
|
-
[src/Particle.js:
|
|
1397
|
+
[src/Particle.js:1459-1472](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1459-L1472 "Source code on GitHub")
|
|
1350
1398
|
|
|
1351
1399
|
Contribute a new library version from a compressed archive
|
|
1352
1400
|
|
|
@@ -1363,7 +1411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1363
1411
|
|
|
1364
1412
|
### publishLibrary
|
|
1365
1413
|
|
|
1366
|
-
[src/Particle.js:
|
|
1414
|
+
[src/Particle.js:1483-1492](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1483-L1492 "Source code on GitHub")
|
|
1367
1415
|
|
|
1368
1416
|
Publish the latest version of a library to the public
|
|
1369
1417
|
|
|
@@ -1379,7 +1427,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1379
1427
|
|
|
1380
1428
|
### deleteLibrary
|
|
1381
1429
|
|
|
1382
|
-
[src/Particle.js:
|
|
1430
|
+
[src/Particle.js:1504-1512](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1504-L1512 "Source code on GitHub")
|
|
1383
1431
|
|
|
1384
1432
|
Delete one version of a library or an entire private library
|
|
1385
1433
|
|
|
@@ -1396,7 +1444,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1396
1444
|
|
|
1397
1445
|
### downloadFile
|
|
1398
1446
|
|
|
1399
|
-
[src/Particle.js:
|
|
1447
|
+
[src/Particle.js:1522-1524](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1522-L1524 "Source code on GitHub")
|
|
1400
1448
|
|
|
1401
1449
|
Download an external file that may not be on the API
|
|
1402
1450
|
|
|
@@ -1411,7 +1459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1411
1459
|
|
|
1412
1460
|
### listOAuthClients
|
|
1413
1461
|
|
|
1414
|
-
[src/Particle.js:
|
|
1462
|
+
[src/Particle.js:1535-1538](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1535-L1538 "Source code on GitHub")
|
|
1415
1463
|
|
|
1416
1464
|
List OAuth client created by the account
|
|
1417
1465
|
|
|
@@ -1427,7 +1475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1427
1475
|
|
|
1428
1476
|
### createOAuthClient
|
|
1429
1477
|
|
|
1430
|
-
[src/Particle.js:
|
|
1478
|
+
[src/Particle.js:1553-1557](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1553-L1557 "Source code on GitHub")
|
|
1431
1479
|
|
|
1432
1480
|
Create an OAuth client
|
|
1433
1481
|
|
|
@@ -1447,7 +1495,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1447
1495
|
|
|
1448
1496
|
### updateOAuthClient
|
|
1449
1497
|
|
|
1450
|
-
[src/Particle.js:
|
|
1498
|
+
[src/Particle.js:1571-1575](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1571-L1575 "Source code on GitHub")
|
|
1451
1499
|
|
|
1452
1500
|
Update an OAuth client
|
|
1453
1501
|
|
|
@@ -1466,7 +1514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1466
1514
|
|
|
1467
1515
|
### deleteOAuthClient
|
|
1468
1516
|
|
|
1469
|
-
[src/Particle.js:
|
|
1517
|
+
[src/Particle.js:1587-1590](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1587-L1590 "Source code on GitHub")
|
|
1470
1518
|
|
|
1471
1519
|
Delete an OAuth client
|
|
1472
1520
|
|
|
@@ -1483,7 +1531,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1483
1531
|
|
|
1484
1532
|
### listProducts
|
|
1485
1533
|
|
|
1486
|
-
[src/Particle.js:
|
|
1534
|
+
[src/Particle.js:1600-1602](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1600-L1602 "Source code on GitHub")
|
|
1487
1535
|
|
|
1488
1536
|
List products the account has access to
|
|
1489
1537
|
|
|
@@ -1498,7 +1546,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1498
1546
|
|
|
1499
1547
|
### getProduct
|
|
1500
1548
|
|
|
1501
|
-
[src/Particle.js:
|
|
1549
|
+
[src/Particle.js:1613-1615](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1613-L1615 "Source code on GitHub")
|
|
1502
1550
|
|
|
1503
1551
|
Get detailed information about a product
|
|
1504
1552
|
|
|
@@ -1514,7 +1562,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1514
1562
|
|
|
1515
1563
|
### listProductFirmware
|
|
1516
1564
|
|
|
1517
|
-
[src/Particle.js:
|
|
1565
|
+
[src/Particle.js:1626-1628](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1626-L1628 "Source code on GitHub")
|
|
1518
1566
|
|
|
1519
1567
|
List product firmware versions
|
|
1520
1568
|
|
|
@@ -1530,7 +1578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1530
1578
|
|
|
1531
1579
|
### uploadProductFirmware
|
|
1532
1580
|
|
|
1533
|
-
[src/Particle.js:
|
|
1581
|
+
[src/Particle.js:1644-1660](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1644-L1660 "Source code on GitHub")
|
|
1534
1582
|
|
|
1535
1583
|
List product firmware versions
|
|
1536
1584
|
|
|
@@ -1551,7 +1599,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1551
1599
|
|
|
1552
1600
|
### getProductFirmware
|
|
1553
1601
|
|
|
1554
|
-
[src/Particle.js:
|
|
1602
|
+
[src/Particle.js:1672-1679](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1672-L1679 "Source code on GitHub")
|
|
1555
1603
|
|
|
1556
1604
|
Get information about a product firmware version
|
|
1557
1605
|
|
|
@@ -1568,7 +1616,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1568
1616
|
|
|
1569
1617
|
### updateProductFirmware
|
|
1570
1618
|
|
|
1571
|
-
[src/Particle.js:
|
|
1619
|
+
[src/Particle.js:1693-1696](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1693-L1696 "Source code on GitHub")
|
|
1572
1620
|
|
|
1573
1621
|
Update information for a product firmware version
|
|
1574
1622
|
|
|
@@ -1587,7 +1635,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1587
1635
|
|
|
1588
1636
|
### downloadProductFirmware
|
|
1589
1637
|
|
|
1590
|
-
[src/Particle.js:
|
|
1638
|
+
[src/Particle.js:1708-1717](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1708-L1717 "Source code on GitHub")
|
|
1591
1639
|
|
|
1592
1640
|
Download a product firmware binary
|
|
1593
1641
|
|
|
@@ -1604,7 +1652,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1604
1652
|
|
|
1605
1653
|
### releaseProductFirmware
|
|
1606
1654
|
|
|
1607
|
-
[src/Particle.js:
|
|
1655
|
+
[src/Particle.js:1729-1732](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1729-L1732 "Source code on GitHub")
|
|
1608
1656
|
|
|
1609
1657
|
Release a product firmware version as the default version
|
|
1610
1658
|
|
|
@@ -1621,7 +1669,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1621
1669
|
|
|
1622
1670
|
### listTeamMembers
|
|
1623
1671
|
|
|
1624
|
-
[src/Particle.js:
|
|
1672
|
+
[src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1743-L1750 "Source code on GitHub")
|
|
1625
1673
|
|
|
1626
1674
|
List product team members
|
|
1627
1675
|
|
|
@@ -1637,7 +1685,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1637
1685
|
|
|
1638
1686
|
### inviteTeamMember
|
|
1639
1687
|
|
|
1640
|
-
[src/Particle.js:
|
|
1688
|
+
[src/Particle.js:1762-1770](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1762-L1770 "Source code on GitHub")
|
|
1641
1689
|
|
|
1642
1690
|
Invite Particle user to a product team
|
|
1643
1691
|
|
|
@@ -1654,7 +1702,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1654
1702
|
|
|
1655
1703
|
### removeTeamMember
|
|
1656
1704
|
|
|
1657
|
-
[src/Particle.js:
|
|
1705
|
+
[src/Particle.js:1782-1789](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1782-L1789 "Source code on GitHub")
|
|
1658
1706
|
|
|
1659
1707
|
Remove Particle user to a product team
|
|
1660
1708
|
|
|
@@ -1671,7 +1719,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1671
1719
|
|
|
1672
1720
|
### lookupSerialNumber
|
|
1673
1721
|
|
|
1674
|
-
[src/Particle.js:
|
|
1722
|
+
[src/Particle.js:1800-1807](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1800-L1807 "Source code on GitHub")
|
|
1675
1723
|
|
|
1676
1724
|
Fetch details about a serial number
|
|
1677
1725
|
|
|
@@ -1687,7 +1735,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1687
1735
|
|
|
1688
1736
|
### createMeshNetwork
|
|
1689
1737
|
|
|
1690
|
-
[src/Particle.js:
|
|
1738
|
+
[src/Particle.js:1820-1828](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1820-L1828 "Source code on GitHub")
|
|
1691
1739
|
|
|
1692
1740
|
Create a mesh network
|
|
1693
1741
|
|
|
@@ -1705,7 +1753,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1705
1753
|
|
|
1706
1754
|
### removeMeshNetwork
|
|
1707
1755
|
|
|
1708
|
-
[src/Particle.js:
|
|
1756
|
+
[src/Particle.js:1839-1841](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1839-L1841 "Source code on GitHub")
|
|
1709
1757
|
|
|
1710
1758
|
Remove a mesh network.
|
|
1711
1759
|
|
|
@@ -1721,7 +1769,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1721
1769
|
|
|
1722
1770
|
### listMeshNetworks
|
|
1723
1771
|
|
|
1724
|
-
[src/Particle.js:
|
|
1772
|
+
[src/Particle.js:1853-1856](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1853-L1856 "Source code on GitHub")
|
|
1725
1773
|
|
|
1726
1774
|
List all mesh networks
|
|
1727
1775
|
|
|
@@ -1738,7 +1786,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1738
1786
|
|
|
1739
1787
|
### getMeshNetwork
|
|
1740
1788
|
|
|
1741
|
-
[src/Particle.js:
|
|
1789
|
+
[src/Particle.js:1867-1869](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1867-L1869 "Source code on GitHub")
|
|
1742
1790
|
|
|
1743
1791
|
Get information about a mesh network.
|
|
1744
1792
|
|
|
@@ -1754,7 +1802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1754
1802
|
|
|
1755
1803
|
### updateMeshNetwork
|
|
1756
1804
|
|
|
1757
|
-
[src/Particle.js:
|
|
1805
|
+
[src/Particle.js:1882-1890](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1882-L1890 "Source code on GitHub")
|
|
1758
1806
|
|
|
1759
1807
|
Modify a mesh network.
|
|
1760
1808
|
|
|
@@ -1772,7 +1820,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1772
1820
|
|
|
1773
1821
|
### addMeshNetworkDevice
|
|
1774
1822
|
|
|
1775
|
-
[src/Particle.js:
|
|
1823
|
+
[src/Particle.js:1902-1911](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1902-L1911 "Source code on GitHub")
|
|
1776
1824
|
|
|
1777
1825
|
Add a device to a mesh network.
|
|
1778
1826
|
|
|
@@ -1789,7 +1837,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1789
1837
|
|
|
1790
1838
|
### removeMeshNetworkDevice
|
|
1791
1839
|
|
|
1792
|
-
[src/Particle.js:
|
|
1840
|
+
[src/Particle.js:1923-1939](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1923-L1939 "Source code on GitHub")
|
|
1793
1841
|
|
|
1794
1842
|
Remove a device from a mesh network.
|
|
1795
1843
|
|
|
@@ -1806,7 +1854,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1806
1854
|
|
|
1807
1855
|
### listMeshNetworkDevices
|
|
1808
1856
|
|
|
1809
|
-
[src/Particle.js:
|
|
1857
|
+
[src/Particle.js:1953-1962](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1953-L1962 "Source code on GitHub")
|
|
1810
1858
|
|
|
1811
1859
|
List all devices of a mesh network.
|
|
1812
1860
|
|
|
@@ -1825,7 +1873,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1825
1873
|
|
|
1826
1874
|
### getProductConfiguration
|
|
1827
1875
|
|
|
1828
|
-
[src/Particle.js:
|
|
1876
|
+
[src/Particle.js:1973-1980](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1973-L1980 "Source code on GitHub")
|
|
1829
1877
|
|
|
1830
1878
|
Get product configuration
|
|
1831
1879
|
|
|
@@ -1841,7 +1889,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1841
1889
|
|
|
1842
1890
|
### getProductConfigurationSchema
|
|
1843
1891
|
|
|
1844
|
-
[src/Particle.js:
|
|
1892
|
+
[src/Particle.js:1991-1999](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L1991-L1999 "Source code on GitHub")
|
|
1845
1893
|
|
|
1846
1894
|
Get product configuration schema
|
|
1847
1895
|
|
|
@@ -1857,7 +1905,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1857
1905
|
|
|
1858
1906
|
### getProductDeviceConfiguration
|
|
1859
1907
|
|
|
1860
|
-
[src/Particle.js:
|
|
1908
|
+
[src/Particle.js:2011-2018](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2011-L2018 "Source code on GitHub")
|
|
1861
1909
|
|
|
1862
1910
|
Get product device's configuration
|
|
1863
1911
|
|
|
@@ -1874,7 +1922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1874
1922
|
|
|
1875
1923
|
### getProductDeviceConfigurationSchema
|
|
1876
1924
|
|
|
1877
|
-
[src/Particle.js:
|
|
1925
|
+
[src/Particle.js:2030-2038](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2030-L2038 "Source code on GitHub")
|
|
1878
1926
|
|
|
1879
1927
|
Get product device's configuration schema
|
|
1880
1928
|
|
|
@@ -1891,7 +1939,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1891
1939
|
|
|
1892
1940
|
### setProductConfiguration
|
|
1893
1941
|
|
|
1894
|
-
[src/Particle.js:
|
|
1942
|
+
[src/Particle.js:2050-2058](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2050-L2058 "Source code on GitHub")
|
|
1895
1943
|
|
|
1896
1944
|
Set product configuration
|
|
1897
1945
|
|
|
@@ -1908,7 +1956,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1908
1956
|
|
|
1909
1957
|
### setProductDeviceConfiguration
|
|
1910
1958
|
|
|
1911
|
-
[src/Particle.js:
|
|
1959
|
+
[src/Particle.js:2071-2079](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2071-L2079 "Source code on GitHub")
|
|
1912
1960
|
|
|
1913
1961
|
Set product configuration for a specific device within the product
|
|
1914
1962
|
|
|
@@ -1926,7 +1974,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1926
1974
|
|
|
1927
1975
|
### getProductLocations
|
|
1928
1976
|
|
|
1929
|
-
[src/Particle.js:
|
|
1977
|
+
[src/Particle.js:2098-2115](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2098-L2115 "Source code on GitHub")
|
|
1930
1978
|
|
|
1931
1979
|
Query location for devices within a product
|
|
1932
1980
|
|
|
@@ -1950,7 +1998,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1950
1998
|
|
|
1951
1999
|
### getProductDeviceLocations
|
|
1952
2000
|
|
|
1953
|
-
[src/Particle.js:
|
|
2001
|
+
[src/Particle.js:2132-2144](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2132-L2144 "Source code on GitHub")
|
|
1954
2002
|
|
|
1955
2003
|
Query location for one device within a product
|
|
1956
2004
|
|
|
@@ -1970,7 +2018,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1970
2018
|
|
|
1971
2019
|
### executeLogic
|
|
1972
2020
|
|
|
1973
|
-
[src/Particle.js:
|
|
2021
|
+
[src/Particle.js:2160-2168](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2160-L2168 "Source code on GitHub")
|
|
1974
2022
|
|
|
1975
2023
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
1976
2024
|
|
|
@@ -1989,7 +2037,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1989
2037
|
|
|
1990
2038
|
### createLogicFunction
|
|
1991
2039
|
|
|
1992
|
-
[src/Particle.js:
|
|
2040
|
+
[src/Particle.js:2188-2196](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2188-L2196 "Source code on GitHub")
|
|
1993
2041
|
|
|
1994
2042
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
1995
2043
|
|
|
@@ -2012,7 +2060,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2012
2060
|
|
|
2013
2061
|
### getLogicFunction
|
|
2014
2062
|
|
|
2015
|
-
[src/Particle.js:
|
|
2063
|
+
[src/Particle.js:2210-2217](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2210-L2217 "Source code on GitHub")
|
|
2016
2064
|
|
|
2017
2065
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2018
2066
|
|
|
@@ -2029,7 +2077,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2029
2077
|
|
|
2030
2078
|
### updateLogicFunction
|
|
2031
2079
|
|
|
2032
|
-
[src/Particle.js:
|
|
2080
|
+
[src/Particle.js:2234-2242](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2234-L2242 "Source code on GitHub")
|
|
2033
2081
|
|
|
2034
2082
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2035
2083
|
|
|
@@ -2049,7 +2097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2049
2097
|
|
|
2050
2098
|
### deleteLogicFunction
|
|
2051
2099
|
|
|
2052
|
-
[src/Particle.js:
|
|
2100
|
+
[src/Particle.js:2256-2263](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2256-L2263 "Source code on GitHub")
|
|
2053
2101
|
|
|
2054
2102
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2055
2103
|
|
|
@@ -2066,7 +2114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2066
2114
|
|
|
2067
2115
|
### listLogicFunctions
|
|
2068
2116
|
|
|
2069
|
-
[src/Particle.js:
|
|
2117
|
+
[src/Particle.js:2277-2287](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2277-L2287 "Source code on GitHub")
|
|
2070
2118
|
|
|
2071
2119
|
Lists all logic functions in the specified organization or sandbox.
|
|
2072
2120
|
|
|
@@ -2083,7 +2131,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2083
2131
|
|
|
2084
2132
|
### listLogicRuns
|
|
2085
2133
|
|
|
2086
|
-
[src/Particle.js:
|
|
2134
|
+
[src/Particle.js:2301-2308](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2301-L2308 "Source code on GitHub")
|
|
2087
2135
|
|
|
2088
2136
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2089
2137
|
|
|
@@ -2100,7 +2148,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2100
2148
|
|
|
2101
2149
|
### getLogicRun
|
|
2102
2150
|
|
|
2103
|
-
[src/Particle.js:
|
|
2151
|
+
[src/Particle.js:2323-2330](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2323-L2330 "Source code on GitHub")
|
|
2104
2152
|
|
|
2105
2153
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2106
2154
|
|
|
@@ -2118,7 +2166,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2118
2166
|
|
|
2119
2167
|
### getLogicRunLogs
|
|
2120
2168
|
|
|
2121
|
-
[src/Particle.js:
|
|
2169
|
+
[src/Particle.js:2345-2352](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2345-L2352 "Source code on GitHub")
|
|
2122
2170
|
|
|
2123
2171
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2124
2172
|
|
|
@@ -2136,7 +2184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2136
2184
|
|
|
2137
2185
|
### createLedger
|
|
2138
2186
|
|
|
2139
|
-
[src/Particle.js:
|
|
2187
|
+
[src/Particle.js:2366-2374](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2366-L2374 "Source code on GitHub")
|
|
2140
2188
|
|
|
2141
2189
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2142
2190
|
|
|
@@ -2153,7 +2201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2153
2201
|
|
|
2154
2202
|
### getLedger
|
|
2155
2203
|
|
|
2156
|
-
[src/Particle.js:
|
|
2204
|
+
[src/Particle.js:2388-2395](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2388-L2395 "Source code on GitHub")
|
|
2157
2205
|
|
|
2158
2206
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2159
2207
|
|
|
@@ -2170,7 +2218,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2170
2218
|
|
|
2171
2219
|
### updateLedger
|
|
2172
2220
|
|
|
2173
|
-
[src/Particle.js:
|
|
2221
|
+
[src/Particle.js:2410-2418](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2410-L2418 "Source code on GitHub")
|
|
2174
2222
|
|
|
2175
2223
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2176
2224
|
|
|
@@ -2188,7 +2236,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2188
2236
|
|
|
2189
2237
|
### archiveLedger
|
|
2190
2238
|
|
|
2191
|
-
[src/Particle.js:
|
|
2239
|
+
[src/Particle.js:2432-2439](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2432-L2439 "Source code on GitHub")
|
|
2192
2240
|
|
|
2193
2241
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2194
2242
|
|
|
@@ -2205,7 +2253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2205
2253
|
|
|
2206
2254
|
### Scope
|
|
2207
2255
|
|
|
2208
|
-
[src/Particle.js:
|
|
2256
|
+
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2460-L2473 "Source code on GitHub")
|
|
2209
2257
|
|
|
2210
2258
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2211
2259
|
|
|
@@ -2223,7 +2271,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2223
2271
|
|
|
2224
2272
|
### listLedgers
|
|
2225
2273
|
|
|
2226
|
-
[src/Particle.js:
|
|
2274
|
+
[src/Particle.js:2460-2473](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2460-L2473 "Source code on GitHub")
|
|
2227
2275
|
|
|
2228
2276
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2229
2277
|
|
|
@@ -2243,7 +2291,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2243
2291
|
|
|
2244
2292
|
### getLedgerInstance
|
|
2245
2293
|
|
|
2246
|
-
[src/Particle.js:
|
|
2294
|
+
[src/Particle.js:2488-2495](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2488-L2495 "Source code on GitHub")
|
|
2247
2295
|
|
|
2248
2296
|
Get ledger instance data.
|
|
2249
2297
|
|
|
@@ -2261,7 +2309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2261
2309
|
|
|
2262
2310
|
### SetMode
|
|
2263
2311
|
|
|
2264
|
-
[src/Particle.js:
|
|
2312
|
+
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2516-L2527 "Source code on GitHub")
|
|
2265
2313
|
|
|
2266
2314
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2267
2315
|
|
|
@@ -2279,7 +2327,7 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2279
2327
|
|
|
2280
2328
|
### setLedgerInstance
|
|
2281
2329
|
|
|
2282
|
-
[src/Particle.js:
|
|
2330
|
+
[src/Particle.js:2516-2527](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2516-L2527 "Source code on GitHub")
|
|
2283
2331
|
|
|
2284
2332
|
Set ledger instance data.
|
|
2285
2333
|
|
|
@@ -2299,7 +2347,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2299
2347
|
|
|
2300
2348
|
### deleteLedgerInstance
|
|
2301
2349
|
|
|
2302
|
-
[src/Particle.js:
|
|
2350
|
+
[src/Particle.js:2542-2549](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2542-L2549 "Source code on GitHub")
|
|
2303
2351
|
|
|
2304
2352
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2305
2353
|
|
|
@@ -2317,7 +2365,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2317
2365
|
|
|
2318
2366
|
### listLedgerInstances
|
|
2319
2367
|
|
|
2320
|
-
[src/Particle.js:
|
|
2368
|
+
[src/Particle.js:2565-2576](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2565-L2576 "Source code on GitHub")
|
|
2321
2369
|
|
|
2322
2370
|
Lists ledger instances in the specified organization or sandbox.
|
|
2323
2371
|
|
|
@@ -2336,7 +2384,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2336
2384
|
|
|
2337
2385
|
### listLedgerInstanceVersions
|
|
2338
2386
|
|
|
2339
|
-
[src/Particle.js:
|
|
2387
|
+
[src/Particle.js:2593-2604](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2593-L2604 "Source code on GitHub")
|
|
2340
2388
|
|
|
2341
2389
|
List ledger instance versions
|
|
2342
2390
|
|
|
@@ -2356,7 +2404,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2356
2404
|
|
|
2357
2405
|
### getLedgerInstanceVersion
|
|
2358
2406
|
|
|
2359
|
-
[src/Particle.js:
|
|
2407
|
+
[src/Particle.js:2620-2627](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2620-L2627 "Source code on GitHub")
|
|
2360
2408
|
|
|
2361
2409
|
Get specific ledger instance version
|
|
2362
2410
|
|
|
@@ -2375,7 +2423,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2375
2423
|
|
|
2376
2424
|
### listDeviceOsVersions
|
|
2377
2425
|
|
|
2378
|
-
[src/Particle.js:
|
|
2426
|
+
[src/Particle.js:2643-2658](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2643-L2658 "Source code on GitHub")
|
|
2379
2427
|
|
|
2380
2428
|
List Device OS versions
|
|
2381
2429
|
|
|
@@ -2394,7 +2442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2394
2442
|
|
|
2395
2443
|
### getDeviceOsVersion
|
|
2396
2444
|
|
|
2397
|
-
[src/Particle.js:
|
|
2445
|
+
[src/Particle.js:2672-2681](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2672-L2681 "Source code on GitHub")
|
|
2398
2446
|
|
|
2399
2447
|
Get a specific Device OS version
|
|
2400
2448
|
|
|
@@ -2411,7 +2459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2411
2459
|
|
|
2412
2460
|
### setDefaultAuth
|
|
2413
2461
|
|
|
2414
|
-
[src/Particle.js:
|
|
2462
|
+
[src/Particle.js:2688-2694](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2688-L2694 "Source code on GitHub")
|
|
2415
2463
|
|
|
2416
2464
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2417
2465
|
|
|
@@ -2424,7 +2472,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2424
2472
|
|
|
2425
2473
|
### get
|
|
2426
2474
|
|
|
2427
|
-
[src/Particle.js:
|
|
2475
|
+
[src/Particle.js:2744-2748](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2744-L2748 "Source code on GitHub")
|
|
2428
2476
|
|
|
2429
2477
|
Make a GET request
|
|
2430
2478
|
|
|
@@ -2441,7 +2489,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2441
2489
|
|
|
2442
2490
|
### head
|
|
2443
2491
|
|
|
2444
|
-
[src/Particle.js:
|
|
2492
|
+
[src/Particle.js:2760-2764](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2760-L2764 "Source code on GitHub")
|
|
2445
2493
|
|
|
2446
2494
|
Make a HEAD request
|
|
2447
2495
|
|
|
@@ -2458,7 +2506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2458
2506
|
|
|
2459
2507
|
### post
|
|
2460
2508
|
|
|
2461
|
-
[src/Particle.js:
|
|
2509
|
+
[src/Particle.js:2776-2780](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2776-L2780 "Source code on GitHub")
|
|
2462
2510
|
|
|
2463
2511
|
Make a POST request
|
|
2464
2512
|
|
|
@@ -2475,7 +2523,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2475
2523
|
|
|
2476
2524
|
### put
|
|
2477
2525
|
|
|
2478
|
-
[src/Particle.js:
|
|
2526
|
+
[src/Particle.js:2793-2797](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2793-L2797 "Source code on GitHub")
|
|
2479
2527
|
|
|
2480
2528
|
Make a PUT request
|
|
2481
2529
|
|
|
@@ -2493,7 +2541,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2493
2541
|
|
|
2494
2542
|
### delete
|
|
2495
2543
|
|
|
2496
|
-
[src/Particle.js:
|
|
2544
|
+
[src/Particle.js:2809-2813](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2809-L2813 "Source code on GitHub")
|
|
2497
2545
|
|
|
2498
2546
|
Make a DELETE request
|
|
2499
2547
|
|
|
@@ -2510,7 +2558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2510
2558
|
|
|
2511
2559
|
### request
|
|
2512
2560
|
|
|
2513
|
-
[src/Particle.js:
|
|
2561
|
+
[src/Particle.js:2830-2834](https://github.com/particle-iot/particle-api-js/blob/8e52094776bb6cea700221e4ed19579c7372441a/src/Particle.js#L2830-L2834 "Source code on GitHub")
|
|
2514
2562
|
|
|
2515
2563
|
**Parameters**
|
|
2516
2564
|
|