particle-api-js 11.1.6 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +90 -10
  2. package/dist/particle.min.js +1 -1
  3. package/dist/particle.min.js.map +1 -1
  4. package/fs.d.ts +2 -0
  5. package/lib/fs.d.ts +2 -0
  6. package/lib/fs.js +3 -0
  7. package/lib/package.json +109 -0
  8. package/lib/src/Agent.d.ts +38 -0
  9. package/lib/src/Agent.d.ts.map +1 -0
  10. package/lib/src/Agent.js +228 -0
  11. package/lib/src/Agent.js.map +1 -0
  12. package/lib/src/Client.d.ts +80 -0
  13. package/lib/src/Client.d.ts.map +1 -0
  14. package/lib/src/Client.js +104 -0
  15. package/lib/src/Client.js.map +1 -0
  16. package/lib/src/Defaults.d.ts +6 -0
  17. package/lib/src/Defaults.d.ts.map +1 -0
  18. package/lib/src/Defaults.js +12 -0
  19. package/lib/src/Defaults.js.map +1 -0
  20. package/lib/src/EventStream.d.ts +29 -0
  21. package/lib/src/EventStream.d.ts.map +1 -0
  22. package/lib/src/EventStream.js +270 -0
  23. package/lib/src/EventStream.js.map +1 -0
  24. package/lib/src/Library.d.ts +33 -0
  25. package/lib/src/Library.d.ts.map +1 -0
  26. package/lib/src/Library.js +19 -0
  27. package/lib/src/Library.js.map +1 -0
  28. package/{src/Particle.js → lib/src/Particle.d.ts} +797 -1653
  29. package/lib/src/Particle.d.ts.map +1 -0
  30. package/lib/src/Particle.js +2794 -0
  31. package/lib/src/Particle.js.map +1 -0
  32. package/lib/src/types/common.d.ts +71 -0
  33. package/lib/src/types/common.d.ts.map +1 -0
  34. package/lib/src/types/common.js +3 -0
  35. package/lib/src/types/common.js.map +1 -0
  36. package/lib/src/types/index.d.ts +4 -0
  37. package/lib/src/types/index.d.ts.map +1 -0
  38. package/lib/src/types/index.js +20 -0
  39. package/lib/src/types/index.js.map +1 -0
  40. package/lib/src/types/requests.d.ts +667 -0
  41. package/lib/src/types/requests.d.ts.map +1 -0
  42. package/lib/src/types/requests.js +3 -0
  43. package/lib/src/types/requests.js.map +1 -0
  44. package/lib/src/types/responses.d.ts +472 -0
  45. package/lib/src/types/responses.d.ts.map +1 -0
  46. package/lib/src/types/responses.js +3 -0
  47. package/lib/src/types/responses.js.map +1 -0
  48. package/package.json +34 -14
  49. package/scripts/postprocess-docs.js +306 -0
  50. package/typedoc.json +20 -0
  51. package/.circleci/config.yml +0 -104
  52. package/.nvmrc +0 -1
  53. package/CHANGELOG.md +0 -401
  54. package/EventStream-e2e-browser.html +0 -39
  55. package/EventStream-e2e-node.js +0 -34
  56. package/RELEASE.md +0 -12
  57. package/bower.json +0 -30
  58. package/docs/api.md +0 -2577
  59. package/eslint.config.mjs +0 -7
  60. package/examples/login/login.html +0 -17
  61. package/karma.conf.js +0 -80
  62. package/src/Agent.js +0 -397
  63. package/src/Client.js +0 -171
  64. package/src/Defaults.js +0 -8
  65. package/src/EventStream.js +0 -269
  66. package/src/Library.js +0 -33
  67. package/test/Agent.integration.js +0 -23
  68. package/test/Agent.spec.js +0 -488
  69. package/test/Client.spec.js +0 -216
  70. package/test/Defaults.spec.js +0 -30
  71. package/test/EventStream.feature +0 -65
  72. package/test/EventStream.spec.js +0 -263
  73. package/test/FakeAgent.js +0 -27
  74. package/test/Library.spec.js +0 -40
  75. package/test/Particle.integration.js +0 -38
  76. package/test/Particle.spec.js +0 -3198
  77. package/test/fixtures/index.js +0 -15
  78. package/test/fixtures/libraries.json +0 -33
  79. package/test/fixtures/library.json +0 -31
  80. package/test/fixtures/libraryVersions.json +0 -211
  81. package/test/out.tmp +0 -0
  82. package/test/support/FixtureHttpServer.js +0 -28
  83. package/test/test-setup.js +0 -17
  84. package/tsconfig.json +0 -17
  85. package/webpack.config.js +0 -46
package/docs/api.md DELETED
@@ -1,2577 +0,0 @@
1
- <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
2
-
3
- ### Table of Contents
4
-
5
- - [Particle](#particle)
6
- - [constructor](#constructor)
7
- - [ToolContext](#toolcontext)
8
- - [ProjectContext](#projectcontext)
9
- - [setContext](#setcontext)
10
- - [login](#login)
11
- - [sendOtp](#sendotp)
12
- - [enableMfa](#enablemfa)
13
- - [confirmMfa](#confirmmfa)
14
- - [disableMfa](#disablemfa)
15
- - [createCustomer](#createcustomer)
16
- - [loginAsClientOwner](#loginasclientowner)
17
- - [createUser](#createuser)
18
- - [verifyUser](#verifyuser)
19
- - [resetPassword](#resetpassword)
20
- - [deleteAccessToken](#deleteaccesstoken)
21
- - [deleteCurrentAccessToken](#deletecurrentaccesstoken)
22
- - [deleteActiveAccessTokens](#deleteactiveaccesstokens)
23
- - [deleteUser](#deleteuser)
24
- - [trackingIdentity](#trackingidentity)
25
- - [listDevices](#listdevices)
26
- - [getDevice](#getdevice)
27
- - [claimDevice](#claimdevice)
28
- - [addDeviceToProduct](#adddevicetoproduct)
29
- - [removeDevice](#removedevice)
30
- - [removeDeviceOwner](#removedeviceowner)
31
- - [renameDevice](#renamedevice)
32
- - [signalDevice](#signaldevice)
33
- - [setDeviceNotes](#setdevicenotes)
34
- - [markAsDevelopmentDevice](#markasdevelopmentdevice)
35
- - [lockDeviceProductFirmware](#lockdeviceproductfirmware)
36
- - [unlockDeviceProductFirmware](#unlockdeviceproductfirmware)
37
- - [updateDevice](#updatedevice)
38
- - [unprotectDevice](#unprotectdevice)
39
- - [provisionDevice](#provisiondevice)
40
- - [getClaimCode](#getclaimcode)
41
- - [getVariable](#getvariable)
42
- - [flashDevice](#flashdevice)
43
- - [flashTinker](#flashtinker)
44
- - [compileCode](#compilecode)
45
- - [downloadFirmwareBinary](#downloadfirmwarebinary)
46
- - [sendPublicKey](#sendpublickey)
47
- - [callFunction](#callfunction)
48
- - [getEventStream](#geteventstream)
49
- - [publishEvent](#publishevent)
50
- - [Hook](#hook)
51
- - [createWebhook](#createwebhook)
52
- - [deleteWebhook](#deletewebhook)
53
- - [listWebhooks](#listwebhooks)
54
- - [createIntegration](#createintegration)
55
- - [editIntegration](#editintegration)
56
- - [deleteIntegration](#deleteintegration)
57
- - [listIntegrations](#listintegrations)
58
- - [getUserInfo](#getuserinfo)
59
- - [setUserInfo](#setuserinfo)
60
- - [changeUsername](#changeusername)
61
- - [changeUserPassword](#changeuserpassword)
62
- - [listSIMs](#listsims)
63
- - [getSIMDataUsage](#getsimdatausage)
64
- - [getFleetDataUsage](#getfleetdatausage)
65
- - [checkSIM](#checksim)
66
- - [activateSIM](#activatesim)
67
- - [deactivateSIM](#deactivatesim)
68
- - [reactivateSIM](#reactivatesim)
69
- - [updateSIM](#updatesim)
70
- - [removeSIM](#removesim)
71
- - [listBuildTargets](#listbuildtargets)
72
- - [listLibraries](#listlibraries)
73
- - [getLibrary](#getlibrary)
74
- - [getLibraryVersions](#getlibraryversions)
75
- - [contributeLibrary](#contributelibrary)
76
- - [publishLibrary](#publishlibrary)
77
- - [deleteLibrary](#deletelibrary)
78
- - [downloadFile](#downloadfile)
79
- - [listOAuthClients](#listoauthclients)
80
- - [createOAuthClient](#createoauthclient)
81
- - [updateOAuthClient](#updateoauthclient)
82
- - [deleteOAuthClient](#deleteoauthclient)
83
- - [listProducts](#listproducts)
84
- - [getProduct](#getproduct)
85
- - [listProductFirmware](#listproductfirmware)
86
- - [uploadProductFirmware](#uploadproductfirmware)
87
- - [getProductFirmware](#getproductfirmware)
88
- - [updateProductFirmware](#updateproductfirmware)
89
- - [downloadProductFirmware](#downloadproductfirmware)
90
- - [releaseProductFirmware](#releaseproductfirmware)
91
- - [listTeamMembers](#listteammembers)
92
- - [inviteTeamMember](#inviteteammember)
93
- - [removeTeamMember](#removeteammember)
94
- - [lookupSerialNumber](#lookupserialnumber)
95
- - [createMeshNetwork](#createmeshnetwork)
96
- - [removeMeshNetwork](#removemeshnetwork)
97
- - [listMeshNetworks](#listmeshnetworks)
98
- - [getMeshNetwork](#getmeshnetwork)
99
- - [updateMeshNetwork](#updatemeshnetwork)
100
- - [addMeshNetworkDevice](#addmeshnetworkdevice)
101
- - [removeMeshNetworkDevice](#removemeshnetworkdevice)
102
- - [listMeshNetworkDevices](#listmeshnetworkdevices)
103
- - [getProductConfiguration](#getproductconfiguration)
104
- - [getProductConfigurationSchema](#getproductconfigurationschema)
105
- - [getProductDeviceConfiguration](#getproductdeviceconfiguration)
106
- - [getProductDeviceConfigurationSchema](#getproductdeviceconfigurationschema)
107
- - [setProductConfiguration](#setproductconfiguration)
108
- - [setProductDeviceConfiguration](#setproductdeviceconfiguration)
109
- - [getProductLocations](#getproductlocations)
110
- - [getProductDeviceLocations](#getproductdevicelocations)
111
- - [executeLogic](#executelogic)
112
- - [createLogicFunction](#createlogicfunction)
113
- - [getLogicFunction](#getlogicfunction)
114
- - [updateLogicFunction](#updatelogicfunction)
115
- - [deleteLogicFunction](#deletelogicfunction)
116
- - [listLogicFunctions](#listlogicfunctions)
117
- - [listLogicRuns](#listlogicruns)
118
- - [getLogicRun](#getlogicrun)
119
- - [getLogicRunLogs](#getlogicrunlogs)
120
- - [createLedger](#createledger)
121
- - [getLedger](#getledger)
122
- - [updateLedger](#updateledger)
123
- - [archiveLedger](#archiveledger)
124
- - [Scope](#scope)
125
- - [listLedgers](#listledgers)
126
- - [getLedgerInstance](#getledgerinstance)
127
- - [SetMode](#setmode)
128
- - [setLedgerInstance](#setledgerinstance)
129
- - [deleteLedgerInstance](#deleteledgerinstance)
130
- - [listLedgerInstances](#listledgerinstances)
131
- - [listLedgerInstanceVersions](#listledgerinstanceversions)
132
- - [getLedgerInstanceVersion](#getledgerinstanceversion)
133
- - [listDeviceOsVersions](#listdeviceosversions)
134
- - [getDeviceOsVersion](#getdeviceosversion)
135
- - [setDefaultAuth](#setdefaultauth)
136
- - [get](#get)
137
- - [head](#head)
138
- - [post](#post)
139
- - [put](#put)
140
- - [delete](#delete)
141
- - [request](#request)
142
-
143
- ## Particle
144
-
145
- [src/Particle.js:20-2847](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L20-L2847 "Source code on GitHub")
146
-
147
- Particle Cloud API wrapper.
148
-
149
- See <https://docs.particle.io/reference/javascript/> for examples
150
- of using the `Particle` class.
151
-
152
- Most Particle methods take a single unnamed argument object documented as
153
- `options` with key/value pairs for each option.
154
-
155
- **Parameters**
156
-
157
- - `options` (optional, default `{}`)
158
-
159
- ### constructor
160
-
161
- [src/Particle.js:33-43](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L33-L43 "Source code on GitHub")
162
-
163
- Contructor for the Cloud API wrapper.
164
-
165
- Create a new Particle object and call methods below on it.
166
-
167
- **Parameters**
168
-
169
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call Options to be used for all requests (see [Defaults](../src/Defaults.js)) (optional, default `{}`)
170
- - `options.baseUrl` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
171
- - `options.clientSecret` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
172
- - `options.clientId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
173
- - `options.tokenDuration` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?**
174
- - `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. If not specified here, will have to be added to every request
175
-
176
- ### ToolContext
177
-
178
- [src/Particle.js:68-76](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L68-L76 "Source code on GitHub")
179
-
180
- Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
181
-
182
- **Parameters**
183
-
184
- - `name`
185
- - `context`
186
-
187
- **Properties**
188
-
189
- - `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
190
- - `version` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))?**
191
- - `components` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;Omit&lt;ToolContext, `"components"`>>?**
192
-
193
- ### ProjectContext
194
-
195
- [src/Particle.js:68-76](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L68-L76 "Source code on GitHub")
196
-
197
- Type: Record&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), ([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))>
198
-
199
- **Parameters**
200
-
201
- - `name`
202
- - `context`
203
-
204
- **Properties**
205
-
206
- - `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
207
-
208
- ### setContext
209
-
210
- [src/Particle.js:68-76](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L68-L76 "Source code on GitHub")
211
-
212
- Allows setting a tool or project context which will be sent as headers with every request.
213
- Tool- x-particle-tool
214
- Project- x-particle-project
215
-
216
- **Parameters**
217
-
218
- - `name` **(`"tool"` \| `"project"`)**
219
- - `context` **(ToolContext | ProjectContext | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))**
220
-
221
- ### login
222
-
223
- [src/Particle.js:99-116](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L99-L116 "Source code on GitHub")
224
-
225
- Login to Particle Cloud using an existing Particle acccount.
226
-
227
- **Parameters**
228
-
229
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
230
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
231
- - `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password for the Particle account
232
- - `options.tokenDuration` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** How long the access token should last in seconds (optional, default `this.tokenDuration`)
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
- - `options.context` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Request context
235
-
236
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
237
-
238
- ### sendOtp
239
-
240
- [src/Particle.js:127-143](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L127-L143 "Source code on GitHub")
241
-
242
- If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
243
-
244
- **Parameters**
245
-
246
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
247
- - `options.mfaToken` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Given as 'mfa_token' in the error body of `.login()`.
248
- - `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
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
- - `options.context` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Request context
251
-
252
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
253
-
254
- ### enableMfa
255
-
256
- [src/Particle.js:153-155](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L153-L155 "Source code on GitHub")
257
-
258
- Enable MFA on the currently logged in user
259
-
260
- **Parameters**
261
-
262
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
263
- - `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
264
- - `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.
265
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
266
-
267
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
268
-
269
- ### confirmMfa
270
-
271
- [src/Particle.js:168-182](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L168-L182 "Source code on GitHub")
272
-
273
- Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
274
-
275
- **Parameters**
276
-
277
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
278
- - `options.mfaToken` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Token given from previous step to
279
- - `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
280
- - `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
281
- - `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
282
- - `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.
283
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
284
-
285
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
286
-
287
- ### disableMfa
288
-
289
- [src/Particle.js:193-201](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L193-L201 "Source code on GitHub")
290
-
291
- Disable MFA for the user.
292
-
293
- **Parameters**
294
-
295
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
296
- - `options.currentPassword` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** User's current password
297
- - `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
298
- - `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.
299
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
300
-
301
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
302
-
303
- ### createCustomer
304
-
305
- [src/Particle.js:213-229](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L213-L229 "Source code on GitHub")
306
-
307
- Create Customer for Product.
308
-
309
- **Parameters**
310
-
311
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
312
- - `options.email` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
313
- - `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password for the Particle account
314
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Create the customer in this product ID or slug
315
- - `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.
316
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
317
-
318
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
319
-
320
- ### loginAsClientOwner
321
-
322
- [src/Particle.js:238-252](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L238-L252 "Source code on GitHub")
323
-
324
- Login to Particle Cloud using an OAuth client.
325
-
326
- **Parameters**
327
-
328
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
329
- - `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.
330
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
331
-
332
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
333
-
334
- ### createUser
335
-
336
- [src/Particle.js:265-277](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L265-L277 "Source code on GitHub")
337
-
338
- Create a user account for the Particle Cloud
339
-
340
- **Parameters**
341
-
342
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
343
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Email of the new user
344
- - `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
345
- - `options.accountInfo` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Object that contains account information fields such as user real name, company name, business account flag etc
346
- - `options.utm` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Object that contains info about the campaign that lead to this user creation
347
- - `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.
348
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
349
-
350
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
351
-
352
- ### verifyUser
353
-
354
- [src/Particle.js:287-294](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L287-L294 "Source code on GitHub")
355
-
356
- Verify new user account via verification email
357
-
358
- **Parameters**
359
-
360
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
361
- - `options.token` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The string token sent in the verification email
362
- - `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.
363
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
364
-
365
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
366
-
367
- ### resetPassword
368
-
369
- [src/Particle.js:304-311](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L304-L311 "Source code on GitHub")
370
-
371
- Send reset password email for a Particle Cloud user account
372
-
373
- **Parameters**
374
-
375
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
376
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Email of the user
377
- - `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.
378
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
379
-
380
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
381
-
382
- ### deleteAccessToken
383
-
384
- [src/Particle.js:321-327](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L321-L327 "Source code on GitHub")
385
-
386
- Revoke an access token
387
-
388
- **Parameters**
389
-
390
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
391
- - `options.token` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access token you wish to revoke
392
- - `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.
393
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
394
-
395
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
396
-
397
- ### deleteCurrentAccessToken
398
-
399
- [src/Particle.js:337-344](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L337-L344 "Source code on GitHub")
400
-
401
- Revoke the current session access token
402
-
403
- **Parameters**
404
-
405
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
406
- - `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
407
- - `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.
408
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
409
-
410
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
411
-
412
- ### deleteActiveAccessTokens
413
-
414
- [src/Particle.js:354-361](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L354-L361 "Source code on GitHub")
415
-
416
- Revoke all active access tokens
417
-
418
- **Parameters**
419
-
420
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
421
- - `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
422
- - `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.
423
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
424
-
425
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
426
-
427
- ### deleteUser
428
-
429
- [src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L372-L380 "Source code on GitHub")
430
-
431
- Delete the current user
432
-
433
- **Parameters**
434
-
435
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
436
- - `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
437
- - `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
438
- - `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.
439
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
440
-
441
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
442
-
443
- ### trackingIdentity
444
-
445
- [src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L392-L400 "Source code on GitHub")
446
-
447
- Retrieves the information that is used to identify the current login for tracking.
448
-
449
- **Parameters**
450
-
451
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options for this API call (optional, default `{}`)
452
- - `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,
453
- retrieve only the unique tracking ID for the current login. (optional, default `false`)
454
- - `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
455
- - `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.
456
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
457
-
458
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** Resolve the tracking identify of the current login
459
-
460
- ### listDevices
461
-
462
- [src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L418-L437 "Source code on GitHub")
463
-
464
- List devices claimed to the account or product
465
-
466
- **Parameters**
467
-
468
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
469
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) Filter results to devices with this ID (partial matching)
470
- - `options.deviceName` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) Filter results to devices with this name (partial matching)
471
- - `options.groups` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** (Product only) A list of full group names to filter results to devices belonging to these groups only.
472
- - `options.sortAttr` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) The attribute by which to sort results. See API docs for options.
473
- - `options.sortDir` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) The direction of sorting. See API docs for options.
474
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
475
- - `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
476
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List devices in this product ID or slug
477
- - `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
478
- - `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.
479
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
480
-
481
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
482
-
483
- ### getDevice
484
-
485
- [src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L449-L452 "Source code on GitHub")
486
-
487
- Get detailed informationa about a device
488
-
489
- **Parameters**
490
-
491
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
492
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
493
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
494
- - `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
495
- - `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.
496
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
497
-
498
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
499
-
500
- ### claimDevice
501
-
502
- [src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L464-L475 "Source code on GitHub")
503
-
504
- Claim a device to the account. The device must be online and unclaimed.
505
-
506
- **Parameters**
507
-
508
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
509
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
510
- - `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
511
- - `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
512
- - `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.
513
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
514
-
515
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
516
-
517
- ### addDeviceToProduct
518
-
519
- [src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L489-L507 "Source code on GitHub")
520
-
521
- Add a device to a product or move device out of quarantine.
522
-
523
- **Parameters**
524
-
525
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
526
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
527
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Add to this product ID or slug
528
- - `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.
529
- Node: Either a path or Buffer. Browser: a File or Blob.
530
- - `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
531
- - `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.
532
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
533
-
534
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
535
-
536
- ### removeDevice
537
-
538
- [src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L520-L524 "Source code on GitHub")
539
-
540
- Unclaim / Remove a device from your account or product, or deny quarantine
541
-
542
- **Parameters**
543
-
544
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
545
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
546
- - `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
547
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
548
- - `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
549
- - `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.
550
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
551
-
552
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
553
-
554
- ### removeDeviceOwner
555
-
556
- [src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L536-L539 "Source code on GitHub")
557
-
558
- Unclaim a product device its the owner, but keep it in the product
559
-
560
- **Parameters**
561
-
562
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
563
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
564
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
565
- - `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
566
- - `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.
567
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
568
-
569
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
570
-
571
- ### renameDevice
572
-
573
- [src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L552-L554 "Source code on GitHub")
574
-
575
- Rename a device
576
-
577
- **Parameters**
578
-
579
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
580
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
581
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Desired Name
582
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Rename device in this product ID or slug
583
- - `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
584
- - `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.
585
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
586
-
587
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
588
-
589
- ### signalDevice
590
-
591
- [src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L567-L569 "Source code on GitHub")
592
-
593
- Instruct the device to turn on/off the LED in a rainbow pattern
594
-
595
- **Parameters**
596
-
597
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
598
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
599
- - `options.signal` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Signal on or off
600
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
601
- - `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
602
- - `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.
603
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
604
-
605
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
606
-
607
- ### setDeviceNotes
608
-
609
- [src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L582-L584 "Source code on GitHub")
610
-
611
- Store some notes about device
612
-
613
- **Parameters**
614
-
615
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
616
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
617
- - `options.notes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Your notes about this device
618
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
619
- - `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
620
- - `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.
621
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
622
-
623
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
624
-
625
- ### markAsDevelopmentDevice
626
-
627
- [src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L597-L599 "Source code on GitHub")
628
-
629
- Mark device as being used in development of a product so it opts out of automatic firmware updates
630
-
631
- **Parameters**
632
-
633
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
634
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
635
- - `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`)
636
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
637
- - `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
638
- - `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.
639
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
640
-
641
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
642
-
643
- ### lockDeviceProductFirmware
644
-
645
- [src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L613-L615 "Source code on GitHub")
646
-
647
- Mark device as being used in development of a product, so it opts out of automatic firmware updates
648
-
649
- **Parameters**
650
-
651
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
652
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
653
- - `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.
654
- - `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Immediately flash firmware indicated by desiredFirmwareVersion
655
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
656
- - `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
657
- - `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.
658
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
659
-
660
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
661
-
662
- ### unlockDeviceProductFirmware
663
-
664
- [src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L627-L629 "Source code on GitHub")
665
-
666
- Mark device as receiving automatic firmware updates
667
-
668
- **Parameters**
669
-
670
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
671
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
672
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
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
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.
675
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
676
-
677
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
678
-
679
- ### updateDevice
680
-
681
- [src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L648-L660 "Source code on GitHub")
682
-
683
- Update multiple device attributes at the same time
684
-
685
- **Parameters**
686
-
687
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
688
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
689
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Desired Name
690
- - `options.signal` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Signal device on or off
691
- - `options.notes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Your notes about this device
692
- - `options.development` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Set to true to mark as development, false to return to product fleet
693
- - `options.desiredFirmwareVersion` **([Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | null)?** (Product only) Lock the product device to run this firmware version.
694
- Pass `null` to unlock firmware and go back to released firmware.
695
- - `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Immediately flash firmware indicated by desiredFirmwareVersion
696
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
697
- - `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
698
- - `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.
699
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
700
-
701
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
702
-
703
- ### unprotectDevice
704
-
705
- [src/Particle.js:680-696](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L680-L696 "Source code on GitHub")
706
-
707
- Disable device protection.
708
-
709
- **Parameters**
710
-
711
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call.
712
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or name.
713
- - `options.org` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Organziation ID or slug.
714
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Product ID or slug.
715
- - `options.action` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Request action: `prepare` or `confirm`.
716
- - `options.serverNonce` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded server nonce. Mandatory if `action` is `confirm`,
717
- - `options.deviceNonce` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded device nonce. Mandatory if `action` is `confirm`,
718
- - `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`,
719
- - `options.devicePublicKeyFingerprint` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded fingerprint of the device public key.
720
- Mandatory if `action` is `confirm`,
721
- - `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.
722
- - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/value pairs to send as headers.
723
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
724
-
725
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
726
-
727
- ### provisionDevice
728
-
729
- [src/Particle.js:707-715](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L707-L715 "Source code on GitHub")
730
-
731
- Provision a new device for products that allow self-provisioning
732
-
733
- **Parameters**
734
-
735
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
736
- - `options.productId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID where to create this device
737
- - `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
738
- - `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.
739
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
740
-
741
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
742
-
743
- ### getClaimCode
744
-
745
- [src/Particle.js:729-732](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L729-L732 "Source code on GitHub")
746
-
747
- Generate a claim code to use in the device claiming process.
748
- To generate a claim code for a product, the access token MUST belong to a
749
- customer of the product.
750
-
751
- **Parameters**
752
-
753
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
754
- - `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
755
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
756
- - `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
757
- - `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.
758
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
759
-
760
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
761
-
762
- ### getVariable
763
-
764
- [src/Particle.js:754-760](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L754-L760 "Source code on GitHub")
765
-
766
- Get the value of a device variable
767
-
768
- **Parameters**
769
-
770
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
771
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
772
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Variable name
773
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
774
- - `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
775
- - `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.
776
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
777
-
778
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
779
-
780
- ### flashDevice
781
-
782
- [src/Particle.js:774-785](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L774-L785 "Source code on GitHub")
783
-
784
- Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
785
-
786
- **Parameters**
787
-
788
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
789
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
790
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Flash device in this product ID or slug
791
- - `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.
792
- - `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`)
793
- - `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
794
- - `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.
795
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
796
-
797
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
798
-
799
- ### flashTinker
800
-
801
- [src/Particle.js:796-811](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L796-L811 "Source code on GitHub")
802
-
803
- DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
804
-
805
- **Parameters**
806
-
807
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
808
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
809
- - `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
810
- - `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.
811
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
812
-
813
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
814
-
815
- ### compileCode
816
-
817
- [src/Particle.js:824-842](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L824-L842 "Source code on GitHub")
818
-
819
- Compile firmware using the Particle Cloud
820
-
821
- **Parameters**
822
-
823
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
824
- - `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.
825
- - `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.
826
- - `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`)
827
- - `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
828
- - `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.
829
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
830
-
831
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
832
-
833
- ### downloadFirmwareBinary
834
-
835
- [src/Particle.js:853-862](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L853-L862 "Source code on GitHub")
836
-
837
- Download a firmware binary
838
-
839
- **Parameters**
840
-
841
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
842
- - `options.binaryId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Binary ID received from a successful compile call
843
- - `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
844
- - `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.
845
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
846
-
847
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise
848
-
849
- ### sendPublicKey
850
-
851
- [src/Particle.js:875-889](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L875-L889 "Source code on GitHub")
852
-
853
- Send a new device public key to the Particle Cloud
854
-
855
- **Parameters**
856
-
857
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
858
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
859
- - `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
860
- - `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`)
861
- - `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
862
- - `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.
863
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
864
-
865
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
866
-
867
- ### callFunction
868
-
869
- [src/Particle.js:903-908](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L903-L908 "Source code on GitHub")
870
-
871
- Call a device function
872
-
873
- **Parameters**
874
-
875
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
876
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
877
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function name
878
- - `options.argument` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function argument
879
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
880
- - `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
881
- - `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.
882
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
883
-
884
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
885
-
886
- ### getEventStream
887
-
888
- [src/Particle.js:921-946](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L921-L946 "Source code on GitHub")
889
-
890
- Get a stream of events
891
-
892
- **Parameters**
893
-
894
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
895
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device ID or Name, or `mine` to indicate only your devices.
896
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event Name
897
- - `options.org` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Organization Slug
898
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Events for this product ID or slug
899
- - `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
900
-
901
- 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
902
- emit 'event' events.
903
-
904
- ### publishEvent
905
-
906
- [src/Particle.js:960-964](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L960-L964 "Source code on GitHub")
907
-
908
- Publish a event to the Particle Cloud
909
-
910
- **Parameters**
911
-
912
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
913
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Event name
914
- - `options.data` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Event data
915
- - `options.isPrivate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should the event be publicly available?
916
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event for this product ID or slug
917
- - `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
918
- - `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.
919
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
920
-
921
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
922
-
923
- ### Hook
924
-
925
- [src/Particle.js:995-1017](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L995-L1017 "Source code on GitHub")
926
-
927
- Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
928
-
929
- **Parameters**
930
-
931
- - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
932
- - `$0.event`
933
- - `$0.url`
934
- - `$0.device`
935
- - `$0.rejectUnauthorized`
936
- - `$0.noDefaults`
937
- - `$0.hook`
938
- - `$0.product`
939
- - `$0.auth`
940
- - `$0.headers`
941
- - `$0.context`
942
-
943
- **Properties**
944
-
945
- - `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)
946
- - `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
947
- - `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' }`
948
- - `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' }`
949
- - `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`
950
- - `form` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Form data to send with the Webhook request - sets `Content-Type` to `application/x-www-form-urlencoded`
951
- - `body` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Custom body to send with the Webhook request
952
- - `responseTemplate` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Template to use to customize the Webhook response body
953
- - `responseEvent` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The Webhook response event name that your devices can subscribe to
954
- - `errorResponseEvent` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The Webhook error response event name that your devices can subscribe to
955
-
956
- ### createWebhook
957
-
958
- [src/Particle.js:995-1017](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L995-L1017 "Source code on GitHub")
959
-
960
- Create a webhook
961
-
962
- **Parameters**
963
-
964
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
965
- - `options.event` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the Particle event that should trigger the Webhook
966
- - `options.url` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The web address that will be targeted when the Webhook is triggered
967
- - `options.device` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Trigger Webhook only for this device ID or Name
968
- - `options.rejectUnauthorized` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Set to `false` to skip SSL certificate validation of the target URL
969
- - `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
970
- - `options.hook` **Hook?** Webhook configuration settings
971
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
972
- - `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
973
- - `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.
974
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
975
-
976
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
977
-
978
- ### deleteWebhook
979
-
980
- [src/Particle.js:1029-1032](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1029-L1032 "Source code on GitHub")
981
-
982
- Delete a webhook
983
-
984
- **Parameters**
985
-
986
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
987
- - `options.hookId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Webhook ID
988
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
989
- - `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
990
- - `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.
991
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
992
-
993
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
994
-
995
- ### listWebhooks
996
-
997
- [src/Particle.js:1043-1046](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1043-L1046 "Source code on GitHub")
998
-
999
- List all webhooks owned by the account or product
1000
-
1001
- **Parameters**
1002
-
1003
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1004
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhooks for this product ID or slug
1005
- - `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
1006
- - `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.
1007
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1008
-
1009
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1010
-
1011
- ### createIntegration
1012
-
1013
- [src/Particle.js:1063-1067](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1063-L1067 "Source code on GitHub")
1014
-
1015
- Create an integration to send events to an external service
1016
-
1017
- See the API docs for details <https://docs.particle.io/reference/api/#integrations-webhooks->
1018
-
1019
- **Parameters**
1020
-
1021
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1022
- - `options.event` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Event that triggers the integration
1023
- - `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Settings specific to that integration type
1024
- - `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
1025
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
1026
- - `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
1027
- - `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.
1028
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1029
-
1030
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1031
-
1032
- ### editIntegration
1033
-
1034
- [src/Particle.js:1085-1089](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1085-L1089 "Source code on GitHub")
1035
-
1036
- Edit an integration to send events to an external service
1037
-
1038
- See the API docs for details <https://docs.particle.io/reference/api/#integrations-webhooks->
1039
-
1040
- **Parameters**
1041
-
1042
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1043
- - `options.integrationId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The integration to edit
1044
- - `options.event` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Change the event that triggers the integration
1045
- - `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Change the settings specific to that integration type
1046
- - `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
1047
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
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
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.
1050
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1051
-
1052
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1053
-
1054
- ### deleteIntegration
1055
-
1056
- [src/Particle.js:1102-1105](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1102-L1105 "Source code on GitHub")
1057
-
1058
- Delete an integration to send events to an external service
1059
-
1060
- **Parameters**
1061
-
1062
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1063
- - `options.integrationId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The integration to remove
1064
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
1065
- - `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
1066
- - `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.
1067
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1068
-
1069
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1070
-
1071
- ### listIntegrations
1072
-
1073
- [src/Particle.js:1116-1119](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1116-L1119 "Source code on GitHub")
1074
-
1075
- List all integrations owned by the account or product
1076
-
1077
- **Parameters**
1078
-
1079
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1080
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integrations for this product ID or slug
1081
- - `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
1082
- - `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.
1083
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1084
-
1085
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1086
-
1087
- ### getUserInfo
1088
-
1089
- [src/Particle.js:1129-1131](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1129-L1131 "Source code on GitHub")
1090
-
1091
- Get details about the current user
1092
-
1093
- **Parameters**
1094
-
1095
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1096
- - `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
1097
- - `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.
1098
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1099
-
1100
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1101
-
1102
- ### setUserInfo
1103
-
1104
- [src/Particle.js:1142-1145](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1142-L1145 "Source code on GitHub")
1105
-
1106
- Set details on the current user
1107
-
1108
- **Parameters**
1109
-
1110
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1111
- - `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)
1112
- - `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
1113
- - `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.
1114
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1115
-
1116
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1117
-
1118
- ### changeUsername
1119
-
1120
- [src/Particle.js:1158-1166](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1158-L1166 "Source code on GitHub")
1121
-
1122
- Change username (i.e, email)
1123
-
1124
- **Parameters**
1125
-
1126
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1127
- - `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
1128
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New email
1129
- - `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
1130
- - `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
1131
- - `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.
1132
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1133
-
1134
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1135
-
1136
- ### changeUserPassword
1137
-
1138
- [src/Particle.js:1179-1187](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1179-L1187 "Source code on GitHub")
1139
-
1140
- Change user's password
1141
-
1142
- **Parameters**
1143
-
1144
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1145
- - `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
1146
- - `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New password
1147
- - `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
1148
- - `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
1149
- - `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.
1150
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1151
-
1152
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1153
-
1154
- ### listSIMs
1155
-
1156
- [src/Particle.js:1203-1207](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1203-L1207 "Source code on GitHub")
1157
-
1158
- List SIM cards owned by a user or product
1159
-
1160
- **Parameters**
1161
-
1162
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1163
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) Filter to SIM cards matching this ICCID
1164
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) Filter to SIM cards matching this device ID
1165
- - `options.deviceName` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** (Product only) Filter to SIM cards matching this device name
1166
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
1167
- - `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
1168
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1169
- - `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
1170
- - `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.
1171
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1172
-
1173
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1174
-
1175
- ### getSIMDataUsage
1176
-
1177
- [src/Particle.js:1219-1225](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1219-L1225 "Source code on GitHub")
1178
-
1179
- Get data usage for one SIM card for the current billing period
1180
-
1181
- **Parameters**
1182
-
1183
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1184
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1185
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM card for this product ID or slug
1186
- - `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
1187
- - `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.
1188
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1189
-
1190
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1191
-
1192
- ### getFleetDataUsage
1193
-
1194
- [src/Particle.js:1236-1243](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1236-L1243 "Source code on GitHub")
1195
-
1196
- Get data usage for all SIM cards in a product the current billing period
1197
-
1198
- **Parameters**
1199
-
1200
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1201
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** SIM cards for this product ID or slug
1202
- - `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
1203
- - `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.
1204
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1205
-
1206
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1207
-
1208
- ### checkSIM
1209
-
1210
- [src/Particle.js:1254-1256](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1254-L1256 "Source code on GitHub")
1211
-
1212
- Check SIM status
1213
-
1214
- **Parameters**
1215
-
1216
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1217
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1218
- - `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
1219
- - `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.
1220
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1221
-
1222
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1223
-
1224
- ### activateSIM
1225
-
1226
- [src/Particle.js:1271-1281](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1271-L1281 "Source code on GitHub")
1227
-
1228
- Activate and add SIM cards to an account or product
1229
-
1230
- **Parameters**
1231
-
1232
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1233
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1234
- - `options.iccids` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** (Product only) ICCID of multiple SIM cards to import
1235
- - `options.country` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ISO country code for the SIM cards
1236
- - `options.promoCode` **any?**
1237
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1238
- - `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
1239
- - `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.
1240
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1241
-
1242
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1243
-
1244
- ### deactivateSIM
1245
-
1246
- [src/Particle.js:1293-1297](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1293-L1297 "Source code on GitHub")
1247
-
1248
- Deactivate a SIM card so it doesn't incur data usage in future months.
1249
-
1250
- **Parameters**
1251
-
1252
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1253
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1254
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1255
- - `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
1256
- - `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.
1257
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1258
-
1259
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1260
-
1261
- ### reactivateSIM
1262
-
1263
- [src/Particle.js:1310-1314](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1310-L1314 "Source code on GitHub")
1264
-
1265
- Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
1266
-
1267
- **Parameters**
1268
-
1269
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1270
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1271
- - `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
1272
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1273
- - `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
1274
- - `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.
1275
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1276
-
1277
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1278
-
1279
- ### updateSIM
1280
-
1281
- [src/Particle.js:1327-1331](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1327-L1331 "Source code on GitHub")
1282
-
1283
- Update SIM card data limit
1284
-
1285
- **Parameters**
1286
-
1287
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1288
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1289
- - `options.mbLimit` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Data limit in megabyte for the SIM card
1290
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1291
- - `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
1292
- - `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.
1293
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1294
-
1295
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1296
-
1297
- ### removeSIM
1298
-
1299
- [src/Particle.js:1343-1346](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1343-L1346 "Source code on GitHub")
1300
-
1301
- Remove a SIM card from an account so it can be activated by a different account
1302
-
1303
- **Parameters**
1304
-
1305
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1306
- - `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
1307
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
1308
- - `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
1309
- - `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.
1310
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1311
-
1312
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1313
-
1314
- ### listBuildTargets
1315
-
1316
- [src/Particle.js:1357-1360](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1357-L1360 "Source code on GitHub")
1317
-
1318
- List valid build targets to be used for compiling
1319
-
1320
- **Parameters**
1321
-
1322
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1323
- - `options.onlyFeatured` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Only list featured build targets (optional, default `false`)
1324
- - `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
- - `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
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1327
-
1328
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1329
-
1330
- ### listLibraries
1331
-
1332
- [src/Particle.js:1386-1403](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1386-L1403 "Source code on GitHub")
1333
-
1334
- List firmware libraries
1335
-
1336
- **Parameters**
1337
-
1338
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1339
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Page index (default, first page)
1340
- - `options.limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Number of items per page
1341
- - `options.filter` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Search term for the libraries
1342
- - `options.sort` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ordering key for the library list
1343
- - `options.architectures` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** List of architectures to filter
1344
- - `options.category` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Category to filter
1345
- - `options.scope` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The library scope to list. Default is 'all'. Other values are
1346
- \- 'all' - list public libraries and my private libraries
1347
- \- 'public' - list only public libraries
1348
- \- 'private' - list only my private libraries
1349
- \- 'mine' - list my libraries (public and private)
1350
- \- 'official' - list only official libraries
1351
- \- 'verified' - list only verified libraries
1352
- \- 'featured' - list only featured libraries
1353
- - `options.excludeScopes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** list of scopes to exclude
1354
- - `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
1355
- - `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.
1356
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1357
-
1358
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1359
-
1360
- ### getLibrary
1361
-
1362
- [src/Particle.js:1419-1427](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1419-L1427 "Source code on GitHub")
1363
-
1364
- Get firmware library details
1365
-
1366
- **Parameters**
1367
-
1368
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1369
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
1370
- - `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the library to fetch (default: latest)
1371
- - `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
1372
- - `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.
1373
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1374
-
1375
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1376
-
1377
- ### getLibraryVersions
1378
-
1379
- [src/Particle.js:1440-1448](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1440-L1448 "Source code on GitHub")
1380
-
1381
- Firmware library details for each version
1382
-
1383
- **Parameters**
1384
-
1385
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1386
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
1387
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Page index (default, first page)
1388
- - `options.limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Number of items per page
1389
- - `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
1390
- - `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.
1391
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1392
-
1393
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1394
-
1395
- ### contributeLibrary
1396
-
1397
- [src/Particle.js:1460-1473](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1460-L1473 "Source code on GitHub")
1398
-
1399
- Contribute a new library version from a compressed archive
1400
-
1401
- **Parameters**
1402
-
1403
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1404
- - `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
1405
- Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
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
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.
1408
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1409
-
1410
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1411
-
1412
- ### publishLibrary
1413
-
1414
- [src/Particle.js:1484-1493](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1484-L1493 "Source code on GitHub")
1415
-
1416
- Publish the latest version of a library to the public
1417
-
1418
- **Parameters**
1419
-
1420
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1421
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to publish
1422
- - `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
1423
- - `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.
1424
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1425
-
1426
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1427
-
1428
- ### deleteLibrary
1429
-
1430
- [src/Particle.js:1505-1513](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1505-L1513 "Source code on GitHub")
1431
-
1432
- Delete one version of a library or an entire private library
1433
-
1434
- **Parameters**
1435
-
1436
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1437
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to remove
1438
- - `options.force` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Key to force deleting a public library
1439
- - `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
1440
- - `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.
1441
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1442
-
1443
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1444
-
1445
- ### downloadFile
1446
-
1447
- [src/Particle.js:1523-1525](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1523-L1525 "Source code on GitHub")
1448
-
1449
- Download an external file that may not be on the API
1450
-
1451
- **Parameters**
1452
-
1453
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1454
- - `options.uri` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** URL of the file.
1455
- - `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.
1456
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1457
-
1458
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Resolves to a buffer with the file data
1459
-
1460
- ### listOAuthClients
1461
-
1462
- [src/Particle.js:1536-1539](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1536-L1539 "Source code on GitHub")
1463
-
1464
- List OAuth client created by the account
1465
-
1466
- **Parameters**
1467
-
1468
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1469
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List clients for this product ID or slug
1470
- - `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
1471
- - `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.
1472
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1473
-
1474
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1475
-
1476
- ### createOAuthClient
1477
-
1478
- [src/Particle.js:1554-1558](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1554-L1558 "Source code on GitHub")
1479
-
1480
- Create an OAuth client
1481
-
1482
- **Parameters**
1483
-
1484
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1485
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the OAuth client
1486
- - `options.type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** web, installed or web
1487
- - `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.
1488
- - `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.
1489
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Create client for this product ID or slug
1490
- - `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
1491
- - `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.
1492
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1493
-
1494
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1495
-
1496
- ### updateOAuthClient
1497
-
1498
- [src/Particle.js:1572-1576](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1572-L1576 "Source code on GitHub")
1499
-
1500
- Update an OAuth client
1501
-
1502
- **Parameters**
1503
-
1504
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1505
- - `options.clientId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The OAuth client to update
1506
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New Name of the OAuth client
1507
- - `options.scope` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** New scope of the OAuth client
1508
- - `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
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
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.
1511
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1512
-
1513
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1514
-
1515
- ### deleteOAuthClient
1516
-
1517
- [src/Particle.js:1588-1591](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1588-L1591 "Source code on GitHub")
1518
-
1519
- Delete an OAuth client
1520
-
1521
- **Parameters**
1522
-
1523
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1524
- - `options.clientId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The OAuth client to update
1525
- - `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
1526
- - `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
1527
- - `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.
1528
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1529
-
1530
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1531
-
1532
- ### listProducts
1533
-
1534
- [src/Particle.js:1601-1603](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1601-L1603 "Source code on GitHub")
1535
-
1536
- List products the account has access to
1537
-
1538
- **Parameters**
1539
-
1540
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1541
- - `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
1542
- - `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.
1543
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1544
-
1545
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1546
-
1547
- ### getProduct
1548
-
1549
- [src/Particle.js:1614-1616](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1614-L1616 "Source code on GitHub")
1550
-
1551
- Get detailed information about a product
1552
-
1553
- **Parameters**
1554
-
1555
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1556
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID or slug
1557
- - `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
1558
- - `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.
1559
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1560
-
1561
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1562
-
1563
- ### listProductFirmware
1564
-
1565
- [src/Particle.js:1627-1629](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1627-L1629 "Source code on GitHub")
1566
-
1567
- List product firmware versions
1568
-
1569
- **Parameters**
1570
-
1571
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1572
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1573
- - `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
1574
- - `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.
1575
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1576
-
1577
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1578
-
1579
- ### uploadProductFirmware
1580
-
1581
- [src/Particle.js:1645-1661](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1645-L1661 "Source code on GitHub")
1582
-
1583
- List product firmware versions
1584
-
1585
- **Parameters**
1586
-
1587
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1588
- - `options.file` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Path or Buffer of the new firmware file
1589
- Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
1590
- - `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
1591
- - `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Short identifier for the new firmware
1592
- - `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Longer description for the new firmware
1593
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1594
- - `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
1595
- - `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.
1596
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1597
-
1598
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1599
-
1600
- ### getProductFirmware
1601
-
1602
- [src/Particle.js:1673-1680](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1673-L1680 "Source code on GitHub")
1603
-
1604
- Get information about a product firmware version
1605
-
1606
- **Parameters**
1607
-
1608
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1609
- - `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of firmware
1610
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1611
- - `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
1612
- - `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.
1613
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1614
-
1615
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1616
-
1617
- ### updateProductFirmware
1618
-
1619
- [src/Particle.js:1694-1697](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1694-L1697 "Source code on GitHub")
1620
-
1621
- Update information for a product firmware version
1622
-
1623
- **Parameters**
1624
-
1625
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1626
- - `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
1627
- - `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New title
1628
- - `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New description
1629
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1630
- - `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
1631
- - `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.
1632
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1633
-
1634
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1635
-
1636
- ### downloadProductFirmware
1637
-
1638
- [src/Particle.js:1709-1718](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1709-L1718 "Source code on GitHub")
1639
-
1640
- Download a product firmware binary
1641
-
1642
- **Parameters**
1643
-
1644
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1645
- - `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
1646
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1647
- - `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
1648
- - `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.
1649
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1650
-
1651
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
1652
-
1653
- ### releaseProductFirmware
1654
-
1655
- [src/Particle.js:1730-1733](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1730-L1733 "Source code on GitHub")
1656
-
1657
- Release a product firmware version as the default version
1658
-
1659
- **Parameters**
1660
-
1661
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1662
- - `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
1663
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
1664
- - `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
1665
- - `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.
1666
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1667
-
1668
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1669
-
1670
- ### listTeamMembers
1671
-
1672
- [src/Particle.js:1744-1751](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1744-L1751 "Source code on GitHub")
1673
-
1674
- List product team members
1675
-
1676
- **Parameters**
1677
-
1678
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1679
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
1680
- - `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
1681
- - `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.
1682
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1683
-
1684
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1685
-
1686
- ### inviteTeamMember
1687
-
1688
- [src/Particle.js:1763-1771](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1763-L1771 "Source code on GitHub")
1689
-
1690
- Invite Particle user to a product team
1691
-
1692
- **Parameters**
1693
-
1694
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1695
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
1696
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
1697
- - `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
1698
- - `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.
1699
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1700
-
1701
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1702
-
1703
- ### removeTeamMember
1704
-
1705
- [src/Particle.js:1783-1790](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1783-L1790 "Source code on GitHub")
1706
-
1707
- Remove Particle user to a product team
1708
-
1709
- **Parameters**
1710
-
1711
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1712
- - `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
1713
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
1714
- - `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
1715
- - `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.
1716
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1717
-
1718
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1719
-
1720
- ### lookupSerialNumber
1721
-
1722
- [src/Particle.js:1801-1808](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1801-L1808 "Source code on GitHub")
1723
-
1724
- Fetch details about a serial number
1725
-
1726
- **Parameters**
1727
-
1728
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1729
- - `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
1730
- - `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
1731
- - `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.
1732
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1733
-
1734
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1735
-
1736
- ### createMeshNetwork
1737
-
1738
- [src/Particle.js:1821-1829](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1821-L1829 "Source code on GitHub")
1739
-
1740
- Create a mesh network
1741
-
1742
- **Parameters**
1743
-
1744
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1745
- - `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network name
1746
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Gateway device ID
1747
- - `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)
1748
- - `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
1749
- - `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.
1750
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1751
-
1752
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1753
-
1754
- ### removeMeshNetwork
1755
-
1756
- [src/Particle.js:1840-1842](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1840-L1842 "Source code on GitHub")
1757
-
1758
- Remove a mesh network.
1759
-
1760
- **Parameters**
1761
-
1762
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1763
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
1764
- - `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
1765
- - `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.
1766
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1767
-
1768
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1769
-
1770
- ### listMeshNetworks
1771
-
1772
- [src/Particle.js:1854-1857](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1854-L1857 "Source code on GitHub")
1773
-
1774
- List all mesh networks
1775
-
1776
- **Parameters**
1777
-
1778
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1779
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
1780
- - `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
1781
- - `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
1782
- - `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.
1783
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1784
-
1785
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1786
-
1787
- ### getMeshNetwork
1788
-
1789
- [src/Particle.js:1868-1870](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1868-L1870 "Source code on GitHub")
1790
-
1791
- Get information about a mesh network.
1792
-
1793
- **Parameters**
1794
-
1795
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1796
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
1797
- - `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
1798
- - `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.
1799
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1800
-
1801
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1802
-
1803
- ### updateMeshNetwork
1804
-
1805
- [src/Particle.js:1883-1891](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1883-L1891 "Source code on GitHub")
1806
-
1807
- Modify a mesh network.
1808
-
1809
- **Parameters**
1810
-
1811
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1812
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
1813
- - `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'
1814
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
1815
- - `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
1816
- - `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.
1817
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1818
-
1819
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1820
-
1821
- ### addMeshNetworkDevice
1822
-
1823
- [src/Particle.js:1903-1912](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1903-L1912 "Source code on GitHub")
1824
-
1825
- Add a device to a mesh network.
1826
-
1827
- **Parameters**
1828
-
1829
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1830
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
1831
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
1832
- - `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
1833
- - `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.
1834
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1835
-
1836
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1837
-
1838
- ### removeMeshNetworkDevice
1839
-
1840
- [src/Particle.js:1924-1940](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1924-L1940 "Source code on GitHub")
1841
-
1842
- Remove a device from a mesh network.
1843
-
1844
- **Parameters**
1845
-
1846
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1847
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Network ID or name
1848
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
1849
- - `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
1850
- - `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.
1851
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1852
-
1853
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1854
-
1855
- ### listMeshNetworkDevices
1856
-
1857
- [src/Particle.js:1954-1963](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1954-L1963 "Source code on GitHub")
1858
-
1859
- List all devices of a mesh network.
1860
-
1861
- **Parameters**
1862
-
1863
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1864
- - `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
1865
- - `options.role` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Device role: 'gateway' or 'node'
1866
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
1867
- - `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
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
1869
- - `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.
1870
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1871
-
1872
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A promise
1873
-
1874
- ### getProductConfiguration
1875
-
1876
- [src/Particle.js:1974-1981](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1974-L1981 "Source code on GitHub")
1877
-
1878
- Get product configuration
1879
-
1880
- **Parameters**
1881
-
1882
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1883
- - `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
1884
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1885
- - `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.
1886
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1887
-
1888
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1889
-
1890
- ### getProductConfigurationSchema
1891
-
1892
- [src/Particle.js:1992-2000](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L1992-L2000 "Source code on GitHub")
1893
-
1894
- Get product configuration schema
1895
-
1896
- **Parameters**
1897
-
1898
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1899
- - `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
1900
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1901
- - `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 `{}`)
1902
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1903
-
1904
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1905
-
1906
- ### getProductDeviceConfiguration
1907
-
1908
- [src/Particle.js:2012-2019](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2012-L2019 "Source code on GitHub")
1909
-
1910
- Get product device's configuration
1911
-
1912
- **Parameters**
1913
-
1914
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1915
- - `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
1916
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1917
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
1918
- - `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.
1919
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1920
-
1921
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1922
-
1923
- ### getProductDeviceConfigurationSchema
1924
-
1925
- [src/Particle.js:2031-2039](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2031-L2039 "Source code on GitHub")
1926
-
1927
- Get product device's configuration schema
1928
-
1929
- **Parameters**
1930
-
1931
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1932
- - `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
1933
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1934
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
1935
- - `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.
1936
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1937
-
1938
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1939
-
1940
- ### setProductConfiguration
1941
-
1942
- [src/Particle.js:2051-2059](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2051-L2059 "Source code on GitHub")
1943
-
1944
- Set product configuration
1945
-
1946
- **Parameters**
1947
-
1948
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1949
- - `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
1950
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1951
- - `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
1952
- - `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.
1953
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1954
-
1955
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1956
-
1957
- ### setProductDeviceConfiguration
1958
-
1959
- [src/Particle.js:2072-2080](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2072-L2080 "Source code on GitHub")
1960
-
1961
- Set product configuration for a specific device within the product
1962
-
1963
- **Parameters**
1964
-
1965
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
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
1967
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
1968
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
1969
- - `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
1970
- - `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.
1971
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1972
-
1973
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1974
-
1975
- ### getProductLocations
1976
-
1977
- [src/Particle.js:2099-2116](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2099-L2116 "Source code on GitHub")
1978
-
1979
- Query location for devices within a product
1980
-
1981
- **Parameters**
1982
-
1983
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
1984
- - `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
1985
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
1986
- - `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
1987
- - `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
- - `options.rectTr` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
1989
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID prefix to include in the query
1990
- - `options.deviceName` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device name prefix to include in the query
1991
- - `options.groups` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Array of group names to include in the query
1992
- - `options.page` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Page of results to display. Defaults to 1
1993
- - `options.perPage` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Number of results per page. Defaults to 20. Maximum of 100
1994
- - `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.
1995
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
1996
-
1997
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
1998
-
1999
- ### getProductDeviceLocations
2000
-
2001
- [src/Particle.js:2133-2145](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2133-L2145 "Source code on GitHub")
2002
-
2003
- Query location for one device within a product
2004
-
2005
- **Parameters**
2006
-
2007
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
2008
- - `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
2009
- - `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
2010
- - `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
2011
- - `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
2012
- - `options.rectTr` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
2013
- - `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to query
2014
- - `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.
2015
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2016
-
2017
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
2018
-
2019
- ### executeLogic
2020
-
2021
- [src/Particle.js:2161-2169](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2161-L2169 "Source code on GitHub")
2022
-
2023
- Executes the provided logic function once and returns the result. No logs, runs, etc are saved
2024
-
2025
- NOTE: Any external interactions such as Particle.publish will actually occur when the logic is executed.
2026
-
2027
- **Parameters**
2028
-
2029
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
2030
- - `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
2031
- - `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.
2032
- - `options.logic` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic "function" which will be executed once
2033
- - `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
2034
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2035
-
2036
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the created logic function data.
2037
-
2038
- ### createLogicFunction
2039
-
2040
- [src/Particle.js:2189-2197](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2189-L2197 "Source code on GitHub")
2041
-
2042
- Creates a new logic function in the specified organization or sandbox using the provided function data.
2043
-
2044
- When you create a logic function with Event logic triggers, events will immediately
2045
- start being handled by the function code.
2046
-
2047
- When you create a Scheduled logic trigger, it will immediately be scheduled at the next time
2048
- according to the cron and start_at properties.
2049
-
2050
- **Parameters**
2051
-
2052
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
2053
- - `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
2054
- - `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.
2055
- - `options.logicFunction` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic function object containing the function details.
2056
- - `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.
2057
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2058
-
2059
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the created logic function data.
2060
-
2061
- ### getLogicFunction
2062
-
2063
- [src/Particle.js:2211-2218](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2211-L2218 "Source code on GitHub")
2064
-
2065
- Get a logic function in the specified organization or sandbox by logic function ID.
2066
-
2067
- **Parameters**
2068
-
2069
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
2070
- - `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
2071
- - `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.
2072
- - `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
2073
- - `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.
2074
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2075
-
2076
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the specified logic function data.
2077
-
2078
- ### updateLogicFunction
2079
-
2080
- [src/Particle.js:2235-2243](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2235-L2243 "Source code on GitHub")
2081
-
2082
- Updates an existing logic function in the specified organization or sandbox using the provided function data.
2083
-
2084
- If you include an id on a logic trigger, it will update the logic trigger in place.
2085
-
2086
- **Parameters**
2087
-
2088
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
2089
- - `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
2090
- - `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.
2091
- - `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
2092
- - `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.
2093
- - `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.
2094
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2095
-
2096
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the updated logic function data.
2097
-
2098
- ### deleteLogicFunction
2099
-
2100
- [src/Particle.js:2257-2264](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2257-L2264 "Source code on GitHub")
2101
-
2102
- Deletes a logic function in the specified organization or sandbox by logic function ID.
2103
-
2104
- **Parameters**
2105
-
2106
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
2107
- - `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
2108
- - `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.
2109
- - `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
2110
- - `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.
2111
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2112
-
2113
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an object containing the deleted logic function ID.
2114
-
2115
- ### listLogicFunctions
2116
-
2117
- [src/Particle.js:2278-2288](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2278-L2288 "Source code on GitHub")
2118
-
2119
- Lists all logic functions in the specified organization or sandbox.
2120
-
2121
- **Parameters**
2122
-
2123
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
2124
- - `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
2125
- - `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.
2126
- - `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
2127
- - `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.
2128
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2129
-
2130
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of logic functions data.
2131
-
2132
- ### listLogicRuns
2133
-
2134
- [src/Particle.js:2302-2309](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2302-L2309 "Source code on GitHub")
2135
-
2136
- Lists all logic runs for the specified logic function in the specified organization or sandbox.
2137
-
2138
- **Parameters**
2139
-
2140
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2141
- - `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
2142
- - `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.
2143
- - `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.
2144
- - `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.
2145
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2146
-
2147
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of logic run data.
2148
-
2149
- ### getLogicRun
2150
-
2151
- [src/Particle.js:2324-2331](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2324-L2331 "Source code on GitHub")
2152
-
2153
- Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
2154
-
2155
- **Parameters**
2156
-
2157
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2158
- - `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
2159
- - `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.
2160
- - `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.
2161
- - `options.logicRunId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic run to retrieve.
2162
- - `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.
2163
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2164
-
2165
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of logic run data for the specified logic run ID.
2166
-
2167
- ### getLogicRunLogs
2168
-
2169
- [src/Particle.js:2346-2353](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2346-L2353 "Source code on GitHub")
2170
-
2171
- Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
2172
-
2173
- **Parameters**
2174
-
2175
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
2176
- - `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
2177
- - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
2178
- - `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.
2179
- - `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.
2180
- - `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.
2181
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2182
-
2183
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the logs for the specified logic run ID.
2184
-
2185
- ### createLedger
2186
-
2187
- [src/Particle.js:2367-2375](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2367-L2375 "Source code on GitHub")
2188
-
2189
- Creates a new ledger definition in the specified organization or sandbox.
2190
-
2191
- **Parameters**
2192
-
2193
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
2194
- - `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
2195
- - `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.
2196
- - `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
2197
- - `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.
2198
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2199
-
2200
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the created ledger definition data.
2201
-
2202
- ### getLedger
2203
-
2204
- [src/Particle.js:2389-2396](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2389-L2396 "Source code on GitHub")
2205
-
2206
- Get a ledger definition in the specified organization or sandbox by ledger name.
2207
-
2208
- **Parameters**
2209
-
2210
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
2211
- - `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
2212
- - `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.
2213
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
2214
- - `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.
2215
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2216
-
2217
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the specified ledger definition data.
2218
-
2219
- ### updateLedger
2220
-
2221
- [src/Particle.js:2411-2419](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2411-L2419 "Source code on GitHub")
2222
-
2223
- Updates an existing ledger definition in the specified organization or sandbox.
2224
-
2225
- **Parameters**
2226
-
2227
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
2228
- - `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
2229
- - `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.
2230
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
2231
- - `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
2232
- - `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.
2233
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2234
-
2235
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the updated ledger definition data.
2236
-
2237
- ### archiveLedger
2238
-
2239
- [src/Particle.js:2433-2440](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2433-L2440 "Source code on GitHub")
2240
-
2241
- Archives a ledger definition in the specified organization or sandbox by ledger name.
2242
-
2243
- **Parameters**
2244
-
2245
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
2246
- - `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
2247
- - `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.
2248
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
2249
- - `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.
2250
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2251
-
2252
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an object confirming the ledger definition was archived.
2253
-
2254
- ### Scope
2255
-
2256
- [src/Particle.js:2461-2474](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2461-L2474 "Source code on GitHub")
2257
-
2258
- Type: (`"Owner"` \| `"Product"` \| `"Device"`)
2259
-
2260
- **Parameters**
2261
-
2262
- - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2263
- - `$0.auth`
2264
- - `$0.org`
2265
- - `$0.scope`
2266
- - `$0.page`
2267
- - `$0.perPage`
2268
- - `$0.archived`
2269
- - `$0.headers`
2270
- - `$0.context`
2271
-
2272
- ### listLedgers
2273
-
2274
- [src/Particle.js:2461-2474](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2461-L2474 "Source code on GitHub")
2275
-
2276
- Lists all ledger definitions in the specified organization or sandbox.
2277
-
2278
- **Parameters**
2279
-
2280
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
2281
- - `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
2282
- - `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.
2283
- - `options.scope` **Scope?** Filter to show only ledgers of the specified scope
2284
- - `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
2285
- - `options.perPage` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Number of results per page. Default is 100
2286
- - `options.archived` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Filter to show only archived ledger or non-archived ledgers. If not provided, all ledgers are returned.
2287
- - `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.
2288
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2289
-
2290
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of ledger definition data.
2291
-
2292
- ### getLedgerInstance
2293
-
2294
- [src/Particle.js:2489-2496](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2489-L2496 "Source code on GitHub")
2295
-
2296
- Get ledger instance data.
2297
-
2298
- **Parameters**
2299
-
2300
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
2301
- - `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
2302
- - `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.
2303
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2304
- - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2305
- - `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.
2306
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2307
-
2308
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the specified ledger instance data.
2309
-
2310
- ### SetMode
2311
-
2312
- [src/Particle.js:2517-2528](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2517-L2528 "Source code on GitHub")
2313
-
2314
- Type: (`"Replace"` \| `"Merge"`)
2315
-
2316
- **Parameters**
2317
-
2318
- - `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2319
- - `$0.auth`
2320
- - `$0.org`
2321
- - `$0.ledgerName`
2322
- - `$0.scopeValue`
2323
- - `$0.instance`
2324
- - `$0.setMode`
2325
- - `$0.headers`
2326
- - `$0.context`
2327
-
2328
- ### setLedgerInstance
2329
-
2330
- [src/Particle.js:2517-2528](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2517-L2528 "Source code on GitHub")
2331
-
2332
- Set ledger instance data.
2333
-
2334
- **Parameters**
2335
-
2336
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
2337
- - `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
2338
- - `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.
2339
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2340
- - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2341
- - `options.instance` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The instance with the data
2342
- - `options.setMode` **SetMode?** How the data should be set with existing data. Default is "Replace"
2343
- - `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.
2344
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2345
-
2346
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the updated ledger instance data.
2347
-
2348
- ### deleteLedgerInstance
2349
-
2350
- [src/Particle.js:2543-2550](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2543-L2550 "Source code on GitHub")
2351
-
2352
- Delete a ledger instance in the specified organization or sandbox by ledger name.
2353
-
2354
- **Parameters**
2355
-
2356
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
2357
- - `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
2358
- - `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.
2359
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
2360
- - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2361
- - `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.
2362
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2363
-
2364
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an object confirming the ledger instance was deleted.
2365
-
2366
- ### listLedgerInstances
2367
-
2368
- [src/Particle.js:2566-2577](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2566-L2577 "Source code on GitHub")
2369
-
2370
- Lists ledger instances in the specified organization or sandbox.
2371
-
2372
- **Parameters**
2373
-
2374
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
2375
- - `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
2376
- - `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
2377
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
2378
- - `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
2379
- - `options.perPage` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Number of results per page. Default is 100
2380
- - `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.
2381
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
2382
-
2383
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of ledger instance data.
2384
-
2385
- ### listLedgerInstanceVersions
2386
-
2387
- [src/Particle.js:2594-2605](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2594-L2605 "Source code on GitHub")
2388
-
2389
- List ledger instance versions
2390
-
2391
- **Parameters**
2392
-
2393
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
2394
- - `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
2395
- - `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.
2396
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2397
- - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2398
- - `options.replacedBefore` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ISO date string to filter to instances replaced before this time
2399
- - `options.replacedAfter` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ISO date string to filter to instances replaced after this time
2400
- - `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.
2401
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2402
-
2403
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to an array of ledger instance data.
2404
-
2405
- ### getLedgerInstanceVersion
2406
-
2407
- [src/Particle.js:2621-2628](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2621-L2628 "Source code on GitHub")
2408
-
2409
- Get specific ledger instance version
2410
-
2411
- **Parameters**
2412
-
2413
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
2414
- - `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
2415
- - `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.
2416
- - `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
2417
- - `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
2418
- - `options.version` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the ledger instance
2419
- - `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.
2420
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2421
-
2422
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the specified ledger instance data.
2423
-
2424
- ### listDeviceOsVersions
2425
-
2426
- [src/Particle.js:2644-2659](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2644-L2659 "Source code on GitHub")
2427
-
2428
- List Device OS versions
2429
-
2430
- **Parameters**
2431
-
2432
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
2433
- - `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Platform ID to filter Device OS versions
2434
- - `options.internalVersion` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Internal version number to filter Device OS versions
2435
- - `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page number for pagination
2436
- - `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Number of items per page
2437
- - `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
2438
- - `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.
2439
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2440
-
2441
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the list of Device OS versions.
2442
-
2443
- ### getDeviceOsVersion
2444
-
2445
- [src/Particle.js:2673-2682](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2673-L2682 "Source code on GitHub")
2446
-
2447
- Get a specific Device OS version
2448
-
2449
- **Parameters**
2450
-
2451
- - `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
2452
- - `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the Device OS
2453
- - `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Optional platform ID to filter Device OS version
2454
- - `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
2455
- - `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.
2456
- - `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
2457
-
2458
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse>** A promise that resolves to the specified Device OS version data.
2459
-
2460
- ### setDefaultAuth
2461
-
2462
- [src/Particle.js:2689-2695](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2689-L2695 "Source code on GitHub")
2463
-
2464
- Set default auth token that will be used in each method if `auth` is not provided
2465
-
2466
- **Parameters**
2467
-
2468
- - `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The access token
2469
-
2470
-
2471
- - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** When not auth string is provided
2472
-
2473
- ### get
2474
-
2475
- [src/Particle.js:2745-2749](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2745-L2749 "Source code on GitHub")
2476
-
2477
- Make a GET request
2478
-
2479
- **Parameters**
2480
-
2481
- - `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2482
- - `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2483
- - `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2484
- - `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.
2485
- - `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
2486
- - `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2487
-
2488
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2489
-
2490
- ### head
2491
-
2492
- [src/Particle.js:2761-2765](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2761-L2765 "Source code on GitHub")
2493
-
2494
- Make a HEAD request
2495
-
2496
- **Parameters**
2497
-
2498
- - `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2499
- - `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2500
- - `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2501
- - `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.
2502
- - `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
2503
- - `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2504
-
2505
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2506
-
2507
- ### post
2508
-
2509
- [src/Particle.js:2777-2781](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2777-L2781 "Source code on GitHub")
2510
-
2511
- Make a POST request
2512
-
2513
- **Parameters**
2514
-
2515
- - `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2516
- - `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2517
- - `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2518
- - `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.
2519
- - `params.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Object to send as JSON data in the body.
2520
- - `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2521
-
2522
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2523
-
2524
- ### put
2525
-
2526
- [src/Particle.js:2794-2798](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2794-L2798 "Source code on GitHub")
2527
-
2528
- Make a PUT request
2529
-
2530
- **Parameters**
2531
-
2532
- - `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2533
- - `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2534
- - `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2535
- - `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.
2536
- - `params.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Object to send as JSON data in the body.
2537
- - `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
2538
- - `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2539
-
2540
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2541
-
2542
- ### delete
2543
-
2544
- [src/Particle.js:2810-2814](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2810-L2814 "Source code on GitHub")
2545
-
2546
- Make a DELETE request
2547
-
2548
- **Parameters**
2549
-
2550
- - `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
2551
- - `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2552
- - `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
2553
- - `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.
2554
- - `params.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Object to send as JSON data in the body.
2555
- - `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
2556
-
2557
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object
2558
-
2559
- ### request
2560
-
2561
- [src/Particle.js:2831-2835](https://github.com/particle-iot/particle-api-js/blob/520446cf581f583eebfa87c32c079d5670cf5473/src/Particle.js#L2831-L2835 "Source code on GitHub")
2562
-
2563
- **Parameters**
2564
-
2565
- - `args` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** An obj with all the possible request configurations
2566
- - `args.uri` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
2567
- - `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.
2568
- - `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.
2569
- - `args.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Object to send as JSON data in the body.
2570
- - `args.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization
2571
- - `args.query` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Query parameters
2572
- - `args.form` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Form fields
2573
- - `args.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Array of file names and file content
2574
- - `args.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project.
2575
- - `args.isBuffer` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Indicate if the response should be treated as Buffer instead of JSON
2576
-
2577
- Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;RequestResponse, RequestError>** A promise that resolves with either the requested data or an error object