particle-api-js 10.5.1 → 11.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.
- package/.circleci/config.yml +2 -4
- package/CHANGELOG.md +7 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +289 -287
- package/package.json +1 -1
- package/src/Agent.js +10 -33
- package/src/EventStream.js +4 -1
- package/src/Particle.js +175 -167
- package/test/Agent.spec.js +0 -22
- package/test/EventStream.spec.js +4 -1
- package/test/Particle.spec.js +72 -57
package/docs/api.md
CHANGED
|
@@ -14,11 +14,9 @@
|
|
|
14
14
|
- [createUser](#createuser)
|
|
15
15
|
- [verifyUser](#verifyuser)
|
|
16
16
|
- [resetPassword](#resetpassword)
|
|
17
|
-
- [deleteAccessToken](#deleteaccesstoken)
|
|
18
17
|
- [deleteCurrentAccessToken](#deletecurrentaccesstoken)
|
|
19
18
|
- [deleteActiveAccessTokens](#deleteactiveaccesstokens)
|
|
20
19
|
- [deleteUser](#deleteuser)
|
|
21
|
-
- [listAccessTokens](#listaccesstokens)
|
|
22
20
|
- [trackingIdentity](#trackingidentity)
|
|
23
21
|
- [listDevices](#listdevices)
|
|
24
22
|
- [getDevice](#getdevice)
|
|
@@ -128,6 +126,8 @@
|
|
|
128
126
|
- [listLedgerInstances](#listledgerinstances)
|
|
129
127
|
- [listLedgerInstanceVersions](#listledgerinstanceversions)
|
|
130
128
|
- [getLedgerInstanceVersion](#getledgerinstanceversion)
|
|
129
|
+
- [listDeviceOsVersions](#listdeviceosversions)
|
|
130
|
+
- [getDeviceOsVersion](#getdeviceosversion)
|
|
131
131
|
- [setDefaultAuth](#setdefaultauth)
|
|
132
132
|
- [get](#get)
|
|
133
133
|
- [head](#head)
|
|
@@ -138,7 +138,7 @@
|
|
|
138
138
|
|
|
139
139
|
## Particle
|
|
140
140
|
|
|
141
|
-
[src/Particle.js:
|
|
141
|
+
[src/Particle.js:19-2810](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L19-L2810 "Source code on GitHub")
|
|
142
142
|
|
|
143
143
|
Particle Cloud API wrapper.
|
|
144
144
|
|
|
@@ -154,7 +154,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
154
154
|
|
|
155
155
|
### constructor
|
|
156
156
|
|
|
157
|
-
[src/Particle.js:
|
|
157
|
+
[src/Particle.js:32-41](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L32-L41 "Source code on GitHub")
|
|
158
158
|
|
|
159
159
|
Contructor for the Cloud API wrapper.
|
|
160
160
|
|
|
@@ -167,11 +167,11 @@ Create a new Particle object and call methods below on it.
|
|
|
167
167
|
- `options.clientSecret` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
|
|
168
168
|
- `options.clientId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
|
|
169
169
|
- `options.tokenDuration` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?**
|
|
170
|
-
- `options.auth` **
|
|
170
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. If not specified here, will have to be added to every request
|
|
171
171
|
|
|
172
172
|
### login
|
|
173
173
|
|
|
174
|
-
[src/Particle.js:
|
|
174
|
+
[src/Particle.js:78-95](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L78-L95 "Source code on GitHub")
|
|
175
175
|
|
|
176
176
|
Login to Particle Cloud using an existing Particle acccount.
|
|
177
177
|
|
|
@@ -188,7 +188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
188
188
|
|
|
189
189
|
### sendOtp
|
|
190
190
|
|
|
191
|
-
[src/Particle.js:
|
|
191
|
+
[src/Particle.js:106-122](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L106-L122 "Source code on GitHub")
|
|
192
192
|
|
|
193
193
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
194
194
|
|
|
@@ -204,14 +204,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
204
204
|
|
|
205
205
|
### enableMfa
|
|
206
206
|
|
|
207
|
-
[src/Particle.js:
|
|
207
|
+
[src/Particle.js:132-134](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L132-L134 "Source code on GitHub")
|
|
208
208
|
|
|
209
209
|
Enable MFA on the currently logged in user
|
|
210
210
|
|
|
211
211
|
**Parameters**
|
|
212
212
|
|
|
213
213
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
214
|
-
- `options.auth` **
|
|
214
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
215
215
|
- `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.
|
|
216
216
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
217
217
|
|
|
@@ -219,7 +219,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
219
219
|
|
|
220
220
|
### confirmMfa
|
|
221
221
|
|
|
222
|
-
[src/Particle.js:
|
|
222
|
+
[src/Particle.js:147-161](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L147-L161 "Source code on GitHub")
|
|
223
223
|
|
|
224
224
|
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.
|
|
225
225
|
|
|
@@ -229,7 +229,7 @@ Confirm MFA for the user. This must be called with current TOTP code, determined
|
|
|
229
229
|
- `options.mfaToken` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Token given from previous step to
|
|
230
230
|
- `options.otp` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Current one-time-password generated from the authentication app
|
|
231
231
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
232
|
-
- `options.auth` **
|
|
232
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
233
233
|
- `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.
|
|
234
234
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
235
235
|
|
|
@@ -237,7 +237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
237
237
|
|
|
238
238
|
### disableMfa
|
|
239
239
|
|
|
240
|
-
[src/Particle.js:
|
|
240
|
+
[src/Particle.js:172-180](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L172-L180 "Source code on GitHub")
|
|
241
241
|
|
|
242
242
|
Disable MFA for the user.
|
|
243
243
|
|
|
@@ -245,7 +245,7 @@ Disable MFA for the user.
|
|
|
245
245
|
|
|
246
246
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
247
247
|
- `options.currentPassword` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** User's current password
|
|
248
|
-
- `options.auth` **
|
|
248
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
249
249
|
- `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.
|
|
250
250
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
251
251
|
|
|
@@ -253,7 +253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
253
253
|
|
|
254
254
|
### createCustomer
|
|
255
255
|
|
|
256
|
-
[src/Particle.js:
|
|
256
|
+
[src/Particle.js:192-208](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L192-L208 "Source code on GitHub")
|
|
257
257
|
|
|
258
258
|
Create Customer for Product.
|
|
259
259
|
|
|
@@ -270,7 +270,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
270
270
|
|
|
271
271
|
### loginAsClientOwner
|
|
272
272
|
|
|
273
|
-
[src/Particle.js:
|
|
273
|
+
[src/Particle.js:217-231](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L217-L231 "Source code on GitHub")
|
|
274
274
|
|
|
275
275
|
Login to Particle Cloud using an OAuth client.
|
|
276
276
|
|
|
@@ -284,7 +284,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
284
284
|
|
|
285
285
|
### createUser
|
|
286
286
|
|
|
287
|
-
[src/Particle.js:
|
|
287
|
+
[src/Particle.js:244-256](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L244-L256 "Source code on GitHub")
|
|
288
288
|
|
|
289
289
|
Create a user account for the Particle Cloud
|
|
290
290
|
|
|
@@ -302,7 +302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
302
302
|
|
|
303
303
|
### verifyUser
|
|
304
304
|
|
|
305
|
-
[src/Particle.js:
|
|
305
|
+
[src/Particle.js:266-273](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L266-L273 "Source code on GitHub")
|
|
306
306
|
|
|
307
307
|
Verify new user account via verification email
|
|
308
308
|
|
|
@@ -317,7 +317,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
317
317
|
|
|
318
318
|
### resetPassword
|
|
319
319
|
|
|
320
|
-
[src/Particle.js:
|
|
320
|
+
[src/Particle.js:283-290](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L283-L290 "Source code on GitHub")
|
|
321
321
|
|
|
322
322
|
Send reset password email for a Particle Cloud user account
|
|
323
323
|
|
|
@@ -330,33 +330,16 @@ Send reset password email for a Particle Cloud user account
|
|
|
330
330
|
|
|
331
331
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
332
332
|
|
|
333
|
-
### deleteAccessToken
|
|
334
|
-
|
|
335
|
-
[src/Particle.js:303-311](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L303-L311 "Source code on GitHub")
|
|
336
|
-
|
|
337
|
-
Revoke an access token
|
|
338
|
-
|
|
339
|
-
**Parameters**
|
|
340
|
-
|
|
341
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
342
|
-
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username of the Particle cloud account that the token belongs to.
|
|
343
|
-
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password for the account
|
|
344
|
-
- `options.token` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access token you wish to revoke
|
|
345
|
-
- `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.
|
|
346
|
-
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
347
|
-
|
|
348
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
349
|
-
|
|
350
333
|
### deleteCurrentAccessToken
|
|
351
334
|
|
|
352
|
-
[src/Particle.js:
|
|
335
|
+
[src/Particle.js:300-307](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L300-L307 "Source code on GitHub")
|
|
353
336
|
|
|
354
337
|
Revoke the current session access token
|
|
355
338
|
|
|
356
339
|
**Parameters**
|
|
357
340
|
|
|
358
341
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
359
|
-
- `options.auth` **
|
|
342
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
360
343
|
- `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.
|
|
361
344
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
362
345
|
|
|
@@ -364,14 +347,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
364
347
|
|
|
365
348
|
### deleteActiveAccessTokens
|
|
366
349
|
|
|
367
|
-
[src/Particle.js:
|
|
350
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
368
351
|
|
|
369
352
|
Revoke all active access tokens
|
|
370
353
|
|
|
371
354
|
**Parameters**
|
|
372
355
|
|
|
373
356
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
374
|
-
- `options.auth` **
|
|
357
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
375
358
|
- `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.
|
|
376
359
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
377
360
|
|
|
@@ -379,32 +362,15 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
379
362
|
|
|
380
363
|
### deleteUser
|
|
381
364
|
|
|
382
|
-
[src/Particle.js:
|
|
365
|
+
[src/Particle.js:335-343](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L335-L343 "Source code on GitHub")
|
|
383
366
|
|
|
384
367
|
Delete the current user
|
|
385
368
|
|
|
386
369
|
**Parameters**
|
|
387
370
|
|
|
388
371
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
389
|
-
- `options.auth` **
|
|
390
|
-
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
|
|
391
|
-
- `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.
|
|
392
|
-
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
393
|
-
|
|
394
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
395
|
-
|
|
396
|
-
### listAccessTokens
|
|
397
|
-
|
|
398
|
-
[src/Particle.js:376-384](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L376-L384 "Source code on GitHub")
|
|
399
|
-
|
|
400
|
-
List all valid access tokens for a Particle Cloud account
|
|
401
|
-
|
|
402
|
-
**Parameters**
|
|
403
|
-
|
|
404
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
405
|
-
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username
|
|
372
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
406
373
|
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
|
|
407
|
-
- `options.otp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current one-time-password generated from the authentication application
|
|
408
374
|
- `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.
|
|
409
375
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
410
376
|
|
|
@@ -412,7 +378,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
412
378
|
|
|
413
379
|
### trackingIdentity
|
|
414
380
|
|
|
415
|
-
[src/Particle.js:
|
|
381
|
+
[src/Particle.js:355-363](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L355-L363 "Source code on GitHub")
|
|
416
382
|
|
|
417
383
|
Retrieves the information that is used to identify the current login for tracking.
|
|
418
384
|
|
|
@@ -421,7 +387,7 @@ Retrieves the information that is used to identify the current login for trackin
|
|
|
421
387
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options for this API call (optional, default `{}`)
|
|
422
388
|
- `options.full` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** When true, retrieve all information for registering a user with the tracking API. When false,
|
|
423
389
|
retrieve only the unique tracking ID for the current login. (optional, default `false`)
|
|
424
|
-
- `options.auth` **
|
|
390
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
425
391
|
- `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.
|
|
426
392
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
427
393
|
|
|
@@ -429,7 +395,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
429
395
|
|
|
430
396
|
### listDevices
|
|
431
397
|
|
|
432
|
-
[src/Particle.js:
|
|
398
|
+
[src/Particle.js:381-400](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L381-L400 "Source code on GitHub")
|
|
433
399
|
|
|
434
400
|
List devices claimed to the account or product
|
|
435
401
|
|
|
@@ -444,7 +410,7 @@ List devices claimed to the account or product
|
|
|
444
410
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
|
|
445
411
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
|
|
446
412
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List devices in this product ID or slug
|
|
447
|
-
- `options.auth` **
|
|
413
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
448
414
|
- `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.
|
|
449
415
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
450
416
|
|
|
@@ -452,7 +418,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
452
418
|
|
|
453
419
|
### getDevice
|
|
454
420
|
|
|
455
|
-
[src/Particle.js:
|
|
421
|
+
[src/Particle.js:412-415](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L412-L415 "Source code on GitHub")
|
|
456
422
|
|
|
457
423
|
Get detailed informationa about a device
|
|
458
424
|
|
|
@@ -461,7 +427,7 @@ Get detailed informationa about a device
|
|
|
461
427
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
462
428
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
463
429
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
464
|
-
- `options.auth` **
|
|
430
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
465
431
|
- `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.
|
|
466
432
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
467
433
|
|
|
@@ -469,7 +435,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
469
435
|
|
|
470
436
|
### claimDevice
|
|
471
437
|
|
|
472
|
-
[src/Particle.js:
|
|
438
|
+
[src/Particle.js:427-438](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L427-L438 "Source code on GitHub")
|
|
473
439
|
|
|
474
440
|
Claim a device to the account. The device must be online and unclaimed.
|
|
475
441
|
|
|
@@ -478,7 +444,7 @@ Claim a device to the account. The device must be online and unclaimed.
|
|
|
478
444
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
479
445
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
480
446
|
- `options.requestTransfer` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True to request the device be transfered from another user
|
|
481
|
-
- `options.auth` **
|
|
447
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
482
448
|
- `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.
|
|
483
449
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
484
450
|
|
|
@@ -486,7 +452,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
486
452
|
|
|
487
453
|
### addDeviceToProduct
|
|
488
454
|
|
|
489
|
-
[src/Particle.js:
|
|
455
|
+
[src/Particle.js:452-470](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L452-L470 "Source code on GitHub")
|
|
490
456
|
|
|
491
457
|
Add a device to a product or move device out of quarantine.
|
|
492
458
|
|
|
@@ -497,7 +463,7 @@ Add a device to a product or move device out of quarantine.
|
|
|
497
463
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Add to this product ID or slug
|
|
498
464
|
- `options.file` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** A file that contains a single-column list of device IDs, device serial numbers, device IMEIs, or devie ICCIDs.
|
|
499
465
|
Node: Either a path or Buffer. Browser: a File or Blob.
|
|
500
|
-
- `options.auth` **
|
|
466
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
501
467
|
- `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.
|
|
502
468
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
503
469
|
|
|
@@ -505,7 +471,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
505
471
|
|
|
506
472
|
### removeDevice
|
|
507
473
|
|
|
508
|
-
[src/Particle.js:
|
|
474
|
+
[src/Particle.js:483-487](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L483-L487 "Source code on GitHub")
|
|
509
475
|
|
|
510
476
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
511
477
|
|
|
@@ -515,7 +481,7 @@ Unclaim / Remove a device from your account or product, or deny quarantine
|
|
|
515
481
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
516
482
|
- `options.deny` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Deny this quarantined device, instead of removing an already approved device
|
|
517
483
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
|
|
518
|
-
- `options.auth` **
|
|
484
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
519
485
|
- `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.
|
|
520
486
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
521
487
|
|
|
@@ -523,7 +489,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
523
489
|
|
|
524
490
|
### removeDeviceOwner
|
|
525
491
|
|
|
526
|
-
[src/Particle.js:
|
|
492
|
+
[src/Particle.js:499-502](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L499-L502 "Source code on GitHub")
|
|
527
493
|
|
|
528
494
|
Unclaim a product device its the owner, but keep it in the product
|
|
529
495
|
|
|
@@ -532,7 +498,7 @@ Unclaim a product device its the owner, but keep it in the product
|
|
|
532
498
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
533
499
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
534
500
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
|
|
535
|
-
- `options.auth` **
|
|
501
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
536
502
|
- `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.
|
|
537
503
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
538
504
|
|
|
@@ -540,7 +506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
540
506
|
|
|
541
507
|
### renameDevice
|
|
542
508
|
|
|
543
|
-
[src/Particle.js:
|
|
509
|
+
[src/Particle.js:515-517](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L515-L517 "Source code on GitHub")
|
|
544
510
|
|
|
545
511
|
Rename a device
|
|
546
512
|
|
|
@@ -550,7 +516,7 @@ Rename a device
|
|
|
550
516
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
551
517
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Desired Name
|
|
552
518
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Rename device in this product ID or slug
|
|
553
|
-
- `options.auth` **
|
|
519
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
554
520
|
- `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.
|
|
555
521
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
556
522
|
|
|
@@ -558,7 +524,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
558
524
|
|
|
559
525
|
### signalDevice
|
|
560
526
|
|
|
561
|
-
[src/Particle.js:
|
|
527
|
+
[src/Particle.js:530-532](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L530-L532 "Source code on GitHub")
|
|
562
528
|
|
|
563
529
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
564
530
|
|
|
@@ -568,7 +534,7 @@ Instruct the device to turn on/off the LED in a rainbow pattern
|
|
|
568
534
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
569
535
|
- `options.signal` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Signal on or off
|
|
570
536
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
571
|
-
- `options.auth` **
|
|
537
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
572
538
|
- `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.
|
|
573
539
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
574
540
|
|
|
@@ -576,7 +542,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
576
542
|
|
|
577
543
|
### setDeviceNotes
|
|
578
544
|
|
|
579
|
-
[src/Particle.js:
|
|
545
|
+
[src/Particle.js:545-547](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L545-L547 "Source code on GitHub")
|
|
580
546
|
|
|
581
547
|
Store some notes about device
|
|
582
548
|
|
|
@@ -586,7 +552,7 @@ Store some notes about device
|
|
|
586
552
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
587
553
|
- `options.notes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Your notes about this device
|
|
588
554
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
589
|
-
- `options.auth` **
|
|
555
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
590
556
|
- `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.
|
|
591
557
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
592
558
|
|
|
@@ -594,7 +560,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
594
560
|
|
|
595
561
|
### markAsDevelopmentDevice
|
|
596
562
|
|
|
597
|
-
[src/Particle.js:
|
|
563
|
+
[src/Particle.js:560-562](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L560-L562 "Source code on GitHub")
|
|
598
564
|
|
|
599
565
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
600
566
|
|
|
@@ -604,7 +570,7 @@ Mark device as being used in development of a product so it opts out of automati
|
|
|
604
570
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
605
571
|
- `options.development` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Set to true to mark as development, false to return to product fleet (optional, default `true`)
|
|
606
572
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
607
|
-
- `options.auth` **
|
|
573
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
608
574
|
- `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.
|
|
609
575
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
610
576
|
|
|
@@ -612,7 +578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
612
578
|
|
|
613
579
|
### lockDeviceProductFirmware
|
|
614
580
|
|
|
615
|
-
[src/Particle.js:
|
|
581
|
+
[src/Particle.js:576-578](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L576-L578 "Source code on GitHub")
|
|
616
582
|
|
|
617
583
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
618
584
|
|
|
@@ -623,7 +589,7 @@ Mark device as being used in development of a product, so it opts out of automat
|
|
|
623
589
|
- `options.desiredFirmwareVersion` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Lock the product device to run this firmware version.
|
|
624
590
|
- `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Immediately flash firmware indicated by desiredFirmwareVersion
|
|
625
591
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
626
|
-
- `options.auth` **
|
|
592
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
627
593
|
- `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.
|
|
628
594
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
629
595
|
|
|
@@ -631,7 +597,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
631
597
|
|
|
632
598
|
### unlockDeviceProductFirmware
|
|
633
599
|
|
|
634
|
-
[src/Particle.js:
|
|
600
|
+
[src/Particle.js:590-592](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L590-L592 "Source code on GitHub")
|
|
635
601
|
|
|
636
602
|
Mark device as receiving automatic firmware updates
|
|
637
603
|
|
|
@@ -640,7 +606,7 @@ Mark device as receiving automatic firmware updates
|
|
|
640
606
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
641
607
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
642
608
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
643
|
-
- `options.auth` **
|
|
609
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
644
610
|
- `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.
|
|
645
611
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
646
612
|
|
|
@@ -648,7 +614,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
648
614
|
|
|
649
615
|
### updateDevice
|
|
650
616
|
|
|
651
|
-
[src/Particle.js:
|
|
617
|
+
[src/Particle.js:611-623](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L611-L623 "Source code on GitHub")
|
|
652
618
|
|
|
653
619
|
Update multiple device attributes at the same time
|
|
654
620
|
|
|
@@ -664,7 +630,7 @@ Update multiple device attributes at the same time
|
|
|
664
630
|
Pass `null` to unlock firmware and go back to released firmware.
|
|
665
631
|
- `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Immediately flash firmware indicated by desiredFirmwareVersion
|
|
666
632
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
667
|
-
- `options.auth` **
|
|
633
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
668
634
|
- `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.
|
|
669
635
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
670
636
|
|
|
@@ -672,7 +638,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
672
638
|
|
|
673
639
|
### unprotectDevice
|
|
674
640
|
|
|
675
|
-
[src/Particle.js:
|
|
641
|
+
[src/Particle.js:643-659](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L643-L659 "Source code on GitHub")
|
|
676
642
|
|
|
677
643
|
Disable device protection.
|
|
678
644
|
|
|
@@ -688,7 +654,7 @@ Disable device protection.
|
|
|
688
654
|
- `options.deviceSignature` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded device signature. Mandatory if `action` is `confirm`,
|
|
689
655
|
- `options.devicePublicKeyFingerprint` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded fingerprint of the device public key.
|
|
690
656
|
Mandatory if `action` is `confirm`,
|
|
691
|
-
- `options.auth` **
|
|
657
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor.
|
|
692
658
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/value pairs to send as headers.
|
|
693
659
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
694
660
|
|
|
@@ -696,7 +662,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
696
662
|
|
|
697
663
|
### provisionDevice
|
|
698
664
|
|
|
699
|
-
[src/Particle.js:
|
|
665
|
+
[src/Particle.js:670-678](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L670-L678 "Source code on GitHub")
|
|
700
666
|
|
|
701
667
|
Provision a new device for products that allow self-provisioning
|
|
702
668
|
|
|
@@ -704,7 +670,7 @@ Provision a new device for products that allow self-provisioning
|
|
|
704
670
|
|
|
705
671
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
706
672
|
- `options.productId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID where to create this device
|
|
707
|
-
- `options.auth` **
|
|
673
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
708
674
|
- `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.
|
|
709
675
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
710
676
|
|
|
@@ -712,7 +678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
712
678
|
|
|
713
679
|
### getClaimCode
|
|
714
680
|
|
|
715
|
-
[src/Particle.js:
|
|
681
|
+
[src/Particle.js:692-695](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L692-L695 "Source code on GitHub")
|
|
716
682
|
|
|
717
683
|
Generate a claim code to use in the device claiming process.
|
|
718
684
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -723,7 +689,7 @@ customer of the product.
|
|
|
723
689
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
724
690
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ICCID of the SIM card used in the Electron
|
|
725
691
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
726
|
-
- `options.auth` **
|
|
692
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
727
693
|
- `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.
|
|
728
694
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
729
695
|
|
|
@@ -731,7 +697,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
731
697
|
|
|
732
698
|
### getVariable
|
|
733
699
|
|
|
734
|
-
[src/Particle.js:
|
|
700
|
+
[src/Particle.js:717-723](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L717-L723 "Source code on GitHub")
|
|
735
701
|
|
|
736
702
|
Get the value of a device variable
|
|
737
703
|
|
|
@@ -741,7 +707,7 @@ Get the value of a device variable
|
|
|
741
707
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
742
708
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Variable name
|
|
743
709
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
744
|
-
- `options.auth` **
|
|
710
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
745
711
|
- `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.
|
|
746
712
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
747
713
|
|
|
@@ -749,7 +715,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
749
715
|
|
|
750
716
|
### flashDevice
|
|
751
717
|
|
|
752
|
-
[src/Particle.js:
|
|
718
|
+
[src/Particle.js:737-748](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L737-L748 "Source code on GitHub")
|
|
753
719
|
|
|
754
720
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
755
721
|
|
|
@@ -760,7 +726,7 @@ Compile and flash application firmware to a device. Pass a pre-compiled binary t
|
|
|
760
726
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Flash device in this product ID or slug
|
|
761
727
|
- `options.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing files to be compiled and flashed. Keys should be the filenames, including relative path, and the values should be a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
762
728
|
- `options.targetVersion` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** System firmware version to compile against (optional, default `latest`)
|
|
763
|
-
- `options.auth` **
|
|
729
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
764
730
|
- `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.
|
|
765
731
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
766
732
|
|
|
@@ -768,7 +734,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
768
734
|
|
|
769
735
|
### flashTinker
|
|
770
736
|
|
|
771
|
-
[src/Particle.js:
|
|
737
|
+
[src/Particle.js:759-774](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L759-L774 "Source code on GitHub")
|
|
772
738
|
|
|
773
739
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
774
740
|
|
|
@@ -776,7 +742,7 @@ DEPRECATED: Flash the Tinker application to a device. Instead compile and flash
|
|
|
776
742
|
|
|
777
743
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
778
744
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
779
|
-
- `options.auth` **
|
|
745
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
780
746
|
- `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.
|
|
781
747
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
782
748
|
|
|
@@ -784,7 +750,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
784
750
|
|
|
785
751
|
### compileCode
|
|
786
752
|
|
|
787
|
-
[src/Particle.js:
|
|
753
|
+
[src/Particle.js:787-805](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L787-L805 "Source code on GitHub")
|
|
788
754
|
|
|
789
755
|
Compile firmware using the Particle Cloud
|
|
790
756
|
|
|
@@ -794,7 +760,7 @@ Compile firmware using the Particle Cloud
|
|
|
794
760
|
- `options.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing files to be compiled. Keys should be the filenames, including relative path, and the values should be a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
795
761
|
- `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Platform id number of the device you are compiling for. Common values are 0=Core, 6=Photon, 10=Electron.
|
|
796
762
|
- `options.targetVersion` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** System firmware version to compile against (optional, default `latest`)
|
|
797
|
-
- `options.auth` **
|
|
763
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
798
764
|
- `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.
|
|
799
765
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
800
766
|
|
|
@@ -802,7 +768,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
802
768
|
|
|
803
769
|
### downloadFirmwareBinary
|
|
804
770
|
|
|
805
|
-
[src/Particle.js:
|
|
771
|
+
[src/Particle.js:816-825](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L816-L825 "Source code on GitHub")
|
|
806
772
|
|
|
807
773
|
Download a firmware binary
|
|
808
774
|
|
|
@@ -810,7 +776,7 @@ Download a firmware binary
|
|
|
810
776
|
|
|
811
777
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
812
778
|
- `options.binaryId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Binary ID received from a successful compile call
|
|
813
|
-
- `options.auth` **
|
|
779
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
814
780
|
- `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.
|
|
815
781
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
816
782
|
|
|
@@ -818,7 +784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
818
784
|
|
|
819
785
|
### sendPublicKey
|
|
820
786
|
|
|
821
|
-
[src/Particle.js:
|
|
787
|
+
[src/Particle.js:838-852](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L838-L852 "Source code on GitHub")
|
|
822
788
|
|
|
823
789
|
Send a new device public key to the Particle Cloud
|
|
824
790
|
|
|
@@ -828,7 +794,7 @@ Send a new device public key to the Particle Cloud
|
|
|
828
794
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
829
795
|
- `options.key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** Public key contents
|
|
830
796
|
- `options.algorithm` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Algorithm used to generate the public key. Valid values are `rsa` or `ecc`. (optional, default `rsa`)
|
|
831
|
-
- `options.auth` **
|
|
797
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
832
798
|
- `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.
|
|
833
799
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
834
800
|
|
|
@@ -836,7 +802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
836
802
|
|
|
837
803
|
### callFunction
|
|
838
804
|
|
|
839
|
-
[src/Particle.js:
|
|
805
|
+
[src/Particle.js:866-871](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L866-L871 "Source code on GitHub")
|
|
840
806
|
|
|
841
807
|
Call a device function
|
|
842
808
|
|
|
@@ -847,7 +813,7 @@ Call a device function
|
|
|
847
813
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function name
|
|
848
814
|
- `options.argument` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function argument
|
|
849
815
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
850
|
-
- `options.auth` **
|
|
816
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
851
817
|
- `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.
|
|
852
818
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
853
819
|
|
|
@@ -855,7 +821,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
855
821
|
|
|
856
822
|
### getEventStream
|
|
857
823
|
|
|
858
|
-
[src/Particle.js:
|
|
824
|
+
[src/Particle.js:884-909](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L884-L909 "Source code on GitHub")
|
|
859
825
|
|
|
860
826
|
Get a stream of events
|
|
861
827
|
|
|
@@ -866,14 +832,14 @@ Get a stream of events
|
|
|
866
832
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event Name
|
|
867
833
|
- `options.org` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Organization Slug
|
|
868
834
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Events for this product ID or slug
|
|
869
|
-
- `options.auth` **
|
|
835
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
870
836
|
|
|
871
837
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If the promise resolves, the resolution value will be an EventStream object that will
|
|
872
838
|
emit 'event' events.
|
|
873
839
|
|
|
874
840
|
### publishEvent
|
|
875
841
|
|
|
876
|
-
[src/Particle.js:
|
|
842
|
+
[src/Particle.js:923-927](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L923-L927 "Source code on GitHub")
|
|
877
843
|
|
|
878
844
|
Publish a event to the Particle Cloud
|
|
879
845
|
|
|
@@ -884,7 +850,7 @@ Publish a event to the Particle Cloud
|
|
|
884
850
|
- `options.data` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Event data
|
|
885
851
|
- `options.isPrivate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should the event be publicly available?
|
|
886
852
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event for this product ID or slug
|
|
887
|
-
- `options.auth` **
|
|
853
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
888
854
|
- `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.
|
|
889
855
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
890
856
|
|
|
@@ -892,7 +858,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
892
858
|
|
|
893
859
|
### Hook
|
|
894
860
|
|
|
895
|
-
[src/Particle.js:
|
|
861
|
+
[src/Particle.js:958-980](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L958-L980 "Source code on GitHub")
|
|
896
862
|
|
|
897
863
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
898
864
|
|
|
@@ -913,7 +879,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
913
879
|
**Properties**
|
|
914
880
|
|
|
915
881
|
- `method` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Type of web request triggered by the Webhook (GET, POST, PUT, or DELETE)
|
|
916
|
-
- `auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Auth data like `{
|
|
882
|
+
- `auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Auth data like `{ user: 'me', pass: '1234' }` for basic auth or `{ bearer: 'token' }` to send with the Webhook request
|
|
917
883
|
- `headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to add to the Webhook like `{ 'X-ONE': '1', X-TWO: '2' }`
|
|
918
884
|
- `query` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Query params to add to the Webhook request like `{ foo: 'foo', bar: 'bar' }`
|
|
919
885
|
- `json` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** JSON data to send with the Webhook request - sets `Content-Type` to `application/json`
|
|
@@ -925,7 +891,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
925
891
|
|
|
926
892
|
### createWebhook
|
|
927
893
|
|
|
928
|
-
[src/Particle.js:
|
|
894
|
+
[src/Particle.js:958-980](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L958-L980 "Source code on GitHub")
|
|
929
895
|
|
|
930
896
|
Create a webhook
|
|
931
897
|
|
|
@@ -939,7 +905,7 @@ Create a webhook
|
|
|
939
905
|
- `options.noDefaults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Don't include default event data in the webhook request
|
|
940
906
|
- `options.hook` **Hook?** Webhook configuration settings
|
|
941
907
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
|
|
942
|
-
- `options.auth` **
|
|
908
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
943
909
|
- `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.
|
|
944
910
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
945
911
|
|
|
@@ -947,7 +913,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
947
913
|
|
|
948
914
|
### deleteWebhook
|
|
949
915
|
|
|
950
|
-
[src/Particle.js:
|
|
916
|
+
[src/Particle.js:992-995](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L992-L995 "Source code on GitHub")
|
|
951
917
|
|
|
952
918
|
Delete a webhook
|
|
953
919
|
|
|
@@ -956,7 +922,7 @@ Delete a webhook
|
|
|
956
922
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
957
923
|
- `options.hookId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Webhook ID
|
|
958
924
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
|
|
959
|
-
- `options.auth` **
|
|
925
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
960
926
|
- `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.
|
|
961
927
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
962
928
|
|
|
@@ -964,7 +930,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
964
930
|
|
|
965
931
|
### listWebhooks
|
|
966
932
|
|
|
967
|
-
[src/Particle.js:
|
|
933
|
+
[src/Particle.js:1006-1009](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1006-L1009 "Source code on GitHub")
|
|
968
934
|
|
|
969
935
|
List all webhooks owned by the account or product
|
|
970
936
|
|
|
@@ -972,7 +938,7 @@ List all webhooks owned by the account or product
|
|
|
972
938
|
|
|
973
939
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
974
940
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhooks for this product ID or slug
|
|
975
|
-
- `options.auth` **
|
|
941
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
976
942
|
- `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.
|
|
977
943
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
978
944
|
|
|
@@ -980,7 +946,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
980
946
|
|
|
981
947
|
### createIntegration
|
|
982
948
|
|
|
983
|
-
[src/Particle.js:
|
|
949
|
+
[src/Particle.js:1026-1030](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1026-L1030 "Source code on GitHub")
|
|
984
950
|
|
|
985
951
|
Create an integration to send events to an external service
|
|
986
952
|
|
|
@@ -993,7 +959,7 @@ See the API docs for details <https://docs.particle.io/reference/api/#integratio
|
|
|
993
959
|
- `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Settings specific to that integration type
|
|
994
960
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Trigger integration only for this device ID or Name
|
|
995
961
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
996
|
-
- `options.auth` **
|
|
962
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
997
963
|
- `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.
|
|
998
964
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
999
965
|
|
|
@@ -1001,7 +967,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1001
967
|
|
|
1002
968
|
### editIntegration
|
|
1003
969
|
|
|
1004
|
-
[src/Particle.js:
|
|
970
|
+
[src/Particle.js:1048-1052](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1048-L1052 "Source code on GitHub")
|
|
1005
971
|
|
|
1006
972
|
Edit an integration to send events to an external service
|
|
1007
973
|
|
|
@@ -1015,7 +981,7 @@ See the API docs for details <https://docs.particle.io/reference/api/#integratio
|
|
|
1015
981
|
- `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Change the settings specific to that integration type
|
|
1016
982
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Trigger integration only for this device ID or Name
|
|
1017
983
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
1018
|
-
- `options.auth` **
|
|
984
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1019
985
|
- `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.
|
|
1020
986
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1021
987
|
|
|
@@ -1023,7 +989,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1023
989
|
|
|
1024
990
|
### deleteIntegration
|
|
1025
991
|
|
|
1026
|
-
[src/Particle.js:
|
|
992
|
+
[src/Particle.js:1065-1068](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1065-L1068 "Source code on GitHub")
|
|
1027
993
|
|
|
1028
994
|
Delete an integration to send events to an external service
|
|
1029
995
|
|
|
@@ -1032,7 +998,7 @@ Delete an integration to send events to an external service
|
|
|
1032
998
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1033
999
|
- `options.integrationId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The integration to remove
|
|
1034
1000
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
1035
|
-
- `options.auth` **
|
|
1001
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1036
1002
|
- `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.
|
|
1037
1003
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1038
1004
|
|
|
@@ -1040,7 +1006,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1040
1006
|
|
|
1041
1007
|
### listIntegrations
|
|
1042
1008
|
|
|
1043
|
-
[src/Particle.js:
|
|
1009
|
+
[src/Particle.js:1079-1082](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1079-L1082 "Source code on GitHub")
|
|
1044
1010
|
|
|
1045
1011
|
List all integrations owned by the account or product
|
|
1046
1012
|
|
|
@@ -1048,7 +1014,7 @@ List all integrations owned by the account or product
|
|
|
1048
1014
|
|
|
1049
1015
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1050
1016
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integrations for this product ID or slug
|
|
1051
|
-
- `options.auth` **
|
|
1017
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1052
1018
|
- `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.
|
|
1053
1019
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1054
1020
|
|
|
@@ -1056,14 +1022,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1056
1022
|
|
|
1057
1023
|
### getUserInfo
|
|
1058
1024
|
|
|
1059
|
-
[src/Particle.js:
|
|
1025
|
+
[src/Particle.js:1092-1094](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1092-L1094 "Source code on GitHub")
|
|
1060
1026
|
|
|
1061
1027
|
Get details about the current user
|
|
1062
1028
|
|
|
1063
1029
|
**Parameters**
|
|
1064
1030
|
|
|
1065
1031
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1066
|
-
- `options.auth` **
|
|
1032
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1067
1033
|
- `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.
|
|
1068
1034
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1069
1035
|
|
|
@@ -1071,7 +1037,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1071
1037
|
|
|
1072
1038
|
### setUserInfo
|
|
1073
1039
|
|
|
1074
|
-
[src/Particle.js:
|
|
1040
|
+
[src/Particle.js:1105-1108](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1105-L1108 "Source code on GitHub")
|
|
1075
1041
|
|
|
1076
1042
|
Set details on the current user
|
|
1077
1043
|
|
|
@@ -1079,7 +1045,7 @@ Set details on the current user
|
|
|
1079
1045
|
|
|
1080
1046
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1081
1047
|
- `options.accountInfo` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Set user's extended info fields (name, business account, company name, etc)
|
|
1082
|
-
- `options.auth` **
|
|
1048
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1083
1049
|
- `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.
|
|
1084
1050
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1085
1051
|
|
|
@@ -1087,7 +1053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1087
1053
|
|
|
1088
1054
|
### changeUsername
|
|
1089
1055
|
|
|
1090
|
-
[src/Particle.js:
|
|
1056
|
+
[src/Particle.js:1121-1129](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1121-L1129 "Source code on GitHub")
|
|
1091
1057
|
|
|
1092
1058
|
Change username (i.e, email)
|
|
1093
1059
|
|
|
@@ -1097,7 +1063,7 @@ Change username (i.e, email)
|
|
|
1097
1063
|
- `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
|
|
1098
1064
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New email
|
|
1099
1065
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
1100
|
-
- `options.auth` **
|
|
1066
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1101
1067
|
- `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.
|
|
1102
1068
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1103
1069
|
|
|
@@ -1105,7 +1071,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1105
1071
|
|
|
1106
1072
|
### changeUserPassword
|
|
1107
1073
|
|
|
1108
|
-
[src/Particle.js:
|
|
1074
|
+
[src/Particle.js:1142-1150](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1142-L1150 "Source code on GitHub")
|
|
1109
1075
|
|
|
1110
1076
|
Change user's password
|
|
1111
1077
|
|
|
@@ -1115,7 +1081,7 @@ Change user's password
|
|
|
1115
1081
|
- `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
|
|
1116
1082
|
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New password
|
|
1117
1083
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
1118
|
-
- `options.auth` **
|
|
1084
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1119
1085
|
- `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.
|
|
1120
1086
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1121
1087
|
|
|
@@ -1123,7 +1089,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1123
1089
|
|
|
1124
1090
|
### listSIMs
|
|
1125
1091
|
|
|
1126
|
-
[src/Particle.js:
|
|
1092
|
+
[src/Particle.js:1166-1170](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1166-L1170 "Source code on GitHub")
|
|
1127
1093
|
|
|
1128
1094
|
List SIM cards owned by a user or product
|
|
1129
1095
|
|
|
@@ -1136,7 +1102,7 @@ List SIM cards owned by a user or product
|
|
|
1136
1102
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
|
|
1137
1103
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
|
|
1138
1104
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1139
|
-
- `options.auth` **
|
|
1105
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1140
1106
|
- `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.
|
|
1141
1107
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1142
1108
|
|
|
@@ -1144,7 +1110,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1144
1110
|
|
|
1145
1111
|
### getSIMDataUsage
|
|
1146
1112
|
|
|
1147
|
-
[src/Particle.js:
|
|
1113
|
+
[src/Particle.js:1182-1188](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1182-L1188 "Source code on GitHub")
|
|
1148
1114
|
|
|
1149
1115
|
Get data usage for one SIM card for the current billing period
|
|
1150
1116
|
|
|
@@ -1153,7 +1119,7 @@ Get data usage for one SIM card for the current billing period
|
|
|
1153
1119
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1154
1120
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1155
1121
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM card for this product ID or slug
|
|
1156
|
-
- `options.auth` **
|
|
1122
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1157
1123
|
- `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.
|
|
1158
1124
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1159
1125
|
|
|
@@ -1161,7 +1127,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1161
1127
|
|
|
1162
1128
|
### getFleetDataUsage
|
|
1163
1129
|
|
|
1164
|
-
[src/Particle.js:
|
|
1130
|
+
[src/Particle.js:1199-1206](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1199-L1206 "Source code on GitHub")
|
|
1165
1131
|
|
|
1166
1132
|
Get data usage for all SIM cards in a product the current billing period
|
|
1167
1133
|
|
|
@@ -1169,7 +1135,7 @@ Get data usage for all SIM cards in a product the current billing period
|
|
|
1169
1135
|
|
|
1170
1136
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1171
1137
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** SIM cards for this product ID or slug
|
|
1172
|
-
- `options.auth` **
|
|
1138
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1173
1139
|
- `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.
|
|
1174
1140
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1175
1141
|
|
|
@@ -1177,7 +1143,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1177
1143
|
|
|
1178
1144
|
### checkSIM
|
|
1179
1145
|
|
|
1180
|
-
[src/Particle.js:
|
|
1146
|
+
[src/Particle.js:1217-1219](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1217-L1219 "Source code on GitHub")
|
|
1181
1147
|
|
|
1182
1148
|
Check SIM status
|
|
1183
1149
|
|
|
@@ -1185,7 +1151,7 @@ Check SIM status
|
|
|
1185
1151
|
|
|
1186
1152
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1187
1153
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1188
|
-
- `options.auth` **
|
|
1154
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1189
1155
|
- `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.
|
|
1190
1156
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1191
1157
|
|
|
@@ -1193,7 +1159,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1193
1159
|
|
|
1194
1160
|
### activateSIM
|
|
1195
1161
|
|
|
1196
|
-
[src/Particle.js:
|
|
1162
|
+
[src/Particle.js:1234-1244](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1234-L1244 "Source code on GitHub")
|
|
1197
1163
|
|
|
1198
1164
|
Activate and add SIM cards to an account or product
|
|
1199
1165
|
|
|
@@ -1205,7 +1171,7 @@ Activate and add SIM cards to an account or product
|
|
|
1205
1171
|
- `options.country` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ISO country code for the SIM cards
|
|
1206
1172
|
- `options.promoCode` **any?**
|
|
1207
1173
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1208
|
-
- `options.auth` **
|
|
1174
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1209
1175
|
- `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.
|
|
1210
1176
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1211
1177
|
|
|
@@ -1213,7 +1179,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1213
1179
|
|
|
1214
1180
|
### deactivateSIM
|
|
1215
1181
|
|
|
1216
|
-
[src/Particle.js:
|
|
1182
|
+
[src/Particle.js:1256-1260](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1256-L1260 "Source code on GitHub")
|
|
1217
1183
|
|
|
1218
1184
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1219
1185
|
|
|
@@ -1222,7 +1188,7 @@ Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
|
1222
1188
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1223
1189
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1224
1190
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1225
|
-
- `options.auth` **
|
|
1191
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1226
1192
|
- `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.
|
|
1227
1193
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1228
1194
|
|
|
@@ -1230,7 +1196,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1230
1196
|
|
|
1231
1197
|
### reactivateSIM
|
|
1232
1198
|
|
|
1233
|
-
[src/Particle.js:
|
|
1199
|
+
[src/Particle.js:1273-1277](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1273-L1277 "Source code on GitHub")
|
|
1234
1200
|
|
|
1235
1201
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1236
1202
|
|
|
@@ -1240,7 +1206,7 @@ Reactivate a SIM card the was deactivated or unpause a SIM card that was automat
|
|
|
1240
1206
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1241
1207
|
- `options.mbLimit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** New monthly data limit. Necessary if unpausing a SIM card
|
|
1242
1208
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1243
|
-
- `options.auth` **
|
|
1209
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1244
1210
|
- `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.
|
|
1245
1211
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1246
1212
|
|
|
@@ -1248,7 +1214,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1248
1214
|
|
|
1249
1215
|
### updateSIM
|
|
1250
1216
|
|
|
1251
|
-
[src/Particle.js:
|
|
1217
|
+
[src/Particle.js:1290-1294](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1290-L1294 "Source code on GitHub")
|
|
1252
1218
|
|
|
1253
1219
|
Update SIM card data limit
|
|
1254
1220
|
|
|
@@ -1258,7 +1224,7 @@ Update SIM card data limit
|
|
|
1258
1224
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1259
1225
|
- `options.mbLimit` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Data limit in megabyte for the SIM card
|
|
1260
1226
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1261
|
-
- `options.auth` **
|
|
1227
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1262
1228
|
- `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.
|
|
1263
1229
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1264
1230
|
|
|
@@ -1266,7 +1232,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1266
1232
|
|
|
1267
1233
|
### removeSIM
|
|
1268
1234
|
|
|
1269
|
-
[src/Particle.js:
|
|
1235
|
+
[src/Particle.js:1306-1309](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1306-L1309 "Source code on GitHub")
|
|
1270
1236
|
|
|
1271
1237
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1272
1238
|
|
|
@@ -1275,7 +1241,7 @@ Remove a SIM card from an account so it can be activated by a different account
|
|
|
1275
1241
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1276
1242
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1277
1243
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1278
|
-
- `options.auth` **
|
|
1244
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1279
1245
|
- `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.
|
|
1280
1246
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1281
1247
|
|
|
@@ -1283,7 +1249,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1283
1249
|
|
|
1284
1250
|
### listBuildTargets
|
|
1285
1251
|
|
|
1286
|
-
[src/Particle.js:
|
|
1252
|
+
[src/Particle.js:1320-1323](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1320-L1323 "Source code on GitHub")
|
|
1287
1253
|
|
|
1288
1254
|
List valid build targets to be used for compiling
|
|
1289
1255
|
|
|
@@ -1291,7 +1257,7 @@ List valid build targets to be used for compiling
|
|
|
1291
1257
|
|
|
1292
1258
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1293
1259
|
- `options.onlyFeatured` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Only list featured build targets (optional, default `false`)
|
|
1294
|
-
- `options.auth` **
|
|
1260
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1295
1261
|
- `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.
|
|
1296
1262
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1297
1263
|
|
|
@@ -1299,7 +1265,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1299
1265
|
|
|
1300
1266
|
### listLibraries
|
|
1301
1267
|
|
|
1302
|
-
[src/Particle.js:
|
|
1268
|
+
[src/Particle.js:1349-1366](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1349-L1366 "Source code on GitHub")
|
|
1303
1269
|
|
|
1304
1270
|
List firmware libraries
|
|
1305
1271
|
|
|
@@ -1321,7 +1287,7 @@ List firmware libraries
|
|
|
1321
1287
|
\- 'verified' - list only verified libraries
|
|
1322
1288
|
\- 'featured' - list only featured libraries
|
|
1323
1289
|
- `options.excludeScopes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** list of scopes to exclude
|
|
1324
|
-
- `options.auth` **
|
|
1290
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1325
1291
|
- `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.
|
|
1326
1292
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1327
1293
|
|
|
@@ -1329,7 +1295,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1329
1295
|
|
|
1330
1296
|
### getLibrary
|
|
1331
1297
|
|
|
1332
|
-
[src/Particle.js:
|
|
1298
|
+
[src/Particle.js:1382-1390](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1382-L1390 "Source code on GitHub")
|
|
1333
1299
|
|
|
1334
1300
|
Get firmware library details
|
|
1335
1301
|
|
|
@@ -1338,7 +1304,7 @@ Get firmware library details
|
|
|
1338
1304
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1339
1305
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
|
|
1340
1306
|
- `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the library to fetch (default: latest)
|
|
1341
|
-
- `options.auth` **
|
|
1307
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1342
1308
|
- `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.
|
|
1343
1309
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1344
1310
|
|
|
@@ -1346,7 +1312,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1346
1312
|
|
|
1347
1313
|
### getLibraryVersions
|
|
1348
1314
|
|
|
1349
|
-
[src/Particle.js:
|
|
1315
|
+
[src/Particle.js:1403-1411](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1403-L1411 "Source code on GitHub")
|
|
1350
1316
|
|
|
1351
1317
|
Firmware library details for each version
|
|
1352
1318
|
|
|
@@ -1356,7 +1322,7 @@ Firmware library details for each version
|
|
|
1356
1322
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
|
|
1357
1323
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Page index (default, first page)
|
|
1358
1324
|
- `options.limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Number of items per page
|
|
1359
|
-
- `options.auth` **
|
|
1325
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1360
1326
|
- `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.
|
|
1361
1327
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1362
1328
|
|
|
@@ -1364,7 +1330,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1364
1330
|
|
|
1365
1331
|
### contributeLibrary
|
|
1366
1332
|
|
|
1367
|
-
[src/Particle.js:
|
|
1333
|
+
[src/Particle.js:1423-1436](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1423-L1436 "Source code on GitHub")
|
|
1368
1334
|
|
|
1369
1335
|
Contribute a new library version from a compressed archive
|
|
1370
1336
|
|
|
@@ -1373,7 +1339,7 @@ Contribute a new library version from a compressed archive
|
|
|
1373
1339
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1374
1340
|
- `options.archive` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** Compressed archive file containing the library sources
|
|
1375
1341
|
Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
1376
|
-
- `options.auth` **
|
|
1342
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1377
1343
|
- `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.
|
|
1378
1344
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1379
1345
|
|
|
@@ -1381,7 +1347,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1381
1347
|
|
|
1382
1348
|
### publishLibrary
|
|
1383
1349
|
|
|
1384
|
-
[src/Particle.js:
|
|
1350
|
+
[src/Particle.js:1447-1456](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1447-L1456 "Source code on GitHub")
|
|
1385
1351
|
|
|
1386
1352
|
Publish the latest version of a library to the public
|
|
1387
1353
|
|
|
@@ -1389,7 +1355,7 @@ Publish the latest version of a library to the public
|
|
|
1389
1355
|
|
|
1390
1356
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1391
1357
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to publish
|
|
1392
|
-
- `options.auth` **
|
|
1358
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1393
1359
|
- `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.
|
|
1394
1360
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1395
1361
|
|
|
@@ -1397,7 +1363,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1397
1363
|
|
|
1398
1364
|
### deleteLibrary
|
|
1399
1365
|
|
|
1400
|
-
[src/Particle.js:
|
|
1366
|
+
[src/Particle.js:1468-1476](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1468-L1476 "Source code on GitHub")
|
|
1401
1367
|
|
|
1402
1368
|
Delete one version of a library or an entire private library
|
|
1403
1369
|
|
|
@@ -1406,7 +1372,7 @@ Delete one version of a library or an entire private library
|
|
|
1406
1372
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1407
1373
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to remove
|
|
1408
1374
|
- `options.force` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Key to force deleting a public library
|
|
1409
|
-
- `options.auth` **
|
|
1375
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1410
1376
|
- `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.
|
|
1411
1377
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1412
1378
|
|
|
@@ -1414,7 +1380,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1414
1380
|
|
|
1415
1381
|
### downloadFile
|
|
1416
1382
|
|
|
1417
|
-
[src/Particle.js:
|
|
1383
|
+
[src/Particle.js:1486-1488](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1486-L1488 "Source code on GitHub")
|
|
1418
1384
|
|
|
1419
1385
|
Download an external file that may not be on the API
|
|
1420
1386
|
|
|
@@ -1429,7 +1395,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1429
1395
|
|
|
1430
1396
|
### listOAuthClients
|
|
1431
1397
|
|
|
1432
|
-
[src/Particle.js:
|
|
1398
|
+
[src/Particle.js:1499-1502](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1499-L1502 "Source code on GitHub")
|
|
1433
1399
|
|
|
1434
1400
|
List OAuth client created by the account
|
|
1435
1401
|
|
|
@@ -1437,7 +1403,7 @@ List OAuth client created by the account
|
|
|
1437
1403
|
|
|
1438
1404
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1439
1405
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List clients for this product ID or slug
|
|
1440
|
-
- `options.auth` **
|
|
1406
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1441
1407
|
- `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.
|
|
1442
1408
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1443
1409
|
|
|
@@ -1445,7 +1411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1445
1411
|
|
|
1446
1412
|
### createOAuthClient
|
|
1447
1413
|
|
|
1448
|
-
[src/Particle.js:
|
|
1414
|
+
[src/Particle.js:1517-1521](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1517-L1521 "Source code on GitHub")
|
|
1449
1415
|
|
|
1450
1416
|
Create an OAuth client
|
|
1451
1417
|
|
|
@@ -1457,7 +1423,7 @@ Create an OAuth client
|
|
|
1457
1423
|
- `options.redirect_uri` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** URL to redirect after OAuth flow. Only for type web.
|
|
1458
1424
|
- `options.scope` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Limits what the access tokens created by this client can do.
|
|
1459
1425
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Create client for this product ID or slug
|
|
1460
|
-
- `options.auth` **
|
|
1426
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1461
1427
|
- `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.
|
|
1462
1428
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1463
1429
|
|
|
@@ -1465,7 +1431,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1465
1431
|
|
|
1466
1432
|
### updateOAuthClient
|
|
1467
1433
|
|
|
1468
|
-
[src/Particle.js:
|
|
1434
|
+
[src/Particle.js:1535-1539](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1535-L1539 "Source code on GitHub")
|
|
1469
1435
|
|
|
1470
1436
|
Update an OAuth client
|
|
1471
1437
|
|
|
@@ -1476,7 +1442,7 @@ Update an OAuth client
|
|
|
1476
1442
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New Name of the OAuth client
|
|
1477
1443
|
- `options.scope` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** New scope of the OAuth client
|
|
1478
1444
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Update client linked to this product ID or slug
|
|
1479
|
-
- `options.auth` **
|
|
1445
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1480
1446
|
- `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.
|
|
1481
1447
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1482
1448
|
|
|
@@ -1484,7 +1450,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1484
1450
|
|
|
1485
1451
|
### deleteOAuthClient
|
|
1486
1452
|
|
|
1487
|
-
[src/Particle.js:
|
|
1453
|
+
[src/Particle.js:1551-1554](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1551-L1554 "Source code on GitHub")
|
|
1488
1454
|
|
|
1489
1455
|
Delete an OAuth client
|
|
1490
1456
|
|
|
@@ -1493,7 +1459,7 @@ Delete an OAuth client
|
|
|
1493
1459
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1494
1460
|
- `options.clientId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The OAuth client to update
|
|
1495
1461
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** OAuth client linked to this product ID or slug
|
|
1496
|
-
- `options.auth` **
|
|
1462
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1497
1463
|
- `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.
|
|
1498
1464
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1499
1465
|
|
|
@@ -1501,14 +1467,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1501
1467
|
|
|
1502
1468
|
### listProducts
|
|
1503
1469
|
|
|
1504
|
-
[src/Particle.js:
|
|
1470
|
+
[src/Particle.js:1564-1566](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1564-L1566 "Source code on GitHub")
|
|
1505
1471
|
|
|
1506
1472
|
List products the account has access to
|
|
1507
1473
|
|
|
1508
1474
|
**Parameters**
|
|
1509
1475
|
|
|
1510
1476
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1511
|
-
- `options.auth` **
|
|
1477
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1512
1478
|
- `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.
|
|
1513
1479
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1514
1480
|
|
|
@@ -1516,7 +1482,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1516
1482
|
|
|
1517
1483
|
### getProduct
|
|
1518
1484
|
|
|
1519
|
-
[src/Particle.js:
|
|
1485
|
+
[src/Particle.js:1577-1579](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1577-L1579 "Source code on GitHub")
|
|
1520
1486
|
|
|
1521
1487
|
Get detailed information about a product
|
|
1522
1488
|
|
|
@@ -1524,7 +1490,7 @@ Get detailed information about a product
|
|
|
1524
1490
|
|
|
1525
1491
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1526
1492
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID or slug
|
|
1527
|
-
- `options.auth` **
|
|
1493
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1528
1494
|
- `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.
|
|
1529
1495
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1530
1496
|
|
|
@@ -1532,7 +1498,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1532
1498
|
|
|
1533
1499
|
### listProductFirmware
|
|
1534
1500
|
|
|
1535
|
-
[src/Particle.js:
|
|
1501
|
+
[src/Particle.js:1590-1592](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1590-L1592 "Source code on GitHub")
|
|
1536
1502
|
|
|
1537
1503
|
List product firmware versions
|
|
1538
1504
|
|
|
@@ -1540,7 +1506,7 @@ List product firmware versions
|
|
|
1540
1506
|
|
|
1541
1507
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1542
1508
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1543
|
-
- `options.auth` **
|
|
1509
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1544
1510
|
- `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.
|
|
1545
1511
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1546
1512
|
|
|
@@ -1548,7 +1514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1548
1514
|
|
|
1549
1515
|
### uploadProductFirmware
|
|
1550
1516
|
|
|
1551
|
-
[src/Particle.js:
|
|
1517
|
+
[src/Particle.js:1608-1624](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1608-L1624 "Source code on GitHub")
|
|
1552
1518
|
|
|
1553
1519
|
List product firmware versions
|
|
1554
1520
|
|
|
@@ -1561,7 +1527,7 @@ List product firmware versions
|
|
|
1561
1527
|
- `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Short identifier for the new firmware
|
|
1562
1528
|
- `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Longer description for the new firmware
|
|
1563
1529
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1564
|
-
- `options.auth` **
|
|
1530
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1565
1531
|
- `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.
|
|
1566
1532
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1567
1533
|
|
|
@@ -1569,7 +1535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1569
1535
|
|
|
1570
1536
|
### getProductFirmware
|
|
1571
1537
|
|
|
1572
|
-
[src/Particle.js:
|
|
1538
|
+
[src/Particle.js:1636-1643](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1636-L1643 "Source code on GitHub")
|
|
1573
1539
|
|
|
1574
1540
|
Get information about a product firmware version
|
|
1575
1541
|
|
|
@@ -1578,7 +1544,7 @@ Get information about a product firmware version
|
|
|
1578
1544
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1579
1545
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of firmware
|
|
1580
1546
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1581
|
-
- `options.auth` **
|
|
1547
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1582
1548
|
- `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.
|
|
1583
1549
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1584
1550
|
|
|
@@ -1586,7 +1552,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1586
1552
|
|
|
1587
1553
|
### updateProductFirmware
|
|
1588
1554
|
|
|
1589
|
-
[src/Particle.js:
|
|
1555
|
+
[src/Particle.js:1657-1660](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1657-L1660 "Source code on GitHub")
|
|
1590
1556
|
|
|
1591
1557
|
Update information for a product firmware version
|
|
1592
1558
|
|
|
@@ -1597,7 +1563,7 @@ Update information for a product firmware version
|
|
|
1597
1563
|
- `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New title
|
|
1598
1564
|
- `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New description
|
|
1599
1565
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1600
|
-
- `options.auth` **
|
|
1566
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1601
1567
|
- `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.
|
|
1602
1568
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1603
1569
|
|
|
@@ -1605,7 +1571,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1605
1571
|
|
|
1606
1572
|
### downloadProductFirmware
|
|
1607
1573
|
|
|
1608
|
-
[src/Particle.js:
|
|
1574
|
+
[src/Particle.js:1672-1681](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1672-L1681 "Source code on GitHub")
|
|
1609
1575
|
|
|
1610
1576
|
Download a product firmware binary
|
|
1611
1577
|
|
|
@@ -1614,7 +1580,7 @@ Download a product firmware binary
|
|
|
1614
1580
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1615
1581
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
|
|
1616
1582
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1617
|
-
- `options.auth` **
|
|
1583
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1618
1584
|
- `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.
|
|
1619
1585
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1620
1586
|
|
|
@@ -1622,7 +1588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1622
1588
|
|
|
1623
1589
|
### releaseProductFirmware
|
|
1624
1590
|
|
|
1625
|
-
[src/Particle.js:
|
|
1591
|
+
[src/Particle.js:1693-1696](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1693-L1696 "Source code on GitHub")
|
|
1626
1592
|
|
|
1627
1593
|
Release a product firmware version as the default version
|
|
1628
1594
|
|
|
@@ -1631,7 +1597,7 @@ Release a product firmware version as the default version
|
|
|
1631
1597
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1632
1598
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
|
|
1633
1599
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1634
|
-
- `options.auth` **
|
|
1600
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1635
1601
|
- `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.
|
|
1636
1602
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1637
1603
|
|
|
@@ -1639,7 +1605,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1639
1605
|
|
|
1640
1606
|
### listTeamMembers
|
|
1641
1607
|
|
|
1642
|
-
[src/Particle.js:
|
|
1608
|
+
[src/Particle.js:1707-1714](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1707-L1714 "Source code on GitHub")
|
|
1643
1609
|
|
|
1644
1610
|
List product team members
|
|
1645
1611
|
|
|
@@ -1647,7 +1613,7 @@ List product team members
|
|
|
1647
1613
|
|
|
1648
1614
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1649
1615
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1650
|
-
- `options.auth` **
|
|
1616
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1651
1617
|
- `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.
|
|
1652
1618
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1653
1619
|
|
|
@@ -1655,7 +1621,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1655
1621
|
|
|
1656
1622
|
### inviteTeamMember
|
|
1657
1623
|
|
|
1658
|
-
[src/Particle.js:
|
|
1624
|
+
[src/Particle.js:1726-1734](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1726-L1734 "Source code on GitHub")
|
|
1659
1625
|
|
|
1660
1626
|
Invite Particle user to a product team
|
|
1661
1627
|
|
|
@@ -1664,7 +1630,7 @@ Invite Particle user to a product team
|
|
|
1664
1630
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1665
1631
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
|
|
1666
1632
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1667
|
-
- `options.auth` **
|
|
1633
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1668
1634
|
- `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.
|
|
1669
1635
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1670
1636
|
|
|
@@ -1672,7 +1638,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1672
1638
|
|
|
1673
1639
|
### removeTeamMember
|
|
1674
1640
|
|
|
1675
|
-
[src/Particle.js:
|
|
1641
|
+
[src/Particle.js:1746-1753](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1746-L1753 "Source code on GitHub")
|
|
1676
1642
|
|
|
1677
1643
|
Remove Particle user to a product team
|
|
1678
1644
|
|
|
@@ -1681,7 +1647,7 @@ Remove Particle user to a product team
|
|
|
1681
1647
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1682
1648
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
|
|
1683
1649
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1684
|
-
- `options.auth` **
|
|
1650
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1685
1651
|
- `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.
|
|
1686
1652
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1687
1653
|
|
|
@@ -1689,7 +1655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1689
1655
|
|
|
1690
1656
|
### lookupSerialNumber
|
|
1691
1657
|
|
|
1692
|
-
[src/Particle.js:
|
|
1658
|
+
[src/Particle.js:1764-1771](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1764-L1771 "Source code on GitHub")
|
|
1693
1659
|
|
|
1694
1660
|
Fetch details about a serial number
|
|
1695
1661
|
|
|
@@ -1697,7 +1663,7 @@ Fetch details about a serial number
|
|
|
1697
1663
|
|
|
1698
1664
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1699
1665
|
- `options.serialNumber` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The serial number printed on the barcode of the device packaging
|
|
1700
|
-
- `options.auth` **
|
|
1666
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1701
1667
|
- `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.
|
|
1702
1668
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1703
1669
|
|
|
@@ -1705,7 +1671,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1705
1671
|
|
|
1706
1672
|
### createMeshNetwork
|
|
1707
1673
|
|
|
1708
|
-
[src/Particle.js:
|
|
1674
|
+
[src/Particle.js:1784-1792](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1784-L1792 "Source code on GitHub")
|
|
1709
1675
|
|
|
1710
1676
|
Create a mesh network
|
|
1711
1677
|
|
|
@@ -1715,7 +1681,7 @@ Create a mesh network
|
|
|
1715
1681
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network name
|
|
1716
1682
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Gateway device ID
|
|
1717
1683
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ICCID of the active SIM card (only for cellular gateway devices)
|
|
1718
|
-
- `options.auth` **
|
|
1684
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1719
1685
|
- `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.
|
|
1720
1686
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1721
1687
|
|
|
@@ -1723,7 +1689,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1723
1689
|
|
|
1724
1690
|
### removeMeshNetwork
|
|
1725
1691
|
|
|
1726
|
-
[src/Particle.js:
|
|
1692
|
+
[src/Particle.js:1803-1805](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1803-L1805 "Source code on GitHub")
|
|
1727
1693
|
|
|
1728
1694
|
Remove a mesh network.
|
|
1729
1695
|
|
|
@@ -1731,7 +1697,7 @@ Remove a mesh network.
|
|
|
1731
1697
|
|
|
1732
1698
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1733
1699
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1734
|
-
- `options.auth` **
|
|
1700
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1735
1701
|
- `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.
|
|
1736
1702
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1737
1703
|
|
|
@@ -1739,7 +1705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1739
1705
|
|
|
1740
1706
|
### listMeshNetworks
|
|
1741
1707
|
|
|
1742
|
-
[src/Particle.js:
|
|
1708
|
+
[src/Particle.js:1817-1820](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1817-L1820 "Source code on GitHub")
|
|
1743
1709
|
|
|
1744
1710
|
List all mesh networks
|
|
1745
1711
|
|
|
@@ -1748,7 +1714,7 @@ List all mesh networks
|
|
|
1748
1714
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1749
1715
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
|
|
1750
1716
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
|
|
1751
|
-
- `options.auth` **
|
|
1717
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1752
1718
|
- `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.
|
|
1753
1719
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1754
1720
|
|
|
@@ -1756,7 +1722,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1756
1722
|
|
|
1757
1723
|
### getMeshNetwork
|
|
1758
1724
|
|
|
1759
|
-
[src/Particle.js:
|
|
1725
|
+
[src/Particle.js:1831-1833](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1831-L1833 "Source code on GitHub")
|
|
1760
1726
|
|
|
1761
1727
|
Get information about a mesh network.
|
|
1762
1728
|
|
|
@@ -1764,7 +1730,7 @@ Get information about a mesh network.
|
|
|
1764
1730
|
|
|
1765
1731
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1766
1732
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1767
|
-
- `options.auth` **
|
|
1733
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1768
1734
|
- `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.
|
|
1769
1735
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1770
1736
|
|
|
@@ -1772,7 +1738,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1772
1738
|
|
|
1773
1739
|
### updateMeshNetwork
|
|
1774
1740
|
|
|
1775
|
-
[src/Particle.js:
|
|
1741
|
+
[src/Particle.js:1846-1854](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1846-L1854 "Source code on GitHub")
|
|
1776
1742
|
|
|
1777
1743
|
Modify a mesh network.
|
|
1778
1744
|
|
|
@@ -1782,7 +1748,7 @@ Modify a mesh network.
|
|
|
1782
1748
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1783
1749
|
- `options.action` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 'add-device', 'remove-device', 'gateway-enable' or 'gateway-disable'
|
|
1784
1750
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1785
|
-
- `options.auth` **
|
|
1751
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1786
1752
|
- `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.
|
|
1787
1753
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1788
1754
|
|
|
@@ -1790,7 +1756,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1790
1756
|
|
|
1791
1757
|
### addMeshNetworkDevice
|
|
1792
1758
|
|
|
1793
|
-
[src/Particle.js:
|
|
1759
|
+
[src/Particle.js:1866-1875](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1866-L1875 "Source code on GitHub")
|
|
1794
1760
|
|
|
1795
1761
|
Add a device to a mesh network.
|
|
1796
1762
|
|
|
@@ -1799,7 +1765,7 @@ Add a device to a mesh network.
|
|
|
1799
1765
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1800
1766
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1801
1767
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1802
|
-
- `options.auth` **
|
|
1768
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1803
1769
|
- `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.
|
|
1804
1770
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1805
1771
|
|
|
@@ -1807,7 +1773,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1807
1773
|
|
|
1808
1774
|
### removeMeshNetworkDevice
|
|
1809
1775
|
|
|
1810
|
-
[src/Particle.js:
|
|
1776
|
+
[src/Particle.js:1887-1903](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1887-L1903 "Source code on GitHub")
|
|
1811
1777
|
|
|
1812
1778
|
Remove a device from a mesh network.
|
|
1813
1779
|
|
|
@@ -1816,7 +1782,7 @@ Remove a device from a mesh network.
|
|
|
1816
1782
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1817
1783
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Network ID or name
|
|
1818
1784
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1819
|
-
- `options.auth` **
|
|
1785
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1820
1786
|
- `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.
|
|
1821
1787
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1822
1788
|
|
|
@@ -1824,7 +1790,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1824
1790
|
|
|
1825
1791
|
### listMeshNetworkDevices
|
|
1826
1792
|
|
|
1827
|
-
[src/Particle.js:
|
|
1793
|
+
[src/Particle.js:1917-1926](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1917-L1926 "Source code on GitHub")
|
|
1828
1794
|
|
|
1829
1795
|
List all devices of a mesh network.
|
|
1830
1796
|
|
|
@@ -1835,7 +1801,7 @@ List all devices of a mesh network.
|
|
|
1835
1801
|
- `options.role` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Device role: 'gateway' or 'node'
|
|
1836
1802
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
|
|
1837
1803
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
|
|
1838
|
-
- `options.auth` **
|
|
1804
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1839
1805
|
- `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.
|
|
1840
1806
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1841
1807
|
|
|
@@ -1843,14 +1809,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1843
1809
|
|
|
1844
1810
|
### getProductConfiguration
|
|
1845
1811
|
|
|
1846
|
-
[src/Particle.js:
|
|
1812
|
+
[src/Particle.js:1937-1944](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1937-L1944 "Source code on GitHub")
|
|
1847
1813
|
|
|
1848
1814
|
Get product configuration
|
|
1849
1815
|
|
|
1850
1816
|
**Parameters**
|
|
1851
1817
|
|
|
1852
1818
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1853
|
-
- `options.auth` **
|
|
1819
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1854
1820
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1855
1821
|
- `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.
|
|
1856
1822
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -1859,14 +1825,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1859
1825
|
|
|
1860
1826
|
### getProductConfigurationSchema
|
|
1861
1827
|
|
|
1862
|
-
[src/Particle.js:
|
|
1828
|
+
[src/Particle.js:1955-1963](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1955-L1963 "Source code on GitHub")
|
|
1863
1829
|
|
|
1864
1830
|
Get product configuration schema
|
|
1865
1831
|
|
|
1866
1832
|
**Parameters**
|
|
1867
1833
|
|
|
1868
1834
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1869
|
-
- `options.auth` **
|
|
1835
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1870
1836
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1871
1837
|
- `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. (optional, default `{}`)
|
|
1872
1838
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -1875,14 +1841,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1875
1841
|
|
|
1876
1842
|
### getProductDeviceConfiguration
|
|
1877
1843
|
|
|
1878
|
-
[src/Particle.js:
|
|
1844
|
+
[src/Particle.js:1975-1982](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1975-L1982 "Source code on GitHub")
|
|
1879
1845
|
|
|
1880
1846
|
Get product device's configuration
|
|
1881
1847
|
|
|
1882
1848
|
**Parameters**
|
|
1883
1849
|
|
|
1884
1850
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1885
|
-
- `options.auth` **
|
|
1851
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1886
1852
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1887
1853
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1888
1854
|
- `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.
|
|
@@ -1892,14 +1858,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1892
1858
|
|
|
1893
1859
|
### getProductDeviceConfigurationSchema
|
|
1894
1860
|
|
|
1895
|
-
[src/Particle.js:
|
|
1861
|
+
[src/Particle.js:1994-2002](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L1994-L2002 "Source code on GitHub")
|
|
1896
1862
|
|
|
1897
1863
|
Get product device's configuration schema
|
|
1898
1864
|
|
|
1899
1865
|
**Parameters**
|
|
1900
1866
|
|
|
1901
1867
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1902
|
-
- `options.auth` **
|
|
1868
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1903
1869
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1904
1870
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1905
1871
|
- `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.
|
|
@@ -1909,14 +1875,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1909
1875
|
|
|
1910
1876
|
### setProductConfiguration
|
|
1911
1877
|
|
|
1912
|
-
[src/Particle.js:
|
|
1878
|
+
[src/Particle.js:2014-2022](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2014-L2022 "Source code on GitHub")
|
|
1913
1879
|
|
|
1914
1880
|
Set product configuration
|
|
1915
1881
|
|
|
1916
1882
|
**Parameters**
|
|
1917
1883
|
|
|
1918
1884
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1919
|
-
- `options.auth` **
|
|
1885
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1920
1886
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1921
1887
|
- `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
|
|
1922
1888
|
- `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.
|
|
@@ -1926,14 +1892,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1926
1892
|
|
|
1927
1893
|
### setProductDeviceConfiguration
|
|
1928
1894
|
|
|
1929
|
-
[src/Particle.js:
|
|
1895
|
+
[src/Particle.js:2035-2043](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2035-L2043 "Source code on GitHub")
|
|
1930
1896
|
|
|
1931
1897
|
Set product configuration for a specific device within the product
|
|
1932
1898
|
|
|
1933
1899
|
**Parameters**
|
|
1934
1900
|
|
|
1935
1901
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1936
|
-
- `options.auth` **
|
|
1902
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1937
1903
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1938
1904
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1939
1905
|
- `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
|
|
@@ -1944,14 +1910,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1944
1910
|
|
|
1945
1911
|
### getProductLocations
|
|
1946
1912
|
|
|
1947
|
-
[src/Particle.js:
|
|
1913
|
+
[src/Particle.js:2062-2079](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2062-L2079 "Source code on GitHub")
|
|
1948
1914
|
|
|
1949
1915
|
Query location for devices within a product
|
|
1950
1916
|
|
|
1951
1917
|
**Parameters**
|
|
1952
1918
|
|
|
1953
1919
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1954
|
-
- `options.auth` **
|
|
1920
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1955
1921
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
|
|
1956
1922
|
- `options.dateRange` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Start and end date in ISO8601 format, separated by comma, to query
|
|
1957
1923
|
- `options.rectBl` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
|
|
@@ -1968,14 +1934,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1968
1934
|
|
|
1969
1935
|
### getProductDeviceLocations
|
|
1970
1936
|
|
|
1971
|
-
[src/Particle.js:
|
|
1937
|
+
[src/Particle.js:2096-2108](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2096-L2108 "Source code on GitHub")
|
|
1972
1938
|
|
|
1973
1939
|
Query location for one device within a product
|
|
1974
1940
|
|
|
1975
1941
|
**Parameters**
|
|
1976
1942
|
|
|
1977
1943
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1978
|
-
- `options.auth` **
|
|
1944
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1979
1945
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
|
|
1980
1946
|
- `options.dateRange` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Start and end date in ISO8601 format, separated by comma, to query
|
|
1981
1947
|
- `options.rectBl` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
|
|
@@ -1988,7 +1954,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1988
1954
|
|
|
1989
1955
|
### executeLogic
|
|
1990
1956
|
|
|
1991
|
-
[src/Particle.js:
|
|
1957
|
+
[src/Particle.js:2124-2132](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2124-L2132 "Source code on GitHub")
|
|
1992
1958
|
|
|
1993
1959
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
1994
1960
|
|
|
@@ -1997,7 +1963,7 @@ NOTE: Any external interactions such as Particle.publish will actually occur whe
|
|
|
1997
1963
|
**Parameters**
|
|
1998
1964
|
|
|
1999
1965
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2000
|
-
- `options.auth` **
|
|
1966
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2001
1967
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2002
1968
|
- `options.logic` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic "function" which will be executed once
|
|
2003
1969
|
- `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.
|
|
@@ -2007,7 +1973,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2007
1973
|
|
|
2008
1974
|
### createLogicFunction
|
|
2009
1975
|
|
|
2010
|
-
[src/Particle.js:
|
|
1976
|
+
[src/Particle.js:2152-2160](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2152-L2160 "Source code on GitHub")
|
|
2011
1977
|
|
|
2012
1978
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2013
1979
|
|
|
@@ -2020,7 +1986,7 @@ according to the cron and start_at properties.
|
|
|
2020
1986
|
**Parameters**
|
|
2021
1987
|
|
|
2022
1988
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2023
|
-
- `options.auth` **
|
|
1989
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2024
1990
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2025
1991
|
- `options.logicFunction` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic function object containing the function details.
|
|
2026
1992
|
- `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.
|
|
@@ -2030,14 +1996,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2030
1996
|
|
|
2031
1997
|
### getLogicFunction
|
|
2032
1998
|
|
|
2033
|
-
[src/Particle.js:
|
|
1999
|
+
[src/Particle.js:2174-2181](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2174-L2181 "Source code on GitHub")
|
|
2034
2000
|
|
|
2035
2001
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2036
2002
|
|
|
2037
2003
|
**Parameters**
|
|
2038
2004
|
|
|
2039
2005
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
2040
|
-
- `options.auth` **
|
|
2006
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2041
2007
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2042
2008
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
2043
2009
|
- `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.
|
|
@@ -2047,7 +2013,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2047
2013
|
|
|
2048
2014
|
### updateLogicFunction
|
|
2049
2015
|
|
|
2050
|
-
[src/Particle.js:
|
|
2016
|
+
[src/Particle.js:2198-2206](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2198-L2206 "Source code on GitHub")
|
|
2051
2017
|
|
|
2052
2018
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2053
2019
|
|
|
@@ -2056,7 +2022,7 @@ If you include an id on a logic trigger, it will update the logic trigger in pla
|
|
|
2056
2022
|
**Parameters**
|
|
2057
2023
|
|
|
2058
2024
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
2059
|
-
- `options.auth` **
|
|
2025
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2060
2026
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2061
2027
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
2062
2028
|
- `options.logicFunction` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic function object containing the logic function details.
|
|
@@ -2067,14 +2033,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2067
2033
|
|
|
2068
2034
|
### deleteLogicFunction
|
|
2069
2035
|
|
|
2070
|
-
[src/Particle.js:
|
|
2036
|
+
[src/Particle.js:2220-2227](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2220-L2227 "Source code on GitHub")
|
|
2071
2037
|
|
|
2072
2038
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2073
2039
|
|
|
2074
2040
|
**Parameters**
|
|
2075
2041
|
|
|
2076
2042
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
2077
|
-
- `options.auth` **
|
|
2043
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2078
2044
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2079
2045
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
2080
2046
|
- `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.
|
|
@@ -2084,14 +2050,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2084
2050
|
|
|
2085
2051
|
### listLogicFunctions
|
|
2086
2052
|
|
|
2087
|
-
[src/Particle.js:
|
|
2053
|
+
[src/Particle.js:2241-2251](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2241-L2251 "Source code on GitHub")
|
|
2088
2054
|
|
|
2089
2055
|
Lists all logic functions in the specified organization or sandbox.
|
|
2090
2056
|
|
|
2091
2057
|
**Parameters**
|
|
2092
2058
|
|
|
2093
2059
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
2094
|
-
- `options.auth` **
|
|
2060
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2095
2061
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2096
2062
|
- `options.todayStats` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Whether to include today's stats in the response
|
|
2097
2063
|
- `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.
|
|
@@ -2101,14 +2067,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2101
2067
|
|
|
2102
2068
|
### listLogicRuns
|
|
2103
2069
|
|
|
2104
|
-
[src/Particle.js:
|
|
2070
|
+
[src/Particle.js:2265-2272](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2265-L2272 "Source code on GitHub")
|
|
2105
2071
|
|
|
2106
2072
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2107
2073
|
|
|
2108
2074
|
**Parameters**
|
|
2109
2075
|
|
|
2110
2076
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2111
|
-
- `options.auth` **
|
|
2077
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2112
2078
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2113
2079
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic runs.
|
|
2114
2080
|
- `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.
|
|
@@ -2118,14 +2084,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2118
2084
|
|
|
2119
2085
|
### getLogicRun
|
|
2120
2086
|
|
|
2121
|
-
[src/Particle.js:
|
|
2087
|
+
[src/Particle.js:2287-2294](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2287-L2294 "Source code on GitHub")
|
|
2122
2088
|
|
|
2123
2089
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2124
2090
|
|
|
2125
2091
|
**Parameters**
|
|
2126
2092
|
|
|
2127
2093
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2128
|
-
- `options.auth` **
|
|
2094
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2129
2095
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2130
2096
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic run.
|
|
2131
2097
|
- `options.logicRunId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic run to retrieve.
|
|
@@ -2136,14 +2102,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2136
2102
|
|
|
2137
2103
|
### getLogicRunLogs
|
|
2138
2104
|
|
|
2139
|
-
[src/Particle.js:
|
|
2105
|
+
[src/Particle.js:2309-2316](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2309-L2316 "Source code on GitHub")
|
|
2140
2106
|
|
|
2141
2107
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2142
2108
|
|
|
2143
2109
|
**Parameters**
|
|
2144
2110
|
|
|
2145
2111
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2146
|
-
- `options.auth` **
|
|
2112
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2147
2113
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
2148
2114
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic run logs.
|
|
2149
2115
|
- `options.logicRunId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic run for which to retrieve the logs.
|
|
@@ -2154,14 +2120,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2154
2120
|
|
|
2155
2121
|
### createLedger
|
|
2156
2122
|
|
|
2157
|
-
[src/Particle.js:
|
|
2123
|
+
[src/Particle.js:2330-2338](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2330-L2338 "Source code on GitHub")
|
|
2158
2124
|
|
|
2159
2125
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2160
2126
|
|
|
2161
2127
|
**Parameters**
|
|
2162
2128
|
|
|
2163
2129
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
|
|
2164
|
-
- `options.auth` **
|
|
2130
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2165
2131
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2166
2132
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
2167
2133
|
- `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.
|
|
@@ -2171,14 +2137,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2171
2137
|
|
|
2172
2138
|
### getLedger
|
|
2173
2139
|
|
|
2174
|
-
[src/Particle.js:
|
|
2140
|
+
[src/Particle.js:2352-2359](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2352-L2359 "Source code on GitHub")
|
|
2175
2141
|
|
|
2176
2142
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2177
2143
|
|
|
2178
2144
|
**Parameters**
|
|
2179
2145
|
|
|
2180
2146
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
|
|
2181
|
-
- `options.auth` **
|
|
2147
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2182
2148
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2183
2149
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
|
|
2184
2150
|
- `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.
|
|
@@ -2188,14 +2154,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2188
2154
|
|
|
2189
2155
|
### updateLedger
|
|
2190
2156
|
|
|
2191
|
-
[src/Particle.js:
|
|
2157
|
+
[src/Particle.js:2374-2382](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2374-L2382 "Source code on GitHub")
|
|
2192
2158
|
|
|
2193
2159
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2194
2160
|
|
|
2195
2161
|
**Parameters**
|
|
2196
2162
|
|
|
2197
2163
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
|
|
2198
|
-
- `options.auth` **
|
|
2164
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2199
2165
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2200
2166
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
|
|
2201
2167
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
@@ -2206,14 +2172,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2206
2172
|
|
|
2207
2173
|
### archiveLedger
|
|
2208
2174
|
|
|
2209
|
-
[src/Particle.js:
|
|
2175
|
+
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2396-L2403 "Source code on GitHub")
|
|
2210
2176
|
|
|
2211
2177
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2212
2178
|
|
|
2213
2179
|
**Parameters**
|
|
2214
2180
|
|
|
2215
2181
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
|
|
2216
|
-
- `options.auth` **
|
|
2182
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2217
2183
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2218
2184
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
|
|
2219
2185
|
- `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.
|
|
@@ -2223,7 +2189,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2223
2189
|
|
|
2224
2190
|
### Scope
|
|
2225
2191
|
|
|
2226
|
-
[src/Particle.js:
|
|
2192
|
+
[src/Particle.js:2424-2437](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2424-L2437 "Source code on GitHub")
|
|
2227
2193
|
|
|
2228
2194
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2229
2195
|
|
|
@@ -2241,14 +2207,14 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2241
2207
|
|
|
2242
2208
|
### listLedgers
|
|
2243
2209
|
|
|
2244
|
-
[src/Particle.js:
|
|
2210
|
+
[src/Particle.js:2424-2437](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2424-L2437 "Source code on GitHub")
|
|
2245
2211
|
|
|
2246
2212
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2247
2213
|
|
|
2248
2214
|
**Parameters**
|
|
2249
2215
|
|
|
2250
2216
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
|
|
2251
|
-
- `options.auth` **
|
|
2217
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2252
2218
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2253
2219
|
- `options.scope` **Scope?** Filter to show only ledgers of the specified scope
|
|
2254
2220
|
- `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
|
|
@@ -2261,14 +2227,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2261
2227
|
|
|
2262
2228
|
### getLedgerInstance
|
|
2263
2229
|
|
|
2264
|
-
[src/Particle.js:
|
|
2230
|
+
[src/Particle.js:2452-2459](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2452-L2459 "Source code on GitHub")
|
|
2265
2231
|
|
|
2266
2232
|
Get ledger instance data.
|
|
2267
2233
|
|
|
2268
2234
|
**Parameters**
|
|
2269
2235
|
|
|
2270
2236
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2271
|
-
- `options.auth` **
|
|
2237
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2272
2238
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2273
2239
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2274
2240
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2279,7 +2245,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2279
2245
|
|
|
2280
2246
|
### SetMode
|
|
2281
2247
|
|
|
2282
|
-
[src/Particle.js:
|
|
2248
|
+
[src/Particle.js:2480-2491](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2480-L2491 "Source code on GitHub")
|
|
2283
2249
|
|
|
2284
2250
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2285
2251
|
|
|
@@ -2297,14 +2263,14 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2297
2263
|
|
|
2298
2264
|
### setLedgerInstance
|
|
2299
2265
|
|
|
2300
|
-
[src/Particle.js:
|
|
2266
|
+
[src/Particle.js:2480-2491](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2480-L2491 "Source code on GitHub")
|
|
2301
2267
|
|
|
2302
2268
|
Set ledger instance data.
|
|
2303
2269
|
|
|
2304
2270
|
**Parameters**
|
|
2305
2271
|
|
|
2306
2272
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
|
|
2307
|
-
- `options.auth` **
|
|
2273
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2308
2274
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2309
2275
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2310
2276
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2317,14 +2283,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2317
2283
|
|
|
2318
2284
|
### deleteLedgerInstance
|
|
2319
2285
|
|
|
2320
|
-
[src/Particle.js:
|
|
2286
|
+
[src/Particle.js:2506-2513](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2506-L2513 "Source code on GitHub")
|
|
2321
2287
|
|
|
2322
2288
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2323
2289
|
|
|
2324
2290
|
**Parameters**
|
|
2325
2291
|
|
|
2326
2292
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
|
|
2327
|
-
- `options.auth` **
|
|
2293
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2328
2294
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2329
2295
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2330
2296
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2335,14 +2301,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2335
2301
|
|
|
2336
2302
|
### listLedgerInstances
|
|
2337
2303
|
|
|
2338
|
-
[src/Particle.js:
|
|
2304
|
+
[src/Particle.js:2529-2540](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2529-L2540 "Source code on GitHub")
|
|
2339
2305
|
|
|
2340
2306
|
Lists ledger instances in the specified organization or sandbox.
|
|
2341
2307
|
|
|
2342
2308
|
**Parameters**
|
|
2343
2309
|
|
|
2344
2310
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
|
|
2345
|
-
- `options.auth` **
|
|
2311
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2346
2312
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
2347
2313
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2348
2314
|
- `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
|
|
@@ -2354,14 +2320,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2354
2320
|
|
|
2355
2321
|
### listLedgerInstanceVersions
|
|
2356
2322
|
|
|
2357
|
-
[src/Particle.js:
|
|
2323
|
+
[src/Particle.js:2557-2568](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2557-L2568 "Source code on GitHub")
|
|
2358
2324
|
|
|
2359
2325
|
List ledger instance versions
|
|
2360
2326
|
|
|
2361
2327
|
**Parameters**
|
|
2362
2328
|
|
|
2363
2329
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2364
|
-
- `options.auth` **
|
|
2330
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2365
2331
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2366
2332
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2367
2333
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2374,14 +2340,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2374
2340
|
|
|
2375
2341
|
### getLedgerInstanceVersion
|
|
2376
2342
|
|
|
2377
|
-
[src/Particle.js:
|
|
2343
|
+
[src/Particle.js:2584-2591](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2584-L2591 "Source code on GitHub")
|
|
2378
2344
|
|
|
2379
2345
|
Get specific ledger instance version
|
|
2380
2346
|
|
|
2381
2347
|
**Parameters**
|
|
2382
2348
|
|
|
2383
2349
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2384
|
-
- `options.auth` **
|
|
2350
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2385
2351
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2386
2352
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2387
2353
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2391,22 +2357,58 @@ Get specific ledger instance version
|
|
|
2391
2357
|
|
|
2392
2358
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified ledger instance data.
|
|
2393
2359
|
|
|
2360
|
+
### listDeviceOsVersions
|
|
2361
|
+
|
|
2362
|
+
[src/Particle.js:2607-2622](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2607-L2622 "Source code on GitHub")
|
|
2363
|
+
|
|
2364
|
+
List Device OS versions
|
|
2365
|
+
|
|
2366
|
+
**Parameters**
|
|
2367
|
+
|
|
2368
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
2369
|
+
- `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Platform ID to filter Device OS versions
|
|
2370
|
+
- `options.internalVersion` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Internal version number to filter Device OS versions
|
|
2371
|
+
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page number for pagination
|
|
2372
|
+
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Number of items per page
|
|
2373
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2374
|
+
- `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.
|
|
2375
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2376
|
+
|
|
2377
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the list of Device OS versions.
|
|
2378
|
+
|
|
2379
|
+
### getDeviceOsVersion
|
|
2380
|
+
|
|
2381
|
+
[src/Particle.js:2636-2645](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2636-L2645 "Source code on GitHub")
|
|
2382
|
+
|
|
2383
|
+
Get a specific Device OS version
|
|
2384
|
+
|
|
2385
|
+
**Parameters**
|
|
2386
|
+
|
|
2387
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
2388
|
+
- `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the Device OS
|
|
2389
|
+
- `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Optional platform ID to filter Device OS version
|
|
2390
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2391
|
+
- `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.
|
|
2392
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2393
|
+
|
|
2394
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified Device OS version data.
|
|
2395
|
+
|
|
2394
2396
|
### setDefaultAuth
|
|
2395
2397
|
|
|
2396
|
-
[src/Particle.js:
|
|
2398
|
+
[src/Particle.js:2652-2658](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2652-L2658 "Source code on GitHub")
|
|
2397
2399
|
|
|
2398
2400
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2399
2401
|
|
|
2400
2402
|
**Parameters**
|
|
2401
2403
|
|
|
2402
|
-
- `auth` **
|
|
2404
|
+
- `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The access token
|
|
2403
2405
|
|
|
2404
2406
|
|
|
2405
2407
|
- Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** When not auth string is provided
|
|
2406
2408
|
|
|
2407
2409
|
### get
|
|
2408
2410
|
|
|
2409
|
-
[src/Particle.js:
|
|
2411
|
+
[src/Particle.js:2708-2712](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2708-L2712 "Source code on GitHub")
|
|
2410
2412
|
|
|
2411
2413
|
Make a GET request
|
|
2412
2414
|
|
|
@@ -2414,7 +2416,7 @@ Make a GET request
|
|
|
2414
2416
|
|
|
2415
2417
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2416
2418
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2417
|
-
- `params.auth` **
|
|
2419
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2418
2420
|
- `params.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.
|
|
2419
2421
|
- `params.query` **[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
|
|
2420
2422
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2423,7 +2425,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2423
2425
|
|
|
2424
2426
|
### head
|
|
2425
2427
|
|
|
2426
|
-
[src/Particle.js:
|
|
2428
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
2427
2429
|
|
|
2428
2430
|
Make a HEAD request
|
|
2429
2431
|
|
|
@@ -2431,7 +2433,7 @@ Make a HEAD request
|
|
|
2431
2433
|
|
|
2432
2434
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2433
2435
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2434
|
-
- `params.auth` **
|
|
2436
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2435
2437
|
- `params.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.
|
|
2436
2438
|
- `params.query` **[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
|
|
2437
2439
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2440,7 +2442,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2440
2442
|
|
|
2441
2443
|
### post
|
|
2442
2444
|
|
|
2443
|
-
[src/Particle.js:
|
|
2445
|
+
[src/Particle.js:2740-2744](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2740-L2744 "Source code on GitHub")
|
|
2444
2446
|
|
|
2445
2447
|
Make a POST request
|
|
2446
2448
|
|
|
@@ -2448,7 +2450,7 @@ Make a POST request
|
|
|
2448
2450
|
|
|
2449
2451
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2450
2452
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2451
|
-
- `params.auth` **
|
|
2453
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2452
2454
|
- `params.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.
|
|
2453
2455
|
- `params.data` **([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))?** Request body
|
|
2454
2456
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2457,7 +2459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2457
2459
|
|
|
2458
2460
|
### put
|
|
2459
2461
|
|
|
2460
|
-
[src/Particle.js:
|
|
2462
|
+
[src/Particle.js:2757-2761](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2757-L2761 "Source code on GitHub")
|
|
2461
2463
|
|
|
2462
2464
|
Make a PUT request
|
|
2463
2465
|
|
|
@@ -2465,7 +2467,7 @@ Make a PUT request
|
|
|
2465
2467
|
|
|
2466
2468
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2467
2469
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2468
|
-
- `params.auth` **
|
|
2470
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2469
2471
|
- `params.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.
|
|
2470
2472
|
- `params.data` **([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))?** Request body
|
|
2471
2473
|
- `params.query` **[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
|
|
@@ -2475,7 +2477,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2475
2477
|
|
|
2476
2478
|
### delete
|
|
2477
2479
|
|
|
2478
|
-
[src/Particle.js:
|
|
2480
|
+
[src/Particle.js:2773-2777](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2773-L2777 "Source code on GitHub")
|
|
2479
2481
|
|
|
2480
2482
|
Make a DELETE request
|
|
2481
2483
|
|
|
@@ -2483,7 +2485,7 @@ Make a DELETE request
|
|
|
2483
2485
|
|
|
2484
2486
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2485
2487
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2486
|
-
- `params.auth` **
|
|
2488
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2487
2489
|
- `params.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.
|
|
2488
2490
|
- `params.data` **([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))?** Request body
|
|
2489
2491
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2492,7 +2494,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2492
2494
|
|
|
2493
2495
|
### request
|
|
2494
2496
|
|
|
2495
|
-
[src/Particle.js:
|
|
2497
|
+
[src/Particle.js:2794-2798](https://github.com/particle-iot/particle-api-js/blob/8e751f8815e7eea5381202011811386adc7968a6/src/Particle.js#L2794-L2798 "Source code on GitHub")
|
|
2496
2498
|
|
|
2497
2499
|
**Parameters**
|
|
2498
2500
|
|
|
@@ -2501,7 +2503,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2501
2503
|
- `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.
|
|
2502
2504
|
- `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.
|
|
2503
2505
|
- `args.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Arbitrary data to send as the body.
|
|
2504
|
-
- `args.auth` **
|
|
2506
|
+
- `args.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization
|
|
2505
2507
|
- `args.query` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Query parameters
|
|
2506
2508
|
- `args.form` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Form fields
|
|
2507
2509
|
- `args.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Array of file names and file content
|