particle-api-js 9.4.0 → 9.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +3 -3
- package/CHANGELOG.md +4 -0
- package/docs/api.md +103 -103
- package/package.json +5 -6
- package/test/Agent.spec.js +4 -3
- package/test/EventStream.spec.js +1 -1
package/.eslintrc.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
module.exports = {
|
|
2
2
|
extends: ['eslint-config-particle'],
|
|
3
3
|
parserOptions: {
|
|
4
|
-
ecmaVersion: 8,
|
|
5
4
|
sourceType: 'module'
|
|
6
5
|
},
|
|
7
6
|
env: {
|
|
@@ -14,8 +13,9 @@ module.exports = {
|
|
|
14
13
|
serviceworker: true
|
|
15
14
|
},
|
|
16
15
|
rules: {
|
|
17
|
-
'no-
|
|
18
|
-
|
|
16
|
+
'no-prototype-builtins': 'off',
|
|
17
|
+
'no-redeclare': 'off',
|
|
18
|
+
camelcase: ['error', {
|
|
19
19
|
properties: 'never',
|
|
20
20
|
allow: ['redirect_uri']
|
|
21
21
|
}]
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# changelog
|
|
2
2
|
|
|
3
|
+
## 9.4.1 - 17 June 2022
|
|
4
|
+
|
|
5
|
+
* Fixes incompatible versions of `eslint`, `chai`, `sinon-chai` and `chai-as-promised`.
|
|
6
|
+
|
|
3
7
|
## 9.4.0 - 14 June 2022
|
|
4
8
|
|
|
5
9
|
* Adds `.setDefaultAuth(auth)` so token authenticated methods don't need to pass their own auth token.
|
package/docs/api.md
CHANGED
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
|
|
109
109
|
## Particle
|
|
110
110
|
|
|
111
|
-
[src/Particle.js:17-2185](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
112
112
|
|
|
113
113
|
Particle Cloud API wrapper.
|
|
114
114
|
|
|
@@ -124,7 +124,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
124
124
|
|
|
125
125
|
### constructor
|
|
126
126
|
|
|
127
|
-
[src/Particle.js:25-34](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
128
128
|
|
|
129
129
|
Contructor for the Cloud API wrapper.
|
|
130
130
|
|
|
@@ -136,7 +136,7 @@ Create a new Particle object and call methods below on it.
|
|
|
136
136
|
|
|
137
137
|
### login
|
|
138
138
|
|
|
139
|
-
[src/Particle.js:70-85](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
140
140
|
|
|
141
141
|
Login to Particle Cloud using an existing Particle acccount.
|
|
142
142
|
|
|
@@ -153,7 +153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
153
153
|
|
|
154
154
|
### sendOtp
|
|
155
155
|
|
|
156
|
-
[src/Particle.js:96-110](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
157
157
|
|
|
158
158
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
159
159
|
|
|
@@ -169,7 +169,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
169
169
|
|
|
170
170
|
### enableMfa
|
|
171
171
|
|
|
172
|
-
[src/Particle.js:120-122](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
173
173
|
|
|
174
174
|
Enable MFA on the currently logged in user
|
|
175
175
|
|
|
@@ -184,7 +184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
184
184
|
|
|
185
185
|
### confirmMfa
|
|
186
186
|
|
|
187
|
-
[src/Particle.js:135-149](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
188
188
|
|
|
189
189
|
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
190
|
|
|
@@ -202,7 +202,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
202
202
|
|
|
203
203
|
### disableMfa
|
|
204
204
|
|
|
205
|
-
[src/Particle.js:160-168](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
206
206
|
|
|
207
207
|
Disable MFA for the user.
|
|
208
208
|
|
|
@@ -218,7 +218,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
218
218
|
|
|
219
219
|
### createCustomer
|
|
220
220
|
|
|
221
|
-
[src/Particle.js:180-194](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
222
222
|
|
|
223
223
|
Create Customer for Product.
|
|
224
224
|
|
|
@@ -235,7 +235,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
235
235
|
|
|
236
236
|
### loginAsClientOwner
|
|
237
237
|
|
|
238
|
-
[src/Particle.js:203-215](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
239
239
|
|
|
240
240
|
Login to Particle Cloud using an OAuth client.
|
|
241
241
|
|
|
@@ -249,7 +249,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
249
249
|
|
|
250
250
|
### createUser
|
|
251
251
|
|
|
252
|
-
[src/Particle.js:227-238](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
253
253
|
|
|
254
254
|
Create a user account for the Particle Cloud
|
|
255
255
|
|
|
@@ -266,7 +266,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
266
266
|
|
|
267
267
|
### verifyUser
|
|
268
268
|
|
|
269
|
-
[src/Particle.js:248-255](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
270
270
|
|
|
271
271
|
Verify new user account via verification email
|
|
272
272
|
|
|
@@ -281,7 +281,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
281
281
|
|
|
282
282
|
### resetPassword
|
|
283
283
|
|
|
284
|
-
[src/Particle.js:265-272](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
285
285
|
|
|
286
286
|
Send reset password email for a Particle Cloud user account
|
|
287
287
|
|
|
@@ -296,7 +296,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
296
296
|
|
|
297
297
|
### deleteAccessToken
|
|
298
298
|
|
|
299
|
-
[src/Particle.js:284-292](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
300
300
|
|
|
301
301
|
Revoke an access token
|
|
302
302
|
|
|
@@ -313,7 +313,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
313
313
|
|
|
314
314
|
### deleteCurrentAccessToken
|
|
315
315
|
|
|
316
|
-
[src/Particle.js:302-309](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
317
317
|
|
|
318
318
|
Revoke the current session access token
|
|
319
319
|
|
|
@@ -328,7 +328,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
328
328
|
|
|
329
329
|
### deleteActiveAccessTokens
|
|
330
330
|
|
|
331
|
-
[src/Particle.js:319-326](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
332
332
|
|
|
333
333
|
Revoke all active access tokens
|
|
334
334
|
|
|
@@ -343,7 +343,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
343
343
|
|
|
344
344
|
### deleteUser
|
|
345
345
|
|
|
346
|
-
[src/Particle.js:337-345](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
347
347
|
|
|
348
348
|
Delete the current user
|
|
349
349
|
|
|
@@ -359,7 +359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
359
359
|
|
|
360
360
|
### listAccessTokens
|
|
361
361
|
|
|
362
|
-
[src/Particle.js:357-365](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
363
363
|
|
|
364
364
|
List all valid access tokens for a Particle Cloud account
|
|
365
365
|
|
|
@@ -376,7 +376,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
376
376
|
|
|
377
377
|
### trackingIdentity
|
|
378
378
|
|
|
379
|
-
[src/Particle.js:377-385](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
380
380
|
|
|
381
381
|
Retrieves the information that is used to identify the current login for tracking.
|
|
382
382
|
|
|
@@ -393,7 +393,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
393
393
|
|
|
394
394
|
### listDevices
|
|
395
395
|
|
|
396
|
-
[src/Particle.js:403-415](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
397
397
|
|
|
398
398
|
List devices claimed to the account or product
|
|
399
399
|
|
|
@@ -416,7 +416,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
416
416
|
|
|
417
417
|
### getDevice
|
|
418
418
|
|
|
419
|
-
[src/Particle.js:427-430](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
420
420
|
|
|
421
421
|
Get detailed informationa about a device
|
|
422
422
|
|
|
@@ -433,7 +433,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
433
433
|
|
|
434
434
|
### claimDevice
|
|
435
435
|
|
|
436
|
-
[src/Particle.js:441-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
437
437
|
|
|
438
438
|
Claim a device to the account. The device must be online and unclaimed.
|
|
439
439
|
|
|
@@ -450,7 +450,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
450
450
|
|
|
451
451
|
### addDeviceToProduct
|
|
452
452
|
|
|
453
|
-
[src/Particle.js:466-484](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
454
454
|
|
|
455
455
|
Add a device to a product or move device out of quarantine.
|
|
456
456
|
|
|
@@ -469,7 +469,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
469
469
|
|
|
470
470
|
### removeDevice
|
|
471
471
|
|
|
472
|
-
[src/Particle.js:497-501](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
473
473
|
|
|
474
474
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
475
475
|
|
|
@@ -487,7 +487,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
487
487
|
|
|
488
488
|
### removeDeviceOwner
|
|
489
489
|
|
|
490
|
-
[src/Particle.js:513-516](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
491
491
|
|
|
492
492
|
Unclaim a product device its the owner, but keep it in the product
|
|
493
493
|
|
|
@@ -504,7 +504,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
504
504
|
|
|
505
505
|
### renameDevice
|
|
506
506
|
|
|
507
|
-
[src/Particle.js:529-531](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
508
508
|
|
|
509
509
|
Rename a device
|
|
510
510
|
|
|
@@ -522,7 +522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
522
522
|
|
|
523
523
|
### signalDevice
|
|
524
524
|
|
|
525
|
-
[src/Particle.js:544-546](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
526
526
|
|
|
527
527
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
528
528
|
|
|
@@ -540,7 +540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
540
540
|
|
|
541
541
|
### setDeviceNotes
|
|
542
542
|
|
|
543
|
-
[src/Particle.js:559-561](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
544
544
|
|
|
545
545
|
Store some notes about device
|
|
546
546
|
|
|
@@ -558,7 +558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
558
558
|
|
|
559
559
|
### markAsDevelopmentDevice
|
|
560
560
|
|
|
561
|
-
[src/Particle.js:574-576](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
562
562
|
|
|
563
563
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
564
564
|
|
|
@@ -576,7 +576,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
576
576
|
|
|
577
577
|
### lockDeviceProductFirmware
|
|
578
578
|
|
|
579
|
-
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
580
580
|
|
|
581
581
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
582
582
|
|
|
@@ -595,7 +595,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
595
595
|
|
|
596
596
|
### unlockDeviceProductFirmware
|
|
597
597
|
|
|
598
|
-
[src/Particle.js:604-606](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
599
599
|
|
|
600
600
|
Mark device as receiving automatic firmware updates
|
|
601
601
|
|
|
@@ -612,7 +612,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
612
612
|
|
|
613
613
|
### updateDevice
|
|
614
614
|
|
|
615
|
-
[src/Particle.js:625-636](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
616
616
|
|
|
617
617
|
Update multiple device attributes at the same time
|
|
618
618
|
|
|
@@ -636,7 +636,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
636
636
|
|
|
637
637
|
### provisionDevice
|
|
638
638
|
|
|
639
|
-
[src/Particle.js:647-655](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
640
640
|
|
|
641
641
|
Provision a new device for products that allow self-provisioning
|
|
642
642
|
|
|
@@ -652,7 +652,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
652
652
|
|
|
653
653
|
### getClaimCode
|
|
654
654
|
|
|
655
|
-
[src/Particle.js:669-672](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
656
656
|
|
|
657
657
|
Generate a claim code to use in the device claiming process.
|
|
658
658
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -671,7 +671,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
671
671
|
|
|
672
672
|
### getVariable
|
|
673
673
|
|
|
674
|
-
[src/Particle.js:704-710](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
675
675
|
|
|
676
676
|
Get the value of a device variable
|
|
677
677
|
|
|
@@ -689,7 +689,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
689
689
|
|
|
690
690
|
### flashDevice
|
|
691
691
|
|
|
692
|
-
[src/Particle.js:724-735](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
693
693
|
|
|
694
694
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
695
695
|
|
|
@@ -708,7 +708,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
708
708
|
|
|
709
709
|
### flashTinker
|
|
710
710
|
|
|
711
|
-
[src/Particle.js:746-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
712
712
|
|
|
713
713
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
714
714
|
|
|
@@ -724,7 +724,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
724
724
|
|
|
725
725
|
### compileCode
|
|
726
726
|
|
|
727
|
-
[src/Particle.js:772-790](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
728
728
|
|
|
729
729
|
Compile firmware using the Particle Cloud
|
|
730
730
|
|
|
@@ -742,7 +742,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
742
742
|
|
|
743
743
|
### downloadFirmwareBinary
|
|
744
744
|
|
|
745
|
-
[src/Particle.js:801-812](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
746
746
|
|
|
747
747
|
Download a firmware binary
|
|
748
748
|
|
|
@@ -758,7 +758,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
|
|
|
758
758
|
|
|
759
759
|
### sendPublicKey
|
|
760
760
|
|
|
761
|
-
[src/Particle.js:825-839](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
762
762
|
|
|
763
763
|
Send a new device public key to the Particle Cloud
|
|
764
764
|
|
|
@@ -776,7 +776,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
776
776
|
|
|
777
777
|
### callFunction
|
|
778
778
|
|
|
779
|
-
[src/Particle.js:853-858](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
780
780
|
|
|
781
781
|
Call a device function
|
|
782
782
|
|
|
@@ -795,7 +795,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
795
795
|
|
|
796
796
|
### getEventStream
|
|
797
797
|
|
|
798
|
-
[src/Particle.js:871-896](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
799
799
|
|
|
800
800
|
Get a stream of events
|
|
801
801
|
|
|
@@ -813,7 +813,7 @@ emit 'event' events.
|
|
|
813
813
|
|
|
814
814
|
### publishEvent
|
|
815
815
|
|
|
816
|
-
[src/Particle.js:910-914](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
817
817
|
|
|
818
818
|
Publish a event to the Particle Cloud
|
|
819
819
|
|
|
@@ -832,7 +832,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
832
832
|
|
|
833
833
|
### createWebhook
|
|
834
834
|
|
|
835
|
-
[src/Particle.js:941-963](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
836
836
|
|
|
837
837
|
Create a webhook
|
|
838
838
|
|
|
@@ -864,7 +864,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
864
864
|
|
|
865
865
|
### deleteWebhook
|
|
866
866
|
|
|
867
|
-
[src/Particle.js:975-978](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
868
868
|
|
|
869
869
|
Delete a webhook
|
|
870
870
|
|
|
@@ -881,7 +881,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
881
881
|
|
|
882
882
|
### listWebhooks
|
|
883
883
|
|
|
884
|
-
[src/Particle.js:989-992](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
885
885
|
|
|
886
886
|
List all webhooks owned by the account or product
|
|
887
887
|
|
|
@@ -897,7 +897,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
897
897
|
|
|
898
898
|
### createIntegration
|
|
899
899
|
|
|
900
|
-
[src/Particle.js:1009-1013](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
901
901
|
|
|
902
902
|
Create an integration to send events to an external service
|
|
903
903
|
|
|
@@ -918,7 +918,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
918
918
|
|
|
919
919
|
### editIntegration
|
|
920
920
|
|
|
921
|
-
[src/Particle.js:1031-1035](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
922
922
|
|
|
923
923
|
Edit an integration to send events to an external service
|
|
924
924
|
|
|
@@ -940,7 +940,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
940
940
|
|
|
941
941
|
### deleteIntegration
|
|
942
942
|
|
|
943
|
-
[src/Particle.js:1048-1051](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
944
944
|
|
|
945
945
|
Delete an integration to send events to an external service
|
|
946
946
|
|
|
@@ -957,7 +957,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
957
957
|
|
|
958
958
|
### listIntegrations
|
|
959
959
|
|
|
960
|
-
[src/Particle.js:1062-1065](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
961
961
|
|
|
962
962
|
List all integrations owned by the account or product
|
|
963
963
|
|
|
@@ -973,7 +973,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
973
973
|
|
|
974
974
|
### getUserInfo
|
|
975
975
|
|
|
976
|
-
[src/Particle.js:1075-1077](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
977
977
|
|
|
978
978
|
Get details about the current user
|
|
979
979
|
|
|
@@ -988,7 +988,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
988
988
|
|
|
989
989
|
### setUserInfo
|
|
990
990
|
|
|
991
|
-
[src/Particle.js:1088-1091](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
992
992
|
|
|
993
993
|
Set details on the current user
|
|
994
994
|
|
|
@@ -1004,7 +1004,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1004
1004
|
|
|
1005
1005
|
### changeUsername
|
|
1006
1006
|
|
|
1007
|
-
[src/Particle.js:1104-1112](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1008
1008
|
|
|
1009
1009
|
Change username (i.e, email)
|
|
1010
1010
|
|
|
@@ -1022,7 +1022,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1022
1022
|
|
|
1023
1023
|
### changeUserPassword
|
|
1024
1024
|
|
|
1025
|
-
[src/Particle.js:1125-1133](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1026
1026
|
|
|
1027
1027
|
Change user's password
|
|
1028
1028
|
|
|
@@ -1040,7 +1040,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1040
1040
|
|
|
1041
1041
|
### listSIMs
|
|
1042
1042
|
|
|
1043
|
-
[src/Particle.js:1149-1153](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1044
1044
|
|
|
1045
1045
|
List SIM cards owned by a user or product
|
|
1046
1046
|
|
|
@@ -1061,7 +1061,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1061
1061
|
|
|
1062
1062
|
### getSIMDataUsage
|
|
1063
1063
|
|
|
1064
|
-
[src/Particle.js:1165-1171](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1065
1065
|
|
|
1066
1066
|
Get data usage for one SIM card for the current billing period
|
|
1067
1067
|
|
|
@@ -1078,7 +1078,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1078
1078
|
|
|
1079
1079
|
### getFleetDataUsage
|
|
1080
1080
|
|
|
1081
|
-
[src/Particle.js:1182-1189](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1082
1082
|
|
|
1083
1083
|
Get data usage for all SIM cards in a product the current billing period
|
|
1084
1084
|
|
|
@@ -1094,7 +1094,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1094
1094
|
|
|
1095
1095
|
### checkSIM
|
|
1096
1096
|
|
|
1097
|
-
[src/Particle.js:1200-1202](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1098
1098
|
|
|
1099
1099
|
Check SIM status
|
|
1100
1100
|
|
|
@@ -1110,7 +1110,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1110
1110
|
|
|
1111
1111
|
### activateSIM
|
|
1112
1112
|
|
|
1113
|
-
[src/Particle.js:1216-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1114
1114
|
|
|
1115
1115
|
Activate and add SIM cards to an account or product
|
|
1116
1116
|
|
|
@@ -1130,7 +1130,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1130
1130
|
|
|
1131
1131
|
### deactivateSIM
|
|
1132
1132
|
|
|
1133
|
-
[src/Particle.js:1238-1242](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1134
1134
|
|
|
1135
1135
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1136
1136
|
|
|
@@ -1147,7 +1147,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1147
1147
|
|
|
1148
1148
|
### reactivateSIM
|
|
1149
1149
|
|
|
1150
|
-
[src/Particle.js:1255-1259](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1151
1151
|
|
|
1152
1152
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1153
1153
|
|
|
@@ -1165,7 +1165,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1165
1165
|
|
|
1166
1166
|
### updateSIM
|
|
1167
1167
|
|
|
1168
|
-
[src/Particle.js:1272-1276](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1169
1169
|
|
|
1170
1170
|
Update SIM card data limit
|
|
1171
1171
|
|
|
@@ -1183,7 +1183,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1183
1183
|
|
|
1184
1184
|
### removeSIM
|
|
1185
1185
|
|
|
1186
|
-
[src/Particle.js:1288-1291](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1187
1187
|
|
|
1188
1188
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1189
1189
|
|
|
@@ -1200,7 +1200,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1200
1200
|
|
|
1201
1201
|
### listBuildTargets
|
|
1202
1202
|
|
|
1203
|
-
[src/Particle.js:1302-1305](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1204
1204
|
|
|
1205
1205
|
List valid build targets to be used for compiling
|
|
1206
1206
|
|
|
@@ -1216,7 +1216,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1216
1216
|
|
|
1217
1217
|
### listLibraries
|
|
1218
1218
|
|
|
1219
|
-
[src/Particle.js:1331-1348](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1220
1220
|
|
|
1221
1221
|
List firmware libraries
|
|
1222
1222
|
|
|
@@ -1245,7 +1245,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1245
1245
|
|
|
1246
1246
|
### getLibrary
|
|
1247
1247
|
|
|
1248
|
-
[src/Particle.js:1364-1372](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1249
1249
|
|
|
1250
1250
|
Get firmware library details
|
|
1251
1251
|
|
|
@@ -1262,7 +1262,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1262
1262
|
|
|
1263
1263
|
### getLibraryVersions
|
|
1264
1264
|
|
|
1265
|
-
[src/Particle.js:1385-1393](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1266
1266
|
|
|
1267
1267
|
Firmware library details for each version
|
|
1268
1268
|
|
|
@@ -1280,7 +1280,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1280
1280
|
|
|
1281
1281
|
### contributeLibrary
|
|
1282
1282
|
|
|
1283
|
-
[src/Particle.js:1405-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1284
1284
|
|
|
1285
1285
|
Contribute a new library version from a compressed archive
|
|
1286
1286
|
|
|
@@ -1297,7 +1297,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1297
1297
|
|
|
1298
1298
|
### publishLibrary
|
|
1299
1299
|
|
|
1300
|
-
[src/Particle.js:1429-1438](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1301
1301
|
|
|
1302
1302
|
Publish the latest version of a library to the public
|
|
1303
1303
|
|
|
@@ -1313,7 +1313,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1313
1313
|
|
|
1314
1314
|
### deleteLibrary
|
|
1315
1315
|
|
|
1316
|
-
[src/Particle.js:1450-1458](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1317
1317
|
|
|
1318
1318
|
Delete one version of a library or an entire private library
|
|
1319
1319
|
|
|
@@ -1330,7 +1330,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1330
1330
|
|
|
1331
1331
|
### downloadFile
|
|
1332
1332
|
|
|
1333
|
-
[src/Particle.js:1468-1471](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1334
1334
|
|
|
1335
1335
|
Download an external file that may not be on the API
|
|
1336
1336
|
|
|
@@ -1345,7 +1345,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1345
1345
|
|
|
1346
1346
|
### listOAuthClients
|
|
1347
1347
|
|
|
1348
|
-
[src/Particle.js:1482-1485](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1349
1349
|
|
|
1350
1350
|
List OAuth client created by the account
|
|
1351
1351
|
|
|
@@ -1361,7 +1361,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1361
1361
|
|
|
1362
1362
|
### createOAuthClient
|
|
1363
1363
|
|
|
1364
|
-
[src/Particle.js:1500-1504](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1365
1365
|
|
|
1366
1366
|
Create an OAuth client
|
|
1367
1367
|
|
|
@@ -1381,7 +1381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1381
1381
|
|
|
1382
1382
|
### updateOAuthClient
|
|
1383
1383
|
|
|
1384
|
-
[src/Particle.js:1518-1522](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1385
1385
|
|
|
1386
1386
|
Update an OAuth client
|
|
1387
1387
|
|
|
@@ -1400,7 +1400,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1400
1400
|
|
|
1401
1401
|
### deleteOAuthClient
|
|
1402
1402
|
|
|
1403
|
-
[src/Particle.js:1534-1537](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1404
1404
|
|
|
1405
1405
|
Delete an OAuth client
|
|
1406
1406
|
|
|
@@ -1417,7 +1417,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1417
1417
|
|
|
1418
1418
|
### listProducts
|
|
1419
1419
|
|
|
1420
|
-
[src/Particle.js:1547-1549](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1421
1421
|
|
|
1422
1422
|
List products the account has access to
|
|
1423
1423
|
|
|
@@ -1432,7 +1432,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1432
1432
|
|
|
1433
1433
|
### getProduct
|
|
1434
1434
|
|
|
1435
|
-
[src/Particle.js:1560-1562](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1436
1436
|
|
|
1437
1437
|
Get detailed information about a product
|
|
1438
1438
|
|
|
@@ -1448,7 +1448,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1448
1448
|
|
|
1449
1449
|
### listProductFirmware
|
|
1450
1450
|
|
|
1451
|
-
[src/Particle.js:1573-1575](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1452
1452
|
|
|
1453
1453
|
List product firmware versions
|
|
1454
1454
|
|
|
@@ -1464,7 +1464,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1464
1464
|
|
|
1465
1465
|
### uploadProductFirmware
|
|
1466
1466
|
|
|
1467
|
-
[src/Particle.js:1591-1607](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1468
1468
|
|
|
1469
1469
|
List product firmware versions
|
|
1470
1470
|
|
|
@@ -1485,7 +1485,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1485
1485
|
|
|
1486
1486
|
### getProductFirmware
|
|
1487
1487
|
|
|
1488
|
-
[src/Particle.js:1619-1626](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1489
1489
|
|
|
1490
1490
|
Get information about a product firmware version
|
|
1491
1491
|
|
|
@@ -1502,7 +1502,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1502
1502
|
|
|
1503
1503
|
### updateProductFirmware
|
|
1504
1504
|
|
|
1505
|
-
[src/Particle.js:1640-1643](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1506
1506
|
|
|
1507
1507
|
Update information for a product firmware version
|
|
1508
1508
|
|
|
@@ -1521,7 +1521,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1521
1521
|
|
|
1522
1522
|
### downloadProductFirmware
|
|
1523
1523
|
|
|
1524
|
-
[src/Particle.js:1655-1666](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1525
1525
|
|
|
1526
1526
|
Download a product firmware binary
|
|
1527
1527
|
|
|
@@ -1538,7 +1538,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
|
|
|
1538
1538
|
|
|
1539
1539
|
### releaseProductFirmware
|
|
1540
1540
|
|
|
1541
|
-
[src/Particle.js:1690-1693](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1542
1542
|
|
|
1543
1543
|
Release a product firmware version as the default version
|
|
1544
1544
|
|
|
@@ -1555,7 +1555,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1555
1555
|
|
|
1556
1556
|
### listTeamMembers
|
|
1557
1557
|
|
|
1558
|
-
[src/Particle.js:1704-1711](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1559
1559
|
|
|
1560
1560
|
List product team members
|
|
1561
1561
|
|
|
@@ -1571,7 +1571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1571
1571
|
|
|
1572
1572
|
### inviteTeamMember
|
|
1573
1573
|
|
|
1574
|
-
[src/Particle.js:1723-1731](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1575
1575
|
|
|
1576
1576
|
Invite Particle user to a product team
|
|
1577
1577
|
|
|
@@ -1588,7 +1588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1588
1588
|
|
|
1589
1589
|
### removeTeamMember
|
|
1590
1590
|
|
|
1591
|
-
[src/Particle.js:1743-1750](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1592
1592
|
|
|
1593
1593
|
Remove Particle user to a product team
|
|
1594
1594
|
|
|
@@ -1605,7 +1605,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1605
1605
|
|
|
1606
1606
|
### lookupSerialNumber
|
|
1607
1607
|
|
|
1608
|
-
[src/Particle.js:1761-1768](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1609
1609
|
|
|
1610
1610
|
Fetch details about a serial number
|
|
1611
1611
|
|
|
@@ -1621,7 +1621,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1621
1621
|
|
|
1622
1622
|
### createMeshNetwork
|
|
1623
1623
|
|
|
1624
|
-
[src/Particle.js:1781-1789](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1625
1625
|
|
|
1626
1626
|
Create a mesh network
|
|
1627
1627
|
|
|
@@ -1639,7 +1639,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1639
1639
|
|
|
1640
1640
|
### removeMeshNetwork
|
|
1641
1641
|
|
|
1642
|
-
[src/Particle.js:1800-1802](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1643
1643
|
|
|
1644
1644
|
Remove a mesh network.
|
|
1645
1645
|
|
|
@@ -1655,7 +1655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1655
1655
|
|
|
1656
1656
|
### listMeshNetworks
|
|
1657
1657
|
|
|
1658
|
-
[src/Particle.js:1814-1817](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1659
1659
|
|
|
1660
1660
|
List all mesh networks
|
|
1661
1661
|
|
|
@@ -1672,7 +1672,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1672
1672
|
|
|
1673
1673
|
### getMeshNetwork
|
|
1674
1674
|
|
|
1675
|
-
[src/Particle.js:1828-1830](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1676
1676
|
|
|
1677
1677
|
Get information about a mesh network.
|
|
1678
1678
|
|
|
@@ -1688,7 +1688,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1688
1688
|
|
|
1689
1689
|
### updateMeshNetwork
|
|
1690
1690
|
|
|
1691
|
-
[src/Particle.js:1843-1851](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1692
1692
|
|
|
1693
1693
|
Modify a mesh network.
|
|
1694
1694
|
|
|
@@ -1706,7 +1706,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1706
1706
|
|
|
1707
1707
|
### addMeshNetworkDevice
|
|
1708
1708
|
|
|
1709
|
-
[src/Particle.js:1863-1872](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1710
1710
|
|
|
1711
1711
|
Add a device to a mesh network.
|
|
1712
1712
|
|
|
@@ -1723,7 +1723,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1723
1723
|
|
|
1724
1724
|
### removeMeshNetworkDevice
|
|
1725
1725
|
|
|
1726
|
-
[src/Particle.js:1884-1900](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1727
1727
|
|
|
1728
1728
|
Remove a device from a mesh network.
|
|
1729
1729
|
|
|
@@ -1740,7 +1740,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1740
1740
|
|
|
1741
1741
|
### listMeshNetworkDevices
|
|
1742
1742
|
|
|
1743
|
-
[src/Particle.js:1914-1923](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1744
1744
|
|
|
1745
1745
|
List all devices of a mesh network.
|
|
1746
1746
|
|
|
@@ -1759,7 +1759,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1759
1759
|
|
|
1760
1760
|
### getProductConfiguration
|
|
1761
1761
|
|
|
1762
|
-
[src/Particle.js:1934-1941](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1763
1763
|
|
|
1764
1764
|
Get product configuration
|
|
1765
1765
|
|
|
@@ -1775,7 +1775,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1775
1775
|
|
|
1776
1776
|
### getProductConfigurationSchema
|
|
1777
1777
|
|
|
1778
|
-
[src/Particle.js:1952-1960](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1779
1779
|
|
|
1780
1780
|
Get product configuration schema
|
|
1781
1781
|
|
|
@@ -1791,7 +1791,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1791
1791
|
|
|
1792
1792
|
### getProductDeviceConfiguration
|
|
1793
1793
|
|
|
1794
|
-
[src/Particle.js:1972-1979](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1795
1795
|
|
|
1796
1796
|
Get product device's configuration
|
|
1797
1797
|
|
|
@@ -1808,7 +1808,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1808
1808
|
|
|
1809
1809
|
### getProductDeviceConfigurationSchema
|
|
1810
1810
|
|
|
1811
|
-
[src/Particle.js:1991-1999](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1812
1812
|
|
|
1813
1813
|
Get product device's configuration schema
|
|
1814
1814
|
|
|
@@ -1825,7 +1825,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1825
1825
|
|
|
1826
1826
|
### setProductConfiguration
|
|
1827
1827
|
|
|
1828
|
-
[src/Particle.js:2011-2019](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1829
1829
|
|
|
1830
1830
|
Set product configuration
|
|
1831
1831
|
|
|
@@ -1842,7 +1842,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1842
1842
|
|
|
1843
1843
|
### setProductDeviceConfiguration
|
|
1844
1844
|
|
|
1845
|
-
[src/Particle.js:2032-2040](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1846
1846
|
|
|
1847
1847
|
Set product configuration for a specific device within the product
|
|
1848
1848
|
|
|
@@ -1860,7 +1860,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1860
1860
|
|
|
1861
1861
|
### getProductLocations
|
|
1862
1862
|
|
|
1863
|
-
[src/Particle.js:2059-2076](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1864
1864
|
|
|
1865
1865
|
Query location for devices within a product
|
|
1866
1866
|
|
|
@@ -1884,7 +1884,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1884
1884
|
|
|
1885
1885
|
### getProductDeviceLocations
|
|
1886
1886
|
|
|
1887
|
-
[src/Particle.js:2093-2105](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1888
1888
|
|
|
1889
1889
|
Query location for one device within a product
|
|
1890
1890
|
|
|
@@ -1904,7 +1904,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1904
1904
|
|
|
1905
1905
|
### setDefaultAuth
|
|
1906
1906
|
|
|
1907
|
-
[src/Particle.js:2112-2118](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
1908
1908
|
|
|
1909
1909
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
1910
1910
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "particle-api-js",
|
|
3
|
-
"version": "9.4.
|
|
3
|
+
"version": "9.4.1",
|
|
4
4
|
"description": "Particle API Client",
|
|
5
5
|
"main": "lib/Particle.js",
|
|
6
6
|
"scripts": {
|
|
@@ -55,10 +55,10 @@
|
|
|
55
55
|
"babelify": "^7.3.0",
|
|
56
56
|
"brfs": "^1.4.3",
|
|
57
57
|
"browserify": "^13.0.0",
|
|
58
|
-
"chai": "^3.
|
|
59
|
-
"chai-as-promised": "^
|
|
58
|
+
"chai": "^4.3.6",
|
|
59
|
+
"chai-as-promised": "^7.1.1",
|
|
60
60
|
"documentation": "^4.0.0-rc.1",
|
|
61
|
-
"eslint": "^
|
|
61
|
+
"eslint": "^8.17.0",
|
|
62
62
|
"eslint-config-particle": "^2.2.1",
|
|
63
63
|
"karma": "^1.1.1",
|
|
64
64
|
"karma-browserify": "^5.1.0",
|
|
@@ -72,8 +72,7 @@
|
|
|
72
72
|
"nyc": "^15.1.0",
|
|
73
73
|
"should": "^9.0.0",
|
|
74
74
|
"sinon": "^7.2.5",
|
|
75
|
-
"sinon-
|
|
76
|
-
"sinon-chai": "^3.3.0",
|
|
75
|
+
"sinon-chai": "^3.7.0",
|
|
77
76
|
"watchify": "^3.7.0"
|
|
78
77
|
},
|
|
79
78
|
"dependencies": {
|
package/test/Agent.spec.js
CHANGED
|
@@ -28,7 +28,7 @@ describe('Agent', () => {
|
|
|
28
28
|
describe('sanitize files', () => {
|
|
29
29
|
it('can call sanitize will falsy value', () => {
|
|
30
30
|
const agent = new Agent();
|
|
31
|
-
expect(agent._sanitizeFiles(undefined)).to.be.
|
|
31
|
+
expect(agent._sanitizeFiles(undefined)).to.be.undefined;
|
|
32
32
|
});
|
|
33
33
|
|
|
34
34
|
it('sanitizes file names', () => {
|
|
@@ -247,13 +247,14 @@ describe('Agent', () => {
|
|
|
247
247
|
});
|
|
248
248
|
|
|
249
249
|
it('does not call used if no prefix provided', () => {
|
|
250
|
+
agent.prefix = undefined;
|
|
250
251
|
const use = sinon.stub();
|
|
251
252
|
const req = sinon.stub();
|
|
252
253
|
req.returns({ use: use });
|
|
253
254
|
const result = agent._buildRequest({ uri: 'uri', method: 'get', makerequest: req });
|
|
254
255
|
expect(result).to.be.ok;
|
|
255
256
|
expect(req).to.be.calledWith('get', 'uri');
|
|
256
|
-
expect(use).to.
|
|
257
|
+
expect(use).to.not.have.been.called;
|
|
257
258
|
});
|
|
258
259
|
|
|
259
260
|
it('should invoke _applyContext with the request and context when provided', () => {
|
|
@@ -302,7 +303,7 @@ describe('Agent', () => {
|
|
|
302
303
|
const req = sinon.stub();
|
|
303
304
|
req.returns({ query: query, _authorizationHeader: sinon.stub() });
|
|
304
305
|
agent._buildRequest({ uri: 'uri', method: 'get', makerequest: req });
|
|
305
|
-
expect(query).to.be.
|
|
306
|
+
expect(query).to.be.not.been.called;
|
|
306
307
|
});
|
|
307
308
|
|
|
308
309
|
it('should invoke send when data given', () => {
|
package/test/EventStream.spec.js
CHANGED
|
@@ -26,7 +26,7 @@ describe('EventStream', () => {
|
|
|
26
26
|
it('creates an EventStream objects', () => {
|
|
27
27
|
const eventStream = new EventStream('uri', 'token');
|
|
28
28
|
|
|
29
|
-
expect(eventStream).to.
|
|
29
|
+
expect(eventStream).to.own.include({ uri: 'uri', token: 'token' });
|
|
30
30
|
});
|
|
31
31
|
});
|
|
32
32
|
|