particle-api-js 9.4.1 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/.circleci/config.yml +7 -5
  2. package/CHANGELOG.md +4 -0
  3. package/RELEASE.md +1 -1
  4. package/dist/particle.min.js +227 -192
  5. package/dist/particle.min.js.map +1 -1
  6. package/docs/api.md +561 -103
  7. package/fs.js +2 -0
  8. package/lib/Agent.js +320 -221
  9. package/lib/Agent.js.map +1 -1
  10. package/lib/Particle.js +645 -62
  11. package/lib/Particle.js.map +1 -1
  12. package/package.json +6 -5
  13. package/test/Agent.integration.js +3 -1
  14. package/test/Agent.spec.js +172 -289
  15. package/test/Particle.integration.js +5 -4
  16. package/test/Particle.spec.js +325 -11
  17. package/lib/superagent-binary-parser.js +0 -20
  18. package/lib/superagent-binary-parser.js.map +0 -1
  19. /package/{test/EventStream-e2e-browser.html → EventStream-e2e-browser.html} +0 -0
  20. /package/{test/EventStream-e2e-node.js → EventStream-e2e-node.js} +0 -0
package/docs/api.md CHANGED
@@ -104,11 +104,34 @@
104
104
  - [setProductDeviceConfiguration](#setproductdeviceconfiguration)
105
105
  - [getProductLocations](#getproductlocations)
106
106
  - [getProductDeviceLocations](#getproductdevicelocations)
107
+ - [createLogicBlock](#createlogicblock)
108
+ - [getLogicBlock](#getlogicblock)
109
+ - [updateLogicBlock](#updatelogicblock)
110
+ - [deleteLogicBlock](#deletelogicblock)
111
+ - [listLogicBlocks](#listlogicblocks)
112
+ - [listBlockRuns](#listblockruns)
113
+ - [getBlockRun](#getblockrun)
114
+ - [getBlockRunLog](#getblockrunlog)
115
+ - [createLedger](#createledger)
116
+ - [getLedger](#getledger)
117
+ - [updateLedger](#updateledger)
118
+ - [archiveLedger](#archiveledger)
119
+ - [listLedgers](#listledgers)
120
+ - [getLedgerInstance](#getledgerinstance)
121
+ - [setLedgerInstance](#setledgerinstance)
122
+ - [deleteLedgerInstance](#deleteledgerinstance)
123
+ - [listLedgerInstances](#listledgerinstances)
107
124
  - [setDefaultAuth](#setdefaultauth)
125
+ - [get](#get)
126
+ - [head](#head)
127
+ - [post](#post)
128
+ - [put](#put)
129
+ - [delete](#delete)
130
+ - [request](#request)
108
131
 
109
132
  ## Particle
110
133
 
111
- [src/Particle.js:17-2185](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L17-L2185 "Source code on GitHub")
134
+ [src/Particle.js:16-2603](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L16-L2603 "Source code on GitHub")
112
135
 
113
136
  Particle Cloud API wrapper.
114
137
 
@@ -124,7 +147,7 @@ Most Particle methods take a single unnamed argument object documented as
124
147
 
125
148
  ### constructor
126
149
 
127
- [src/Particle.js:25-34](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L25-L34 "Source code on GitHub")
150
+ [src/Particle.js:24-33](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L24-L33 "Source code on GitHub")
128
151
 
129
152
  Contructor for the Cloud API wrapper.
130
153
 
@@ -136,7 +159,7 @@ Create a new Particle object and call methods below on it.
136
159
 
137
160
  ### login
138
161
 
139
- [src/Particle.js:70-85](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L70-L85 "Source code on GitHub")
162
+ [src/Particle.js:69-84](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L69-L84 "Source code on GitHub")
140
163
 
141
164
  Login to Particle Cloud using an existing Particle acccount.
142
165
 
@@ -153,7 +176,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
153
176
 
154
177
  ### sendOtp
155
178
 
156
- [src/Particle.js:96-110](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L96-L110 "Source code on GitHub")
179
+ [src/Particle.js:95-109](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L95-L109 "Source code on GitHub")
157
180
 
158
181
  If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
159
182
 
@@ -169,7 +192,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
169
192
 
170
193
  ### enableMfa
171
194
 
172
- [src/Particle.js:120-122](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L120-L122 "Source code on GitHub")
195
+ [src/Particle.js:119-121](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L119-L121 "Source code on GitHub")
173
196
 
174
197
  Enable MFA on the currently logged in user
175
198
 
@@ -184,7 +207,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
184
207
 
185
208
  ### confirmMfa
186
209
 
187
- [src/Particle.js:135-149](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L135-L149 "Source code on GitHub")
210
+ [src/Particle.js:134-148](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L134-L148 "Source code on GitHub")
188
211
 
189
212
  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.
190
213
 
@@ -202,7 +225,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
202
225
 
203
226
  ### disableMfa
204
227
 
205
- [src/Particle.js:160-168](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L160-L168 "Source code on GitHub")
228
+ [src/Particle.js:159-167](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L159-L167 "Source code on GitHub")
206
229
 
207
230
  Disable MFA for the user.
208
231
 
@@ -218,7 +241,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
218
241
 
219
242
  ### createCustomer
220
243
 
221
- [src/Particle.js:180-194](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L180-L194 "Source code on GitHub")
244
+ [src/Particle.js:179-193](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L179-L193 "Source code on GitHub")
222
245
 
223
246
  Create Customer for Product.
224
247
 
@@ -235,7 +258,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
235
258
 
236
259
  ### loginAsClientOwner
237
260
 
238
- [src/Particle.js:203-215](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L203-L215 "Source code on GitHub")
261
+ [src/Particle.js:202-214](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L202-L214 "Source code on GitHub")
239
262
 
240
263
  Login to Particle Cloud using an OAuth client.
241
264
 
@@ -249,7 +272,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
249
272
 
250
273
  ### createUser
251
274
 
252
- [src/Particle.js:227-238](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L227-L238 "Source code on GitHub")
275
+ [src/Particle.js:226-237](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L226-L237 "Source code on GitHub")
253
276
 
254
277
  Create a user account for the Particle Cloud
255
278
 
@@ -266,7 +289,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
266
289
 
267
290
  ### verifyUser
268
291
 
269
- [src/Particle.js:248-255](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L248-L255 "Source code on GitHub")
292
+ [src/Particle.js:247-254](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L247-L254 "Source code on GitHub")
270
293
 
271
294
  Verify new user account via verification email
272
295
 
@@ -281,7 +304,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
281
304
 
282
305
  ### resetPassword
283
306
 
284
- [src/Particle.js:265-272](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L265-L272 "Source code on GitHub")
307
+ [src/Particle.js:264-271](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L264-L271 "Source code on GitHub")
285
308
 
286
309
  Send reset password email for a Particle Cloud user account
287
310
 
@@ -296,7 +319,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
296
319
 
297
320
  ### deleteAccessToken
298
321
 
299
- [src/Particle.js:284-292](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L284-L292 "Source code on GitHub")
322
+ [src/Particle.js:283-291](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L283-L291 "Source code on GitHub")
300
323
 
301
324
  Revoke an access token
302
325
 
@@ -313,7 +336,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
313
336
 
314
337
  ### deleteCurrentAccessToken
315
338
 
316
- [src/Particle.js:302-309](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L302-L309 "Source code on GitHub")
339
+ [src/Particle.js:301-308](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L301-L308 "Source code on GitHub")
317
340
 
318
341
  Revoke the current session access token
319
342
 
@@ -328,7 +351,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
328
351
 
329
352
  ### deleteActiveAccessTokens
330
353
 
331
- [src/Particle.js:319-326](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L319-L326 "Source code on GitHub")
354
+ [src/Particle.js:318-325](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L318-L325 "Source code on GitHub")
332
355
 
333
356
  Revoke all active access tokens
334
357
 
@@ -343,7 +366,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
343
366
 
344
367
  ### deleteUser
345
368
 
346
- [src/Particle.js:337-345](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L337-L345 "Source code on GitHub")
369
+ [src/Particle.js:336-344](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L336-L344 "Source code on GitHub")
347
370
 
348
371
  Delete the current user
349
372
 
@@ -359,7 +382,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
359
382
 
360
383
  ### listAccessTokens
361
384
 
362
- [src/Particle.js:357-365](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L357-L365 "Source code on GitHub")
385
+ [src/Particle.js:356-364](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L356-L364 "Source code on GitHub")
363
386
 
364
387
  List all valid access tokens for a Particle Cloud account
365
388
 
@@ -376,7 +399,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
376
399
 
377
400
  ### trackingIdentity
378
401
 
379
- [src/Particle.js:377-385](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L377-L385 "Source code on GitHub")
402
+ [src/Particle.js:376-384](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L376-L384 "Source code on GitHub")
380
403
 
381
404
  Retrieves the information that is used to identify the current login for tracking.
382
405
 
@@ -393,7 +416,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
393
416
 
394
417
  ### listDevices
395
418
 
396
- [src/Particle.js:403-415](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L403-L415 "Source code on GitHub")
419
+ [src/Particle.js:402-414](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L402-L414 "Source code on GitHub")
397
420
 
398
421
  List devices claimed to the account or product
399
422
 
@@ -416,7 +439,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
416
439
 
417
440
  ### getDevice
418
441
 
419
- [src/Particle.js:427-430](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L427-L430 "Source code on GitHub")
442
+ [src/Particle.js:426-429](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L426-L429 "Source code on GitHub")
420
443
 
421
444
  Get detailed informationa about a device
422
445
 
@@ -433,7 +456,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
433
456
 
434
457
  ### claimDevice
435
458
 
436
- [src/Particle.js:441-452](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L441-L452 "Source code on GitHub")
459
+ [src/Particle.js:440-451](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L440-L451 "Source code on GitHub")
437
460
 
438
461
  Claim a device to the account. The device must be online and unclaimed.
439
462
 
@@ -450,7 +473,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
450
473
 
451
474
  ### addDeviceToProduct
452
475
 
453
- [src/Particle.js:466-484](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L466-L484 "Source code on GitHub")
476
+ [src/Particle.js:465-483](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L465-L483 "Source code on GitHub")
454
477
 
455
478
  Add a device to a product or move device out of quarantine.
456
479
 
@@ -469,7 +492,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
469
492
 
470
493
  ### removeDevice
471
494
 
472
- [src/Particle.js:497-501](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L497-L501 "Source code on GitHub")
495
+ [src/Particle.js:496-500](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L496-L500 "Source code on GitHub")
473
496
 
474
497
  Unclaim / Remove a device from your account or product, or deny quarantine
475
498
 
@@ -487,7 +510,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
487
510
 
488
511
  ### removeDeviceOwner
489
512
 
490
- [src/Particle.js:513-516](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L513-L516 "Source code on GitHub")
513
+ [src/Particle.js:512-515](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L512-L515 "Source code on GitHub")
491
514
 
492
515
  Unclaim a product device its the owner, but keep it in the product
493
516
 
@@ -504,7 +527,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
504
527
 
505
528
  ### renameDevice
506
529
 
507
- [src/Particle.js:529-531](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L529-L531 "Source code on GitHub")
530
+ [src/Particle.js:528-530](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L528-L530 "Source code on GitHub")
508
531
 
509
532
  Rename a device
510
533
 
@@ -522,7 +545,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
522
545
 
523
546
  ### signalDevice
524
547
 
525
- [src/Particle.js:544-546](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L544-L546 "Source code on GitHub")
548
+ [src/Particle.js:543-545](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L543-L545 "Source code on GitHub")
526
549
 
527
550
  Instruct the device to turn on/off the LED in a rainbow pattern
528
551
 
@@ -540,7 +563,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
540
563
 
541
564
  ### setDeviceNotes
542
565
 
543
- [src/Particle.js:559-561](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L559-L561 "Source code on GitHub")
566
+ [src/Particle.js:558-560](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L558-L560 "Source code on GitHub")
544
567
 
545
568
  Store some notes about device
546
569
 
@@ -558,7 +581,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
558
581
 
559
582
  ### markAsDevelopmentDevice
560
583
 
561
- [src/Particle.js:574-576](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L574-L576 "Source code on GitHub")
584
+ [src/Particle.js:573-575](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L573-L575 "Source code on GitHub")
562
585
 
563
586
  Mark device as being used in development of a product so it opts out of automatic firmware updates
564
587
 
@@ -576,7 +599,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
576
599
 
577
600
  ### lockDeviceProductFirmware
578
601
 
579
- [src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L590-L592 "Source code on GitHub")
602
+ [src/Particle.js:589-591](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L589-L591 "Source code on GitHub")
580
603
 
581
604
  Mark device as being used in development of a product so it opts out of automatic firmware updates
582
605
 
@@ -595,7 +618,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
595
618
 
596
619
  ### unlockDeviceProductFirmware
597
620
 
598
- [src/Particle.js:604-606](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L604-L606 "Source code on GitHub")
621
+ [src/Particle.js:603-605](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L603-L605 "Source code on GitHub")
599
622
 
600
623
  Mark device as receiving automatic firmware updates
601
624
 
@@ -612,7 +635,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
612
635
 
613
636
  ### updateDevice
614
637
 
615
- [src/Particle.js:625-636](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L625-L636 "Source code on GitHub")
638
+ [src/Particle.js:624-635](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L624-L635 "Source code on GitHub")
616
639
 
617
640
  Update multiple device attributes at the same time
618
641
 
@@ -636,7 +659,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
636
659
 
637
660
  ### provisionDevice
638
661
 
639
- [src/Particle.js:647-655](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L647-L655 "Source code on GitHub")
662
+ [src/Particle.js:646-654](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L646-L654 "Source code on GitHub")
640
663
 
641
664
  Provision a new device for products that allow self-provisioning
642
665
 
@@ -652,7 +675,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
652
675
 
653
676
  ### getClaimCode
654
677
 
655
- [src/Particle.js:669-672](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L669-L672 "Source code on GitHub")
678
+ [src/Particle.js:668-671](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L668-L671 "Source code on GitHub")
656
679
 
657
680
  Generate a claim code to use in the device claiming process.
658
681
  To generate a claim code for a product, the access token MUST belong to a
@@ -671,7 +694,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
671
694
 
672
695
  ### getVariable
673
696
 
674
- [src/Particle.js:704-710](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L704-L710 "Source code on GitHub")
697
+ [src/Particle.js:703-709](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L703-L709 "Source code on GitHub")
675
698
 
676
699
  Get the value of a device variable
677
700
 
@@ -689,7 +712,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
689
712
 
690
713
  ### flashDevice
691
714
 
692
- [src/Particle.js:724-735](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L724-L735 "Source code on GitHub")
715
+ [src/Particle.js:723-734](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L723-L734 "Source code on GitHub")
693
716
 
694
717
  Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
695
718
 
@@ -708,7 +731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
708
731
 
709
732
  ### flashTinker
710
733
 
711
- [src/Particle.js:746-759](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L746-L759 "Source code on GitHub")
734
+ [src/Particle.js:745-758](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L745-L758 "Source code on GitHub")
712
735
 
713
736
  DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
714
737
 
@@ -724,7 +747,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
724
747
 
725
748
  ### compileCode
726
749
 
727
- [src/Particle.js:772-790](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L772-L790 "Source code on GitHub")
750
+ [src/Particle.js:771-789](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L771-L789 "Source code on GitHub")
728
751
 
729
752
  Compile firmware using the Particle Cloud
730
753
 
@@ -742,7 +765,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
742
765
 
743
766
  ### downloadFirmwareBinary
744
767
 
745
- [src/Particle.js:801-812](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L801-L812 "Source code on GitHub")
768
+ [src/Particle.js:800-809](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L800-L809 "Source code on GitHub")
746
769
 
747
770
  Download a firmware binary
748
771
 
@@ -758,7 +781,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
758
781
 
759
782
  ### sendPublicKey
760
783
 
761
- [src/Particle.js:825-839](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L825-L839 "Source code on GitHub")
784
+ [src/Particle.js:822-836](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L822-L836 "Source code on GitHub")
762
785
 
763
786
  Send a new device public key to the Particle Cloud
764
787
 
@@ -776,7 +799,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
776
799
 
777
800
  ### callFunction
778
801
 
779
- [src/Particle.js:853-858](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L853-L858 "Source code on GitHub")
802
+ [src/Particle.js:850-855](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L850-L855 "Source code on GitHub")
780
803
 
781
804
  Call a device function
782
805
 
@@ -795,7 +818,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
795
818
 
796
819
  ### getEventStream
797
820
 
798
- [src/Particle.js:871-896](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L871-L896 "Source code on GitHub")
821
+ [src/Particle.js:868-893](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L868-L893 "Source code on GitHub")
799
822
 
800
823
  Get a stream of events
801
824
 
@@ -813,7 +836,7 @@ emit 'event' events.
813
836
 
814
837
  ### publishEvent
815
838
 
816
- [src/Particle.js:910-914](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L910-L914 "Source code on GitHub")
839
+ [src/Particle.js:907-911](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L907-L911 "Source code on GitHub")
817
840
 
818
841
  Publish a event to the Particle Cloud
819
842
 
@@ -832,7 +855,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
832
855
 
833
856
  ### createWebhook
834
857
 
835
- [src/Particle.js:941-963](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L941-L963 "Source code on GitHub")
858
+ [src/Particle.js:938-960](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L938-L960 "Source code on GitHub")
836
859
 
837
860
  Create a webhook
838
861
 
@@ -864,7 +887,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
864
887
 
865
888
  ### deleteWebhook
866
889
 
867
- [src/Particle.js:975-978](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L975-L978 "Source code on GitHub")
890
+ [src/Particle.js:972-975](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L972-L975 "Source code on GitHub")
868
891
 
869
892
  Delete a webhook
870
893
 
@@ -881,7 +904,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
881
904
 
882
905
  ### listWebhooks
883
906
 
884
- [src/Particle.js:989-992](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L989-L992 "Source code on GitHub")
907
+ [src/Particle.js:986-989](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L986-L989 "Source code on GitHub")
885
908
 
886
909
  List all webhooks owned by the account or product
887
910
 
@@ -897,7 +920,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
897
920
 
898
921
  ### createIntegration
899
922
 
900
- [src/Particle.js:1009-1013](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1009-L1013 "Source code on GitHub")
923
+ [src/Particle.js:1006-1010](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1006-L1010 "Source code on GitHub")
901
924
 
902
925
  Create an integration to send events to an external service
903
926
 
@@ -918,7 +941,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
918
941
 
919
942
  ### editIntegration
920
943
 
921
- [src/Particle.js:1031-1035](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1031-L1035 "Source code on GitHub")
944
+ [src/Particle.js:1028-1032](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1028-L1032 "Source code on GitHub")
922
945
 
923
946
  Edit an integration to send events to an external service
924
947
 
@@ -940,7 +963,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
940
963
 
941
964
  ### deleteIntegration
942
965
 
943
- [src/Particle.js:1048-1051](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1048-L1051 "Source code on GitHub")
966
+ [src/Particle.js:1045-1048](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1045-L1048 "Source code on GitHub")
944
967
 
945
968
  Delete an integration to send events to an external service
946
969
 
@@ -957,7 +980,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
957
980
 
958
981
  ### listIntegrations
959
982
 
960
- [src/Particle.js:1062-1065](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1062-L1065 "Source code on GitHub")
983
+ [src/Particle.js:1059-1062](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1059-L1062 "Source code on GitHub")
961
984
 
962
985
  List all integrations owned by the account or product
963
986
 
@@ -973,7 +996,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
973
996
 
974
997
  ### getUserInfo
975
998
 
976
- [src/Particle.js:1075-1077](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1075-L1077 "Source code on GitHub")
999
+ [src/Particle.js:1072-1074](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1072-L1074 "Source code on GitHub")
977
1000
 
978
1001
  Get details about the current user
979
1002
 
@@ -988,7 +1011,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
988
1011
 
989
1012
  ### setUserInfo
990
1013
 
991
- [src/Particle.js:1088-1091](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1088-L1091 "Source code on GitHub")
1014
+ [src/Particle.js:1085-1088](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1085-L1088 "Source code on GitHub")
992
1015
 
993
1016
  Set details on the current user
994
1017
 
@@ -1004,7 +1027,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1004
1027
 
1005
1028
  ### changeUsername
1006
1029
 
1007
- [src/Particle.js:1104-1112](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1104-L1112 "Source code on GitHub")
1030
+ [src/Particle.js:1101-1109](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1101-L1109 "Source code on GitHub")
1008
1031
 
1009
1032
  Change username (i.e, email)
1010
1033
 
@@ -1022,7 +1045,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1022
1045
 
1023
1046
  ### changeUserPassword
1024
1047
 
1025
- [src/Particle.js:1125-1133](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1125-L1133 "Source code on GitHub")
1048
+ [src/Particle.js:1122-1130](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1122-L1130 "Source code on GitHub")
1026
1049
 
1027
1050
  Change user's password
1028
1051
 
@@ -1040,7 +1063,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1040
1063
 
1041
1064
  ### listSIMs
1042
1065
 
1043
- [src/Particle.js:1149-1153](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1149-L1153 "Source code on GitHub")
1066
+ [src/Particle.js:1146-1150](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1146-L1150 "Source code on GitHub")
1044
1067
 
1045
1068
  List SIM cards owned by a user or product
1046
1069
 
@@ -1061,7 +1084,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1061
1084
 
1062
1085
  ### getSIMDataUsage
1063
1086
 
1064
- [src/Particle.js:1165-1171](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1165-L1171 "Source code on GitHub")
1087
+ [src/Particle.js:1162-1168](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1162-L1168 "Source code on GitHub")
1065
1088
 
1066
1089
  Get data usage for one SIM card for the current billing period
1067
1090
 
@@ -1078,7 +1101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1078
1101
 
1079
1102
  ### getFleetDataUsage
1080
1103
 
1081
- [src/Particle.js:1182-1189](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1182-L1189 "Source code on GitHub")
1104
+ [src/Particle.js:1179-1186](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1179-L1186 "Source code on GitHub")
1082
1105
 
1083
1106
  Get data usage for all SIM cards in a product the current billing period
1084
1107
 
@@ -1094,7 +1117,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1094
1117
 
1095
1118
  ### checkSIM
1096
1119
 
1097
- [src/Particle.js:1200-1202](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1200-L1202 "Source code on GitHub")
1120
+ [src/Particle.js:1197-1199](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1197-L1199 "Source code on GitHub")
1098
1121
 
1099
1122
  Check SIM status
1100
1123
 
@@ -1110,7 +1133,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1110
1133
 
1111
1134
  ### activateSIM
1112
1135
 
1113
- [src/Particle.js:1216-1226](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1216-L1226 "Source code on GitHub")
1136
+ [src/Particle.js:1213-1223](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1213-L1223 "Source code on GitHub")
1114
1137
 
1115
1138
  Activate and add SIM cards to an account or product
1116
1139
 
@@ -1130,7 +1153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1130
1153
 
1131
1154
  ### deactivateSIM
1132
1155
 
1133
- [src/Particle.js:1238-1242](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1238-L1242 "Source code on GitHub")
1156
+ [src/Particle.js:1235-1239](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1235-L1239 "Source code on GitHub")
1134
1157
 
1135
1158
  Deactivate a SIM card so it doesn't incur data usage in future months.
1136
1159
 
@@ -1147,7 +1170,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1147
1170
 
1148
1171
  ### reactivateSIM
1149
1172
 
1150
- [src/Particle.js:1255-1259](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1255-L1259 "Source code on GitHub")
1173
+ [src/Particle.js:1252-1256](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1252-L1256 "Source code on GitHub")
1151
1174
 
1152
1175
  Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
1153
1176
 
@@ -1165,7 +1188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1165
1188
 
1166
1189
  ### updateSIM
1167
1190
 
1168
- [src/Particle.js:1272-1276](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1272-L1276 "Source code on GitHub")
1191
+ [src/Particle.js:1269-1273](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1269-L1273 "Source code on GitHub")
1169
1192
 
1170
1193
  Update SIM card data limit
1171
1194
 
@@ -1183,7 +1206,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1183
1206
 
1184
1207
  ### removeSIM
1185
1208
 
1186
- [src/Particle.js:1288-1291](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1288-L1291 "Source code on GitHub")
1209
+ [src/Particle.js:1285-1288](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1285-L1288 "Source code on GitHub")
1187
1210
 
1188
1211
  Remove a SIM card from an account so it can be activated by a different account
1189
1212
 
@@ -1200,7 +1223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1200
1223
 
1201
1224
  ### listBuildTargets
1202
1225
 
1203
- [src/Particle.js:1302-1305](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1302-L1305 "Source code on GitHub")
1226
+ [src/Particle.js:1299-1302](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1299-L1302 "Source code on GitHub")
1204
1227
 
1205
1228
  List valid build targets to be used for compiling
1206
1229
 
@@ -1216,7 +1239,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1216
1239
 
1217
1240
  ### listLibraries
1218
1241
 
1219
- [src/Particle.js:1331-1348](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1331-L1348 "Source code on GitHub")
1242
+ [src/Particle.js:1328-1345](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1328-L1345 "Source code on GitHub")
1220
1243
 
1221
1244
  List firmware libraries
1222
1245
 
@@ -1245,7 +1268,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1245
1268
 
1246
1269
  ### getLibrary
1247
1270
 
1248
- [src/Particle.js:1364-1372](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1364-L1372 "Source code on GitHub")
1271
+ [src/Particle.js:1361-1369](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1361-L1369 "Source code on GitHub")
1249
1272
 
1250
1273
  Get firmware library details
1251
1274
 
@@ -1262,7 +1285,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1262
1285
 
1263
1286
  ### getLibraryVersions
1264
1287
 
1265
- [src/Particle.js:1385-1393](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1385-L1393 "Source code on GitHub")
1288
+ [src/Particle.js:1382-1390](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1382-L1390 "Source code on GitHub")
1266
1289
 
1267
1290
  Firmware library details for each version
1268
1291
 
@@ -1280,7 +1303,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1280
1303
 
1281
1304
  ### contributeLibrary
1282
1305
 
1283
- [src/Particle.js:1405-1418](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1405-L1418 "Source code on GitHub")
1306
+ [src/Particle.js:1402-1415](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1402-L1415 "Source code on GitHub")
1284
1307
 
1285
1308
  Contribute a new library version from a compressed archive
1286
1309
 
@@ -1297,7 +1320,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1297
1320
 
1298
1321
  ### publishLibrary
1299
1322
 
1300
- [src/Particle.js:1429-1438](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1429-L1438 "Source code on GitHub")
1323
+ [src/Particle.js:1426-1435](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1426-L1435 "Source code on GitHub")
1301
1324
 
1302
1325
  Publish the latest version of a library to the public
1303
1326
 
@@ -1313,7 +1336,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1313
1336
 
1314
1337
  ### deleteLibrary
1315
1338
 
1316
- [src/Particle.js:1450-1458](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1450-L1458 "Source code on GitHub")
1339
+ [src/Particle.js:1447-1455](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1447-L1455 "Source code on GitHub")
1317
1340
 
1318
1341
  Delete one version of a library or an entire private library
1319
1342
 
@@ -1330,7 +1353,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1330
1353
 
1331
1354
  ### downloadFile
1332
1355
 
1333
- [src/Particle.js:1468-1471](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1468-L1471 "Source code on GitHub")
1356
+ [src/Particle.js:1465-1467](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1465-L1467 "Source code on GitHub")
1334
1357
 
1335
1358
  Download an external file that may not be on the API
1336
1359
 
@@ -1345,7 +1368,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1345
1368
 
1346
1369
  ### listOAuthClients
1347
1370
 
1348
- [src/Particle.js:1482-1485](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1482-L1485 "Source code on GitHub")
1371
+ [src/Particle.js:1478-1481](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1478-L1481 "Source code on GitHub")
1349
1372
 
1350
1373
  List OAuth client created by the account
1351
1374
 
@@ -1361,7 +1384,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1361
1384
 
1362
1385
  ### createOAuthClient
1363
1386
 
1364
- [src/Particle.js:1500-1504](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1500-L1504 "Source code on GitHub")
1387
+ [src/Particle.js:1496-1500](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1496-L1500 "Source code on GitHub")
1365
1388
 
1366
1389
  Create an OAuth client
1367
1390
 
@@ -1381,7 +1404,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1381
1404
 
1382
1405
  ### updateOAuthClient
1383
1406
 
1384
- [src/Particle.js:1518-1522](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1518-L1522 "Source code on GitHub")
1407
+ [src/Particle.js:1514-1518](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1514-L1518 "Source code on GitHub")
1385
1408
 
1386
1409
  Update an OAuth client
1387
1410
 
@@ -1400,7 +1423,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1400
1423
 
1401
1424
  ### deleteOAuthClient
1402
1425
 
1403
- [src/Particle.js:1534-1537](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1534-L1537 "Source code on GitHub")
1426
+ [src/Particle.js:1530-1533](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1530-L1533 "Source code on GitHub")
1404
1427
 
1405
1428
  Delete an OAuth client
1406
1429
 
@@ -1417,7 +1440,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1417
1440
 
1418
1441
  ### listProducts
1419
1442
 
1420
- [src/Particle.js:1547-1549](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1547-L1549 "Source code on GitHub")
1443
+ [src/Particle.js:1543-1545](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1543-L1545 "Source code on GitHub")
1421
1444
 
1422
1445
  List products the account has access to
1423
1446
 
@@ -1432,7 +1455,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1432
1455
 
1433
1456
  ### getProduct
1434
1457
 
1435
- [src/Particle.js:1560-1562](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1560-L1562 "Source code on GitHub")
1458
+ [src/Particle.js:1556-1558](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1556-L1558 "Source code on GitHub")
1436
1459
 
1437
1460
  Get detailed information about a product
1438
1461
 
@@ -1448,7 +1471,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1448
1471
 
1449
1472
  ### listProductFirmware
1450
1473
 
1451
- [src/Particle.js:1573-1575](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1573-L1575 "Source code on GitHub")
1474
+ [src/Particle.js:1569-1571](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1569-L1571 "Source code on GitHub")
1452
1475
 
1453
1476
  List product firmware versions
1454
1477
 
@@ -1464,7 +1487,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1464
1487
 
1465
1488
  ### uploadProductFirmware
1466
1489
 
1467
- [src/Particle.js:1591-1607](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1591-L1607 "Source code on GitHub")
1490
+ [src/Particle.js:1587-1603](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1587-L1603 "Source code on GitHub")
1468
1491
 
1469
1492
  List product firmware versions
1470
1493
 
@@ -1485,7 +1508,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1485
1508
 
1486
1509
  ### getProductFirmware
1487
1510
 
1488
- [src/Particle.js:1619-1626](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1619-L1626 "Source code on GitHub")
1511
+ [src/Particle.js:1615-1622](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1615-L1622 "Source code on GitHub")
1489
1512
 
1490
1513
  Get information about a product firmware version
1491
1514
 
@@ -1502,7 +1525,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1502
1525
 
1503
1526
  ### updateProductFirmware
1504
1527
 
1505
- [src/Particle.js:1640-1643](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1640-L1643 "Source code on GitHub")
1528
+ [src/Particle.js:1636-1639](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1636-L1639 "Source code on GitHub")
1506
1529
 
1507
1530
  Update information for a product firmware version
1508
1531
 
@@ -1521,7 +1544,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1521
1544
 
1522
1545
  ### downloadProductFirmware
1523
1546
 
1524
- [src/Particle.js:1655-1666](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1655-L1666 "Source code on GitHub")
1547
+ [src/Particle.js:1651-1660](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1651-L1660 "Source code on GitHub")
1525
1548
 
1526
1549
  Download a product firmware binary
1527
1550
 
@@ -1538,7 +1561,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
1538
1561
 
1539
1562
  ### releaseProductFirmware
1540
1563
 
1541
- [src/Particle.js:1690-1693](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1690-L1693 "Source code on GitHub")
1564
+ [src/Particle.js:1672-1675](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1672-L1675 "Source code on GitHub")
1542
1565
 
1543
1566
  Release a product firmware version as the default version
1544
1567
 
@@ -1555,7 +1578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1555
1578
 
1556
1579
  ### listTeamMembers
1557
1580
 
1558
- [src/Particle.js:1704-1711](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1704-L1711 "Source code on GitHub")
1581
+ [src/Particle.js:1686-1693](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1686-L1693 "Source code on GitHub")
1559
1582
 
1560
1583
  List product team members
1561
1584
 
@@ -1571,7 +1594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1571
1594
 
1572
1595
  ### inviteTeamMember
1573
1596
 
1574
- [src/Particle.js:1723-1731](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1723-L1731 "Source code on GitHub")
1597
+ [src/Particle.js:1705-1713](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1705-L1713 "Source code on GitHub")
1575
1598
 
1576
1599
  Invite Particle user to a product team
1577
1600
 
@@ -1588,7 +1611,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1588
1611
 
1589
1612
  ### removeTeamMember
1590
1613
 
1591
- [src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1743-L1750 "Source code on GitHub")
1614
+ [src/Particle.js:1725-1732](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1725-L1732 "Source code on GitHub")
1592
1615
 
1593
1616
  Remove Particle user to a product team
1594
1617
 
@@ -1605,7 +1628,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1605
1628
 
1606
1629
  ### lookupSerialNumber
1607
1630
 
1608
- [src/Particle.js:1761-1768](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1761-L1768 "Source code on GitHub")
1631
+ [src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1743-L1750 "Source code on GitHub")
1609
1632
 
1610
1633
  Fetch details about a serial number
1611
1634
 
@@ -1621,7 +1644,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1621
1644
 
1622
1645
  ### createMeshNetwork
1623
1646
 
1624
- [src/Particle.js:1781-1789](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1781-L1789 "Source code on GitHub")
1647
+ [src/Particle.js:1763-1771](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1763-L1771 "Source code on GitHub")
1625
1648
 
1626
1649
  Create a mesh network
1627
1650
 
@@ -1639,7 +1662,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1639
1662
 
1640
1663
  ### removeMeshNetwork
1641
1664
 
1642
- [src/Particle.js:1800-1802](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1800-L1802 "Source code on GitHub")
1665
+ [src/Particle.js:1782-1784](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1782-L1784 "Source code on GitHub")
1643
1666
 
1644
1667
  Remove a mesh network.
1645
1668
 
@@ -1655,7 +1678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1655
1678
 
1656
1679
  ### listMeshNetworks
1657
1680
 
1658
- [src/Particle.js:1814-1817](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1814-L1817 "Source code on GitHub")
1681
+ [src/Particle.js:1796-1799](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1796-L1799 "Source code on GitHub")
1659
1682
 
1660
1683
  List all mesh networks
1661
1684
 
@@ -1672,7 +1695,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1672
1695
 
1673
1696
  ### getMeshNetwork
1674
1697
 
1675
- [src/Particle.js:1828-1830](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1828-L1830 "Source code on GitHub")
1698
+ [src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1810-L1812 "Source code on GitHub")
1676
1699
 
1677
1700
  Get information about a mesh network.
1678
1701
 
@@ -1688,7 +1711,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1688
1711
 
1689
1712
  ### updateMeshNetwork
1690
1713
 
1691
- [src/Particle.js:1843-1851](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1843-L1851 "Source code on GitHub")
1714
+ [src/Particle.js:1825-1833](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1825-L1833 "Source code on GitHub")
1692
1715
 
1693
1716
  Modify a mesh network.
1694
1717
 
@@ -1706,7 +1729,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1706
1729
 
1707
1730
  ### addMeshNetworkDevice
1708
1731
 
1709
- [src/Particle.js:1863-1872](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1863-L1872 "Source code on GitHub")
1732
+ [src/Particle.js:1845-1854](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1845-L1854 "Source code on GitHub")
1710
1733
 
1711
1734
  Add a device to a mesh network.
1712
1735
 
@@ -1723,7 +1746,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1723
1746
 
1724
1747
  ### removeMeshNetworkDevice
1725
1748
 
1726
- [src/Particle.js:1884-1900](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1884-L1900 "Source code on GitHub")
1749
+ [src/Particle.js:1866-1882](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1866-L1882 "Source code on GitHub")
1727
1750
 
1728
1751
  Remove a device from a mesh network.
1729
1752
 
@@ -1740,7 +1763,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1740
1763
 
1741
1764
  ### listMeshNetworkDevices
1742
1765
 
1743
- [src/Particle.js:1914-1923](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1914-L1923 "Source code on GitHub")
1766
+ [src/Particle.js:1896-1905](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1896-L1905 "Source code on GitHub")
1744
1767
 
1745
1768
  List all devices of a mesh network.
1746
1769
 
@@ -1759,7 +1782,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1759
1782
 
1760
1783
  ### getProductConfiguration
1761
1784
 
1762
- [src/Particle.js:1934-1941](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1934-L1941 "Source code on GitHub")
1785
+ [src/Particle.js:1916-1923](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1916-L1923 "Source code on GitHub")
1763
1786
 
1764
1787
  Get product configuration
1765
1788
 
@@ -1775,7 +1798,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1775
1798
 
1776
1799
  ### getProductConfigurationSchema
1777
1800
 
1778
- [src/Particle.js:1952-1960](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1952-L1960 "Source code on GitHub")
1801
+ [src/Particle.js:1934-1942](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1934-L1942 "Source code on GitHub")
1779
1802
 
1780
1803
  Get product configuration schema
1781
1804
 
@@ -1791,7 +1814,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1791
1814
 
1792
1815
  ### getProductDeviceConfiguration
1793
1816
 
1794
- [src/Particle.js:1972-1979](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1972-L1979 "Source code on GitHub")
1817
+ [src/Particle.js:1954-1961](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1954-L1961 "Source code on GitHub")
1795
1818
 
1796
1819
  Get product device's configuration
1797
1820
 
@@ -1808,7 +1831,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1808
1831
 
1809
1832
  ### getProductDeviceConfigurationSchema
1810
1833
 
1811
- [src/Particle.js:1991-1999](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L1991-L1999 "Source code on GitHub")
1834
+ [src/Particle.js:1973-1981](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1973-L1981 "Source code on GitHub")
1812
1835
 
1813
1836
  Get product device's configuration schema
1814
1837
 
@@ -1825,7 +1848,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1825
1848
 
1826
1849
  ### setProductConfiguration
1827
1850
 
1828
- [src/Particle.js:2011-2019](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L2011-L2019 "Source code on GitHub")
1851
+ [src/Particle.js:1993-2001](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L1993-L2001 "Source code on GitHub")
1829
1852
 
1830
1853
  Set product configuration
1831
1854
 
@@ -1842,7 +1865,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1842
1865
 
1843
1866
  ### setProductDeviceConfiguration
1844
1867
 
1845
- [src/Particle.js:2032-2040](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L2032-L2040 "Source code on GitHub")
1868
+ [src/Particle.js:2014-2022](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2014-L2022 "Source code on GitHub")
1846
1869
 
1847
1870
  Set product configuration for a specific device within the product
1848
1871
 
@@ -1860,7 +1883,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1860
1883
 
1861
1884
  ### getProductLocations
1862
1885
 
1863
- [src/Particle.js:2059-2076](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L2059-L2076 "Source code on GitHub")
1886
+ [src/Particle.js:2041-2058](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2041-L2058 "Source code on GitHub")
1864
1887
 
1865
1888
  Query location for devices within a product
1866
1889
 
@@ -1884,7 +1907,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
1884
1907
 
1885
1908
  ### getProductDeviceLocations
1886
1909
 
1887
- [src/Particle.js:2093-2105](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L2093-L2105 "Source code on GitHub")
1910
+ [src/Particle.js:2075-2087](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2075-L2087 "Source code on GitHub")
1888
1911
 
1889
1912
  Query location for one device within a product
1890
1913
 
@@ -1902,9 +1925,314 @@ Query location for one device within a product
1902
1925
 
1903
1926
  Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1904
1927
 
1928
+ ### createLogicBlock
1929
+
1930
+ [src/Particle.js:2107-2115](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2107-L2115 "Source code on GitHub")
1931
+
1932
+ Creates a new logic block in the specified organization using the provided block data.
1933
+
1934
+ When you create a logic block with PubSub matchers, events will immediately
1935
+ start being handled by the block code.
1936
+
1937
+ When you create a Chron matcher, it will immediately be scheduled at the next time
1938
+ according to the cron and start_at properties.
1939
+
1940
+ **Parameters**
1941
+
1942
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic block.
1943
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
1944
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
1945
+ - `options.block` **Block** The block object containing the block details.
1946
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
1947
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1948
+
1949
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block: ResponseBlock}, statusCode: int}>** A promise that resolves to the created logic block data.
1950
+
1951
+ ### getLogicBlock
1952
+
1953
+ [src/Particle.js:2129-2136](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2129-L2136 "Source code on GitHub")
1954
+
1955
+ Get a logic block in the specified organization by block ID.
1956
+
1957
+ **Parameters**
1958
+
1959
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic block.
1960
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
1961
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
1962
+ - `options.blockId` **Block** The ID of the block to retrieve.
1963
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
1964
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1965
+
1966
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block: ResponseBlock}, statusCode: int}>** A promise that resolves to the specified logic block data.
1967
+
1968
+ ### updateLogicBlock
1969
+
1970
+ [src/Particle.js:2153-2161](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2153-L2161 "Source code on GitHub")
1971
+
1972
+ Updates an existing logic block in the specified organization using the provided block data.
1973
+
1974
+ If you include an id on a matcher, it will update the matcher in place.
1975
+
1976
+ **Parameters**
1977
+
1978
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic block.
1979
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
1980
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
1981
+ - `options.blockId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the block to update.
1982
+ - `options.block` **Block** The block object containing the block details.
1983
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
1984
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
1985
+
1986
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block: ResponseBlock}, statusCode: int}>** A promise that resolves to the updated logic block data.
1987
+
1988
+ ### deleteLogicBlock
1989
+
1990
+ [src/Particle.js:2175-2182](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2175-L2182 "Source code on GitHub")
1991
+
1992
+ Deletes a logic block in the specified organization by block ID.
1993
+
1994
+ **Parameters**
1995
+
1996
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic block.
1997
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
1998
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
1999
+ - `options.blockId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the block to delete.
2000
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2001
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2002
+
2003
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block_id: int}, statusCode: int}>** A promise that resolves to an object containing the deleted block ID.
2004
+
2005
+ ### listLogicBlocks
2006
+
2007
+ [src/Particle.js:2195-2202](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2195-L2202 "Source code on GitHub")
2008
+
2009
+ Lists all logic blocks in the specified organization.
2010
+
2011
+ **Parameters**
2012
+
2013
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic blocks.
2014
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2015
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2016
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2017
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2018
+
2019
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {blocks: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<ResponseBlock>}, statusCode: int}>** A promise that resolves to an array of logic block data.
2020
+
2021
+ ### listBlockRuns
2022
+
2023
+ [src/Particle.js:2216-2223](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2216-L2223 "Source code on GitHub")
2024
+
2025
+ Lists all block runs for the specified block.
2026
+
2027
+ **Parameters**
2028
+
2029
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2030
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2031
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2032
+ - `options.blockId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the block for which to retrieve the block runs.
2033
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2034
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2035
+
2036
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block_runs: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BlockRun>}, statusCode: int}>** A promise that resolves to an array of block run data.
2037
+
2038
+ ### getBlockRun
2039
+
2040
+ [src/Particle.js:2238-2245](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2238-L2245 "Source code on GitHub")
2041
+
2042
+ Retrieves a block run by its ID for the specified block.
2043
+
2044
+ **Parameters**
2045
+
2046
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2047
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2048
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2049
+ - `options.blockId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the block for which to retrieve the block run.
2050
+ - `options.runId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the block run to retrieve.
2051
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2052
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2053
+
2054
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block_run: BlockRun}, statusCode: int}>** A promise that resolves to an array of block run data for the specified block run ID.
2055
+
2056
+ ### getBlockRunLog
2057
+
2058
+ [src/Particle.js:2260-2267](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2260-L2267 "Source code on GitHub")
2059
+
2060
+ Retrieves the logs for a block run by its ID for the specified block.
2061
+
2062
+ **Parameters**
2063
+
2064
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2065
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2066
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2067
+ - `options.blockId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the block for which to retrieve the block run logs.
2068
+ - `options.runId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the block run for which to retrieve the logs.
2069
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2070
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2071
+
2072
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {block_run_log: BlockRunLog}, statusCode: int}>** A promise that resolves to the logs for the specified block run ID.
2073
+
2074
+ ### createLedger
2075
+
2076
+ [src/Particle.js:2281-2289](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2281-L2289 "Source code on GitHub")
2077
+
2078
+ Creates a new ledger definition in the specified organization.
2079
+
2080
+ **Parameters**
2081
+
2082
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
2083
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2084
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
2085
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2086
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2087
+ - `options.definition` **Ledger** The ledger definition object.
2088
+ - `options.ledger`
2089
+
2090
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {ledger: ResponseLedger}, statusCode: int}>** A promise that resolves to the created ledger definition data.
2091
+
2092
+ ### getLedger
2093
+
2094
+ [src/Particle.js:2303-2310](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2303-L2310 "Source code on GitHub")
2095
+
2096
+ Get a ledger definition in the specified organization by ledger name.
2097
+
2098
+ **Parameters**
2099
+
2100
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
2101
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2102
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
2103
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
2104
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2105
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2106
+
2107
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {ledger: ResponseLedger}, statusCode: int}>** A promise that resolves to the specified ledger definition data.
2108
+
2109
+ ### updateLedger
2110
+
2111
+ [src/Particle.js:2325-2333](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2325-L2333 "Source code on GitHub")
2112
+
2113
+ Updates an existing ledger definition in the specified organization.
2114
+
2115
+ **Parameters**
2116
+
2117
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
2118
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2119
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2120
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
2121
+ - `options.ledger` **Ledger** The ledger definition object.
2122
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2123
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2124
+
2125
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {ledger: ResponseLedger}, statusCode: int}>** A promise that resolves to the updated ledger definition data.
2126
+
2127
+ ### archiveLedger
2128
+
2129
+ [src/Particle.js:2347-2354](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2347-L2354 "Source code on GitHub")
2130
+
2131
+ Archives a ledger definition in the specified organization by ledger name.
2132
+
2133
+ **Parameters**
2134
+
2135
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
2136
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2137
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2138
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
2139
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2140
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2141
+
2142
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined), statusCode: int}>** A promise that resolves to an object confirming the ledger definition was archived.
2143
+
2144
+ ### listLedgers
2145
+
2146
+ [src/Particle.js:2367-2374](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2367-L2374 "Source code on GitHub")
2147
+
2148
+ Lists all ledger definitions in the specified organization.
2149
+
2150
+ **Parameters**
2151
+
2152
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
2153
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2154
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2155
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2156
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2157
+
2158
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {ledgers: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<ResponseLedger>}, statusCode: int}>** A promise that resolves to an array of ledger definition data.
2159
+
2160
+ ### getLedgerInstance
2161
+
2162
+ [src/Particle.js:2389-2396](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2389-L2396 "Source code on GitHub")
2163
+
2164
+ Get ledger instance data.
2165
+
2166
+ **Parameters**
2167
+
2168
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
2169
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
2170
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
2171
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2172
+ - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2173
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2174
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2175
+
2176
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {instance: ResponseLedgerInstance}, statusCode: int}>** A promise that resolves to the specified ledger instance data.
2177
+
2178
+ ### setLedgerInstance
2179
+
2180
+ [src/Particle.js:2412-2420](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2412-L2420 "Source code on GitHub")
2181
+
2182
+ Set ledger instance data.
2183
+
2184
+ **Parameters**
2185
+
2186
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
2187
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2188
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2189
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2190
+ - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2191
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2192
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2193
+ - `options.instance` **LedgerInstance** The ledger instance object.
2194
+ - `options.data`
2195
+
2196
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {instance: ResponseLedgerInstance}, statusCode: int}>** A promise that resolves to the updated ledger instance data.
2197
+
2198
+ ### deleteLedgerInstance
2199
+
2200
+ [src/Particle.js:2435-2442](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2435-L2442 "Source code on GitHub")
2201
+
2202
+ Delete a ledger instance in the specified organization by ledger name.
2203
+
2204
+ **Parameters**
2205
+
2206
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
2207
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2208
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2209
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
2210
+ - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2211
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2212
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2213
+
2214
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined), statusCode: int}>** A promise that resolves to an object confirming the ledger instance was deleted.
2215
+
2216
+ ### listLedgerInstances
2217
+
2218
+ [src/Particle.js:2456-2463](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2456-L2463 "Source code on GitHub")
2219
+
2220
+ Lists ledger instances.
2221
+
2222
+ **Parameters**
2223
+
2224
+ - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
2225
+ - `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
2226
+ - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
2227
+ - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
2228
+ - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2229
+ - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2230
+
2231
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{body: {instances: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<ResponseLedgerInstance>}, statusCode: int}>** A promise that resolves to an array of ledger instance data.
2232
+
1905
2233
  ### setDefaultAuth
1906
2234
 
1907
- [src/Particle.js:2112-2118](https://github.com/particle-iot/particle-api-js/blob/83a578a162af54ab6e77b4158061864063b96c4a/src/Particle.js#L2112-L2118 "Source code on GitHub")
2235
+ [src/Particle.js:2470-2476](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2470-L2476 "Source code on GitHub")
1908
2236
 
1909
2237
  Set default auth token that will be used in each method if `auth` is not provided
1910
2238
 
@@ -1913,3 +2241,133 @@ Set default auth token that will be used in each method if `auth` is not provide
1913
2241
  - `auth` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** A Particle access token
1914
2242
 
1915
2243
  Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
2244
+
2245
+ ### get
2246
+
2247
+ [src/Particle.js:2507-2511](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2507-L2511 "Source code on GitHub")
2248
+
2249
+ Make a GET request
2250
+
2251
+ **Parameters**
2252
+
2253
+ - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2254
+ - `$0.uri`
2255
+ - `$0.auth`
2256
+ - `$0.headers`
2257
+ - `$0.query`
2258
+ - `$0.context`
2259
+ - `uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2260
+ - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2261
+ - `headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2262
+ - `query` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Key/VAlue pairs of query params or a correctly formatted string
2263
+ - `object` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** \[ The invocation context, describing the tool and project
2264
+
2265
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2266
+
2267
+ ### head
2268
+
2269
+ [src/Particle.js:2522-2526](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2522-L2526 "Source code on GitHub")
2270
+
2271
+ Make a HEAD request
2272
+
2273
+ **Parameters**
2274
+
2275
+ - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2276
+ - `$0.uri`
2277
+ - `$0.auth`
2278
+ - `$0.headers`
2279
+ - `$0.query`
2280
+ - `$0.context`
2281
+ - `uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2282
+ - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2283
+ - `headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2284
+ - `query` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Key/VAlue pairs of query params or a correctly formatted string
2285
+ - `context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2286
+
2287
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2288
+
2289
+ ### post
2290
+
2291
+ [src/Particle.js:2537-2541](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2537-L2541 "Source code on GitHub")
2292
+
2293
+ Make a POST request
2294
+
2295
+ **Parameters**
2296
+
2297
+ - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2298
+ - `$0.uri`
2299
+ - `$0.auth`
2300
+ - `$0.headers`
2301
+ - `$0.data`
2302
+ - `$0.context`
2303
+ - `uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2304
+ - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2305
+ - `headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2306
+ - `query` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Key/VAlue pairs of query params or a correctly formatted string
2307
+ - `context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2308
+
2309
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2310
+
2311
+ ### put
2312
+
2313
+ [src/Particle.js:2552-2556](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2552-L2556 "Source code on GitHub")
2314
+
2315
+ Make a PUT request
2316
+
2317
+ **Parameters**
2318
+
2319
+ - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2320
+ - `$0.uri`
2321
+ - `$0.auth`
2322
+ - `$0.headers`
2323
+ - `$0.data`
2324
+ - `$0.context`
2325
+ - `uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2326
+ - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2327
+ - `headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2328
+ - `query` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Key/VAlue pairs of query params or a correctly formatted string
2329
+ - `context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2330
+
2331
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2332
+
2333
+ ### delete
2334
+
2335
+ [src/Particle.js:2567-2571](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2567-L2571 "Source code on GitHub")
2336
+
2337
+ Make a DELETE request
2338
+
2339
+ **Parameters**
2340
+
2341
+ - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2342
+ - `$0.uri`
2343
+ - `$0.auth`
2344
+ - `$0.headers`
2345
+ - `$0.data`
2346
+ - `$0.context`
2347
+ - `uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2348
+ - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2349
+ - `headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2350
+ - `query` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Key/VAlue pairs of query params or a correctly formatted string
2351
+ - `context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2352
+
2353
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2354
+
2355
+ ### request
2356
+
2357
+ [src/Particle.js:2588-2592](https://github.com/particle-iot/particle-api-js/blob/ee805eb12ec428a5789a588b1c9aed27485ad1ca/src/Particle.js#L2588-L2592 "Source code on GitHub")
2358
+
2359
+ **Parameters**
2360
+
2361
+ - `args` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** An obj with all the possible request configurations
2362
+ - `args.uri` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2363
+ - `args.method` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The method used to request the URI, should be in uppercase.
2364
+ - `args.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2365
+ - `args.data` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Arbitrary data to send as the body.
2366
+ - `args.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Authorization
2367
+ - `args.query` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** Query parameters
2368
+ - `args.form` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Form fields
2369
+ - `args.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Array of file names and file content
2370
+ - `args.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The invocation context, describing the tool and project.
2371
+ - `args.isBuffer` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Indicate if the response should be treated as Buffer instead of JSON
2372
+
2373
+ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object