Skip to content

Latest commit

 

History

History
2529 lines (1717 loc) · 206 KB

api.md

File metadata and controls

2529 lines (1717 loc) · 206 KB
Raw

Table of Contents

Particle

src/Particle.js:19-2826

Particle Cloud API wrapper.

See https://docs.particle.io/reference/javascript/ for examples of using the Particle class.

Most Particle methods take a single unnamed argument object documented as options with key/value pairs for each option.

Parameters

  • options (optional, default {})

constructor

src/Particle.js:32-41

Contructor for the Cloud API wrapper.

Create a new Particle object and call methods below on it.

Parameters

  • options Object Options for this API call Options to be used for all requests (see Defaults) (optional, default {})
    • options.baseUrl string?
    • options.clientSecret string?
    • options.clientId string?
    • options.tokenDuration number?
    • options.auth string? The access token. If not specified here, will have to be added to every request

login

src/Particle.js:78-95

Login to Particle Cloud using an existing Particle acccount.

Parameters

  • options Object Options for this API call
    • options.username String Username for the Particle account
    • options.password String Password for the Particle account
    • options.tokenDuration Number How long the access token should last in seconds (optional, default this.tokenDuration)
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Number? Request context

Returns Promise A promise

sendOtp

src/Particle.js:106-122

If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login

Parameters

  • options Object Options for this API call
    • options.mfaToken String Given as 'mfa_token' in the error body of .login().
    • options.otp String Current one-time-password generated from the authentication application
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Number? Request context

Returns Promise A promise

enableMfa

src/Particle.js:132-134

Enable MFA on the currently logged in user

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

confirmMfa

src/Particle.js:147-161

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.

Parameters

  • options Object Options for this API call
    • options.mfaToken Object Token given from previous step to
    • options.otp Object Current one-time-password generated from the authentication app
    • options.invalidateTokens Boolean Should all tokens be invalidated (optional, default false)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

disableMfa

src/Particle.js:172-180

Disable MFA for the user.

Parameters

  • options Object Options for this API call
    • options.currentPassword Object User's current password
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

createCustomer

src/Particle.js:192-208

Create Customer for Product.

Parameters

  • options Object Options for this API call
    • options.email String Username for the Particle account
    • options.password String Password for the Particle account
    • options.product String Create the customer in this product ID or slug
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

loginAsClientOwner

src/Particle.js:217-231

Login to Particle Cloud using an OAuth client.

Parameters

  • options Object Options for this API call
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

createUser

src/Particle.js:244-256

Create a user account for the Particle Cloud

Parameters

  • options Object Options for this API call
    • options.username String Email of the new user
    • options.password String Password
    • options.accountInfo String Object that contains account information fields such as user real name, company name, business account flag etc
    • options.utm Object? Object that contains info about the campaign that lead to this user creation
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

verifyUser

src/Particle.js:266-273

Verify new user account via verification email

Parameters

  • options Object Options for this API call
    • options.token String The string token sent in the verification email
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

resetPassword

src/Particle.js:283-290

Send reset password email for a Particle Cloud user account

Parameters

  • options Object Options for this API call
    • options.username String Email of the user
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteAccessToken

src/Particle.js:300-306

Revoke an access token

Parameters

  • options Object Options for this API call
    • options.token String Access token you wish to revoke
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteCurrentAccessToken

src/Particle.js:316-323

Revoke the current session access token

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteActiveAccessTokens

src/Particle.js:333-340

Revoke all active access tokens

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteUser

src/Particle.js:351-359

Delete the current user

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.password String Password
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

trackingIdentity

src/Particle.js:371-379

Retrieves the information that is used to identify the current login for tracking.

Parameters

  • options Object? Options for this API call (optional, default {})
    • options.full Boolean? When true, retrieve all information for registering a user with the tracking API. When false, retrieve only the unique tracking ID for the current login. (optional, default false)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> Resolve the tracking identify of the current login

listDevices

src/Particle.js:397-416

List devices claimed to the account or product

Parameters

  • options Object Options for this API call
    • options.deviceId String? (Product only) Filter results to devices with this ID (partial matching)
    • options.deviceName String? (Product only) Filter results to devices with this name (partial matching)
    • options.groups Array<string>? (Product only) A list of full group names to filter results to devices belonging to these groups only.
    • options.sortAttr String? (Product only) The attribute by which to sort results. See API docs for options.
    • options.sortDir String? (Product only) The direction of sorting. See API docs for options.
    • options.page Number? (Product only) Current page of results
    • options.perPage Number? (Product only) Records per page
    • options.product String? List devices in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getDevice

src/Particle.js:428-431

Get detailed informationa about a device

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

claimDevice

src/Particle.js:443-454

Claim a device to the account. The device must be online and unclaimed.

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID
    • options.requestTransfer boolean True to request the device be transfered from another user
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

addDeviceToProduct

src/Particle.js:468-486

Add a device to a product or move device out of quarantine.

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID
    • options.product String Add to this product ID or slug
    • options.file Object A file that contains a single-column list of device IDs, device serial numbers, device IMEIs, or devie ICCIDs. Node: Either a path or Buffer. Browser: a File or Blob.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

removeDevice

src/Particle.js:499-503

Unclaim / Remove a device from your account or product, or deny quarantine

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.deny Boolean? (Product only) Deny this quarantined device, instead of removing an already approved device
    • options.product String Remove from this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

removeDeviceOwner

src/Particle.js:515-518

Unclaim a product device its the owner, but keep it in the product

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.product String Remove from this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

renameDevice

src/Particle.js:531-533

Rename a device

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.name String Desired Name
    • options.product String? Rename device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

signalDevice

src/Particle.js:546-548

Instruct the device to turn on/off the LED in a rainbow pattern

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.signal Boolean Signal on or off
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

setDeviceNotes

src/Particle.js:561-563

Store some notes about device

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.notes String Your notes about this device
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

markAsDevelopmentDevice

src/Particle.js:576-578

Mark device as being used in development of a product so it opts out of automatic firmware updates

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.development Boolean Set to true to mark as development, false to return to product fleet (optional, default true)
    • options.product String Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

lockDeviceProductFirmware

src/Particle.js:592-594

Mark device as being used in development of a product, so it opts out of automatic firmware updates

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.desiredFirmwareVersion Number Lock the product device to run this firmware version.
    • options.flash Boolean? Immediately flash firmware indicated by desiredFirmwareVersion
    • options.product String Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

unlockDeviceProductFirmware

src/Particle.js:606-608

Mark device as receiving automatic firmware updates

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.product String Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

updateDevice

src/Particle.js:627-639

Update multiple device attributes at the same time

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.name String? Desired Name
    • options.signal Boolean? Signal device on or off
    • options.notes String? Your notes about this device
    • options.development Boolean? (Product only) Set to true to mark as development, false to return to product fleet
    • options.desiredFirmwareVersion (Number | null)? (Product only) Lock the product device to run this firmware version. Pass null to unlock firmware and go back to released firmware.
    • options.flash Boolean? (Product only) Immediately flash firmware indicated by desiredFirmwareVersion
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

unprotectDevice

src/Particle.js:659-675

Disable device protection.

Parameters

  • options Object Options for this API call.
    • options.deviceId String Device ID or name.
    • options.org String? Organziation ID or slug.
    • options.product String? Product ID or slug.
    • options.action String Request action: prepare or confirm.
    • options.serverNonce String? Base64-encoded server nonce. Mandatory if action is confirm,
    • options.deviceNonce String? Base64-encoded device nonce. Mandatory if action is confirm,
    • options.deviceSignature String? Base64-encoded device signature. Mandatory if action is confirm,
    • options.devicePublicKeyFingerprint String? Base64-encoded fingerprint of the device public key. Mandatory if action is confirm,
    • options.auth string? The access token. Can be ignored if provided in constructor.
    • options.headers Object? Key/value pairs to send as headers.
    • options.context Object? Request context.

Returns Promise A promise

provisionDevice

src/Particle.js:686-694

Provision a new device for products that allow self-provisioning

Parameters

  • options Object Options for this API call
    • options.productId String Product ID where to create this device
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getClaimCode

src/Particle.js:708-711

Generate a claim code to use in the device claiming process. To generate a claim code for a product, the access token MUST belong to a customer of the product.

Parameters

  • options Object Options for this API call
    • options.iccid String? ICCID of the SIM card used in the Electron
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getVariable

src/Particle.js:733-739

Get the value of a device variable

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.name String Variable name
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

flashDevice

src/Particle.js:753-764

Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.product String Flash device in this product ID or slug
    • options.files 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.
    • options.targetVersion String System firmware version to compile against (optional, default latest)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

flashTinker

src/Particle.js:775-790

DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

compileCode

src/Particle.js:803-821

Compile firmware using the Particle Cloud

Parameters

  • options Object Options for this API call
    • options.files 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.
    • options.platformId Number? Platform id number of the device you are compiling for. Common values are 0=Core, 6=Photon, 10=Electron.
    • options.targetVersion String System firmware version to compile against (optional, default latest)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

downloadFirmwareBinary

src/Particle.js:832-841

Download a firmware binary

Parameters

  • options Object Options for this API call
    • options.binaryId String Binary ID received from a successful compile call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse, RequestError> A promise

sendPublicKey

src/Particle.js:854-868

Send a new device public key to the Particle Cloud

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.key (String | Buffer) Public key contents
    • options.algorithm String Algorithm used to generate the public key. Valid values are rsa or ecc. (optional, default rsa)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

callFunction

src/Particle.js:882-887

Call a device function

Parameters

  • options Object Options for this API call
    • options.deviceId String Device ID or Name
    • options.name String Function name
    • options.argument String Function argument
    • options.product String? Device in this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getEventStream

src/Particle.js:900-925

Get a stream of events

Parameters

  • options Object Options for this API call
    • options.deviceId String? Device ID or Name, or mine to indicate only your devices.
    • options.name String? Event Name
    • options.org String? Organization Slug
    • options.product String? Events for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor

Returns Promise If the promise resolves, the resolution value will be an EventStream object that will emit 'event' events.

publishEvent

src/Particle.js:939-943

Publish a event to the Particle Cloud

Parameters

  • options Object Options for this API call
    • options.name String Event name
    • options.data String Event data
    • options.isPrivate Boolean Should the event be publicly available?
    • options.product String? Event for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

Hook

src/Particle.js:974-996

Type: Object

Parameters

  • $0 Object
    • $0.event
    • $0.url
    • $0.device
    • $0.rejectUnauthorized
    • $0.noDefaults
    • $0.hook
    • $0.product
    • $0.auth
    • $0.headers
    • $0.context

Properties

  • method String? Type of web request triggered by the Webhook (GET, POST, PUT, or DELETE)
  • auth Object? Auth data like { user: 'me', pass: '1234' } for basic auth or { bearer: 'token' } to send with the Webhook request
  • headers Object? Additional headers to add to the Webhook like { 'X-ONE': '1', X-TWO: '2' }
  • query Object? Query params to add to the Webhook request like { foo: 'foo', bar: 'bar' }
  • json Object? JSON data to send with the Webhook request - sets Content-Type to application/json
  • form Object? Form data to send with the Webhook request - sets Content-Type to application/x-www-form-urlencoded
  • body String? Custom body to send with the Webhook request
  • responseTemplate Object? Template to use to customize the Webhook response body
  • responseEvent Object? The Webhook response event name that your devices can subscribe to
  • errorResponseEvent Object? The Webhook error response event name that your devices can subscribe to

createWebhook

src/Particle.js:974-996

Create a webhook

Parameters

  • options Object Options for this API call
    • options.event String The name of the Particle event that should trigger the Webhook
    • options.url String The web address that will be targeted when the Webhook is triggered
    • options.device String? Trigger Webhook only for this device ID or Name
    • options.rejectUnauthorized Boolean? Set to false to skip SSL certificate validation of the target URL
    • options.noDefaults Boolean? Don't include default event data in the webhook request
    • options.hook Hook? Webhook configuration settings
    • options.product String? Webhook for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteWebhook

src/Particle.js:1008-1011

Delete a webhook

Parameters

  • options Object Options for this API call
    • options.hookId String Webhook ID
    • options.product String? Webhook for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listWebhooks

src/Particle.js:1022-1025

List all webhooks owned by the account or product

Parameters

  • options Object Options for this API call
    • options.product String? Webhooks for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

createIntegration

src/Particle.js:1042-1046

Create an integration to send events to an external service

See the API docs for details https://docs.particle.io/reference/api/#integrations-webhooks-

Parameters

  • options Object Options for this API call
    • options.event String Event that triggers the integration
    • options.settings Object Settings specific to that integration type
    • options.deviceId String? Trigger integration only for this device ID or Name
    • options.product String? Integration for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

editIntegration

src/Particle.js:1064-1068

Edit an integration to send events to an external service

See the API docs for details https://docs.particle.io/reference/api/#integrations-webhooks-

Parameters

  • options Object Options for this API call
    • options.integrationId String The integration to edit
    • options.event String? Change the event that triggers the integration
    • options.settings Object? Change the settings specific to that integration type
    • options.deviceId String? Trigger integration only for this device ID or Name
    • options.product String? Integration for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteIntegration

src/Particle.js:1081-1084

Delete an integration to send events to an external service

Parameters

  • options Object Options for this API call
    • options.integrationId String The integration to remove
    • options.product String? Integration for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listIntegrations

src/Particle.js:1095-1098

List all integrations owned by the account or product

Parameters

  • options Object Options for this API call
    • options.product String? Integrations for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getUserInfo

src/Particle.js:1108-1110

Get details about the current user

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

setUserInfo

src/Particle.js:1121-1124

Set details on the current user

Parameters

  • options Object Options for this API call
    • options.accountInfo String Set user's extended info fields (name, business account, company name, etc)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

changeUsername

src/Particle.js:1137-1145

Change username (i.e, email)

Parameters

  • options Object Options for this API call
    • options.currentPassword String Current password
    • options.username String New email
    • options.invalidateTokens Boolean Should all tokens be invalidated (optional, default false)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

changeUserPassword

src/Particle.js:1158-1166

Change user's password

Parameters

  • options Object Options for this API call
    • options.currentPassword String Current password
    • options.password String New password
    • options.invalidateTokens Boolean Should all tokens be invalidated (optional, default false)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listSIMs

src/Particle.js:1182-1186

List SIM cards owned by a user or product

Parameters

  • options Object Options for this API call
    • options.iccid String? (Product only) Filter to SIM cards matching this ICCID
    • options.deviceId String? (Product only) Filter to SIM cards matching this device ID
    • options.deviceName String? (Product only) Filter to SIM cards matching this device name
    • options.page Number? (Product only) Current page of results
    • options.perPage Number? (Product only) Records per page
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getSIMDataUsage

src/Particle.js:1198-1204

Get data usage for one SIM card for the current billing period

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.product String? SIM card for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getFleetDataUsage

src/Particle.js:1215-1222

Get data usage for all SIM cards in a product the current billing period

Parameters

  • options Object Options for this API call
    • options.product String SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

checkSIM

src/Particle.js:1233-1235

Check SIM status

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

activateSIM

src/Particle.js:1250-1260

Activate and add SIM cards to an account or product

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.iccids Array<String> (Product only) ICCID of multiple SIM cards to import
    • options.country String The ISO country code for the SIM cards
    • options.promoCode any?
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deactivateSIM

src/Particle.js:1272-1276

Deactivate a SIM card so it doesn't incur data usage in future months.

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

reactivateSIM

src/Particle.js:1289-1293

Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.mbLimit Number? New monthly data limit. Necessary if unpausing a SIM card
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

updateSIM

src/Particle.js:1306-1310

Update SIM card data limit

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.mbLimit Array Data limit in megabyte for the SIM card
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

removeSIM

src/Particle.js:1322-1325

Remove a SIM card from an account so it can be activated by a different account

Parameters

  • options Object Options for this API call
    • options.iccid String ICCID of the SIM card
    • options.product String? SIM cards for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listBuildTargets

src/Particle.js:1336-1339

List valid build targets to be used for compiling

Parameters

  • options Object Options for this API call
    • options.onlyFeatured Boolean Only list featured build targets (optional, default false)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listLibraries

src/Particle.js:1365-1382

List firmware libraries

Parameters

  • options Object Options for this API call
    • options.page Number Page index (default, first page)
    • options.limit Number Number of items per page
    • options.filter String Search term for the libraries
    • options.sort String Ordering key for the library list
    • options.architectures Array<String> List of architectures to filter
    • options.category String Category to filter
    • options.scope String The library scope to list. Default is 'all'. Other values are - 'all' - list public libraries and my private libraries - 'public' - list only public libraries - 'private' - list only my private libraries - 'mine' - list my libraries (public and private) - 'official' - list only official libraries - 'verified' - list only verified libraries - 'featured' - list only featured libraries
    • options.excludeScopes String list of scopes to exclude
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getLibrary

src/Particle.js:1398-1406

Get firmware library details

Parameters

  • options Object Options for this API call
    • options.name String Name of the library to fetch
    • options.version String Version of the library to fetch (default: latest)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getLibraryVersions

src/Particle.js:1419-1427

Firmware library details for each version

Parameters

  • options Object Options for this API call
    • options.name String Name of the library to fetch
    • options.page Number Page index (default, first page)
    • options.limit Number Number of items per page
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

contributeLibrary

src/Particle.js:1439-1452

Contribute a new library version from a compressed archive

Parameters

  • options Object Options for this API call
    • options.archive (String | Buffer) Compressed archive file containing the library sources Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

publishLibrary

src/Particle.js:1463-1472

Publish the latest version of a library to the public

Parameters

  • options Object Options for this API call
    • options.name String Name of the library to publish
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteLibrary

src/Particle.js:1484-1492

Delete one version of a library or an entire private library

Parameters

  • options Object Options for this API call
    • options.name String Name of the library to remove
    • options.force String Key to force deleting a public library
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

downloadFile

src/Particle.js:1502-1504

Download an external file that may not be on the API

Parameters

  • options Object Options for this API call
    • options.uri String URL of the file.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise Resolves to a buffer with the file data

listOAuthClients

src/Particle.js:1515-1518

List OAuth client created by the account

Parameters

  • options Object Options for this API call
    • options.product String? List clients for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

createOAuthClient

src/Particle.js:1533-1537

Create an OAuth client

Parameters

  • options Object Options for this API call
    • options.name String Name of the OAuth client
    • options.type String web, installed or web
    • options.redirect_uri String? URL to redirect after OAuth flow. Only for type web.
    • options.scope Object? Limits what the access tokens created by this client can do.
    • options.product String? Create client for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

updateOAuthClient

src/Particle.js:1551-1555

Update an OAuth client

Parameters

  • options Object Options for this API call
    • options.clientId String The OAuth client to update
    • options.name String? New Name of the OAuth client
    • options.scope Object? New scope of the OAuth client
    • options.product String? Update client linked to this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

deleteOAuthClient

src/Particle.js:1567-1570

Delete an OAuth client

Parameters

  • options Object Options for this API call
    • options.clientId String The OAuth client to update
    • options.product String? OAuth client linked to this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listProducts

src/Particle.js:1580-1582

List products the account has access to

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProduct

src/Particle.js:1593-1595

Get detailed information about a product

Parameters

  • options Object Options for this API call
    • options.product String Product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listProductFirmware

src/Particle.js:1606-1608

List product firmware versions

Parameters

  • options Object Options for this API call
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

uploadProductFirmware

src/Particle.js:1624-1640

List product firmware versions

Parameters

  • options Object Options for this API call
    • options.file Object Path or Buffer of the new firmware file Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
    • options.version Number Version number of new firmware
    • options.title String Short identifier for the new firmware
    • options.description String? Longer description for the new firmware
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProductFirmware

src/Particle.js:1652-1659

Get information about a product firmware version

Parameters

  • options Object Options for this API call
    • options.version Number Version number of firmware
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

updateProductFirmware

src/Particle.js:1673-1676

Update information for a product firmware version

Parameters

  • options Object Options for this API call
    • options.version Number Version number of new firmware
    • options.title String? New title
    • options.description String? New description
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

downloadProductFirmware

src/Particle.js:1688-1697

Download a product firmware binary

Parameters

  • options Object Options for this API call
    • options.version Number Version number of new firmware
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

releaseProductFirmware

src/Particle.js:1709-1712

Release a product firmware version as the default version

Parameters

  • options Object Options for this API call
    • options.version Number Version number of new firmware
    • options.product String Firmware for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

listTeamMembers

src/Particle.js:1723-1730

List product team members

Parameters

  • options Object Options for this API call
    • options.product String Team for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

inviteTeamMember

src/Particle.js:1742-1750

Invite Particle user to a product team

Parameters

  • options Object Options for this API call
    • options.username String Username for the Particle account
    • options.product String Team for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

removeTeamMember

src/Particle.js:1762-1769

Remove Particle user to a product team

Parameters

  • options Object Options for this API call
    • options.username String Username for the Particle account
    • options.product String Team for this product ID or slug
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

lookupSerialNumber

src/Particle.js:1780-1787

Fetch details about a serial number

Parameters

  • options Object Options for this API call
    • options.serialNumber String The serial number printed on the barcode of the device packaging
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

createMeshNetwork

src/Particle.js:1800-1808

Create a mesh network

Parameters

  • options Object Options for this API call
    • options.name String Network name
    • options.deviceId String Gateway device ID
    • options.iccid String? ICCID of the active SIM card (only for cellular gateway devices)
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

removeMeshNetwork

src/Particle.js:1819-1821

Remove a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String Network ID or name
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

listMeshNetworks

src/Particle.js:1833-1836

List all mesh networks

Parameters

  • options Object Options for this API call
    • options.page Number? Current page of results
    • options.perPage Number? Records per page
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

getMeshNetwork

src/Particle.js:1847-1849

Get information about a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String Network ID or name
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

updateMeshNetwork

src/Particle.js:1862-1870

Modify a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String Network ID or name
    • options.action String 'add-device', 'remove-device', 'gateway-enable' or 'gateway-disable'
    • options.deviceId String Device ID
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

addMeshNetworkDevice

src/Particle.js:1882-1891

Add a device to a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String Network ID or name
    • options.deviceId String Device ID
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

removeMeshNetworkDevice

src/Particle.js:1903-1919

Remove a device from a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String? Network ID or name
    • options.deviceId String Device ID
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

listMeshNetworkDevices

src/Particle.js:1933-1942

List all devices of a mesh network.

Parameters

  • options Object Options for this API call
    • options.networkId String Network ID or name
    • options.role Number? Device role: 'gateway' or 'node'
    • options.page Number? Current page of results
    • options.perPage Number? Records per page
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<Object> A promise

getProductConfiguration

src/Particle.js:1953-1960

Get product configuration

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProductConfigurationSchema

src/Particle.js:1971-1979

Get product configuration schema

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers. (optional, default {})
    • options.context Object? Request context

Returns Promise A promise

getProductDeviceConfiguration

src/Particle.js:1991-1998

Get product device's configuration

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.deviceId String Device ID to access
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProductDeviceConfigurationSchema

src/Particle.js:2010-2018

Get product device's configuration schema

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.deviceId String Device ID to access
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

setProductConfiguration

src/Particle.js:2030-2038

Set product configuration

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.config Object Product configuration to update
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

setProductDeviceConfiguration

src/Particle.js:2051-2059

Set product configuration for a specific device within the product

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Config for this product ID or slug
    • options.deviceId String Device ID to access
    • options.config Object Product configuration to update
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProductLocations

src/Particle.js:2078-2095

Query location for devices within a product

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Locations for this product ID or slug
    • options.dateRange String Start and end date in ISO8601 format, separated by comma, to query
    • options.rectBl String Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
    • options.rectTr String Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
    • options.deviceId String Device ID prefix to include in the query
    • options.deviceName String Device name prefix to include in the query
    • options.groups String Array of group names to include in the query
    • options.page String Page of results to display. Defaults to 1
    • options.perPage String Number of results per page. Defaults to 20. Maximum of 100
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

getProductDeviceLocations

src/Particle.js:2112-2124

Query location for one device within a product

Parameters

  • options Object Options for this API call
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.product String Locations for this product ID or slug
    • options.dateRange String Start and end date in ISO8601 format, separated by comma, to query
    • options.rectBl String Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
    • options.rectTr String Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
    • options.deviceId String Device ID to query
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise A promise

executeLogic

src/Particle.js:2140-2148

Executes the provided logic function once and returns the result. No logs, runs, etc are saved

NOTE: Any external interactions such as Particle.publish will actually occur when the logic is executed.

Parameters

  • options Object The options for creating the logic function.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logic Object The logic "function" which will be executed once
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the created logic function data.

createLogicFunction

src/Particle.js:2168-2176

Creates a new logic function in the specified organization or sandbox using the provided function data.

When you create a logic function with Event logic triggers, events will immediately start being handled by the function code.

When you create a Scheduled logic trigger, it will immediately be scheduled at the next time according to the cron and start_at properties.

Parameters

  • options Object The options for creating the logic function.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunction Object The logic function object containing the function details.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the created logic function data.

getLogicFunction

src/Particle.js:2190-2197

Get a logic function in the specified organization or sandbox by logic function ID.

Parameters

  • options Object The options for the logic function.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunctionId string The ID of the logic function to retrieve.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the specified logic function data.

updateLogicFunction

src/Particle.js:2214-2222

Updates an existing logic function in the specified organization or sandbox using the provided function data.

If you include an id on a logic trigger, it will update the logic trigger in place.

Parameters

  • options Object The options for updating the logic function.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunctionId string The ID of the logic function to update.
    • options.logicFunction Object The logic function object containing the logic function details.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to the updated logic function data.

deleteLogicFunction

src/Particle.js:2236-2243

Deletes a logic function in the specified organization or sandbox by logic function ID.

Parameters

  • options Object The options for deleting the logic function.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunctionId string The ID of the logic function to delete.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an object containing the deleted logic function ID.

listLogicFunctions

src/Particle.js:2257-2267

Lists all logic functions in the specified organization or sandbox.

Parameters

  • options Object The options for listing logic functions.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.todayStats boolean? Whether to include today's stats in the response
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an array of logic functions data.

listLogicRuns

src/Particle.js:2281-2288

Lists all logic runs for the specified logic function in the specified organization or sandbox.

Parameters

  • options Object The options for the request.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunctionId string The ID of the logic function for which to retrieve the logic runs.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to an array of logic run data.

getLogicRun

src/Particle.js:2303-2310

Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.

Parameters

  • options Object The options for the request.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.logicFunctionId string The ID of the logic function for which to retrieve the logic run.
    • options.logicRunId string The ID of the logic run to retrieve.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to an array of logic run data for the specified logic run ID.

getLogicRunLogs

src/Particle.js:2325-2332

Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.

Parameters

  • options Object The options for the request.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The unique identifier of the organization.
    • options.logicFunctionId string The ID of the logic function for which to retrieve the logic run logs.
    • options.logicRunId string The ID of the logic run for which to retrieve the logs.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the logs for the specified logic run ID.

createLedger

src/Particle.js:2346-2354

Creates a new ledger definition in the specified organization or sandbox.

Parameters

  • options Object The options for creating the ledger definition.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledger object The ledger definition object.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the created ledger definition data.

getLedger

src/Particle.js:2368-2375

Get a ledger definition in the specified organization or sandbox by ledger name.

Parameters

  • options Object The options for the ledger definition.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string The ID of the ledger definition to retrieve.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the specified ledger definition data.

updateLedger

src/Particle.js:2390-2398

Updates an existing ledger definition in the specified organization or sandbox.

Parameters

  • options Object The options for updating the ledger definition.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Name of the ledger definition to update.
    • options.ledger object The ledger definition object.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to the updated ledger definition data.

archiveLedger

src/Particle.js:2412-2419

Archives a ledger definition in the specified organization or sandbox by ledger name.

Parameters

  • options Object The options for archiving the ledger definition.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Name of the ledger definition to archive.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an object confirming the ledger definition was archived.

Scope

src/Particle.js:2440-2453

Type: ("Owner" | "Product" | "Device")

Parameters

  • $0 Object
    • $0.auth
    • $0.org
    • $0.scope
    • $0.page
    • $0.perPage
    • $0.archived
    • $0.headers
    • $0.context

listLedgers

src/Particle.js:2440-2453

Lists all ledger definitions in the specified organization or sandbox.

Parameters

  • options Object The options for listing ledger definitions.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.scope Scope? Filter to show only ledgers of the specified scope
    • options.page number? Page of results to display
    • options.perPage number? Number of results per page. Default is 100
    • options.archived boolean? Filter to show only archived ledger or non-archived ledgers. If not provided, all ledgers are returned.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an array of ledger definition data.

getLedgerInstance

src/Particle.js:2468-2475

Get ledger instance data.

Parameters

  • options Object The options for the ledger instance.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Ledger name.
    • options.scopeValue string Scope value.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the specified ledger instance data.

SetMode

src/Particle.js:2496-2507

Type: ("Replace" | "Merge")

Parameters

  • $0 Object
    • $0.auth
    • $0.org
    • $0.ledgerName
    • $0.scopeValue
    • $0.instance
    • $0.setMode
    • $0.headers
    • $0.context

setLedgerInstance

src/Particle.js:2496-2507

Set ledger instance data.

Parameters

  • options Object The options for updating the ledger instance.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Ledger name.
    • options.scopeValue string Scope value.
    • options.instance object The instance with the data
    • options.setMode SetMode? How the data should be set with existing data. Default is "Replace"
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to the updated ledger instance data.

deleteLedgerInstance

src/Particle.js:2522-2529

Delete a ledger instance in the specified organization or sandbox by ledger name.

Parameters

  • options Object The options for archiving the ledger instance.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Name of the ledger instance to archive.
    • options.scopeValue string Scope value.
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an object confirming the ledger instance was deleted.

listLedgerInstances

src/Particle.js:2545-2556

Lists ledger instances in the specified organization or sandbox.

Parameters

  • options Object The options for listing ledger instances.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The unique identifier of the organization.
    • options.ledgerName string Name of the ledger instance to archive.
    • options.page number? Page of results to display
    • options.perPage number? Number of results per page. Default is 100
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context.

Returns Promise<RequestResponse> A promise that resolves to an array of ledger instance data.

listLedgerInstanceVersions

src/Particle.js:2573-2584

List ledger instance versions

Parameters

  • options Object The options for the ledger instance.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Ledger name.
    • options.scopeValue string Scope value.
    • options.replacedBefore string? ISO date string to filter to instances replaced before this time
    • options.replacedAfter string? ISO date string to filter to instances replaced after this time
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to an array of ledger instance data.

getLedgerInstanceVersion

src/Particle.js:2600-2607

Get specific ledger instance version

Parameters

  • options Object The options for the ledger instance.
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.org string? The Organization ID or slug. If not provided, the request will go to your sandbox account.
    • options.ledgerName string Ledger name.
    • options.scopeValue string Scope value.
    • options.version string Version of the ledger instance
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the specified ledger instance data.

listDeviceOsVersions

src/Particle.js:2623-2638

List Device OS versions

Parameters

  • options Object Options for this API call
    • options.platformId Number? Platform ID to filter Device OS versions
    • options.internalVersion Number? Internal version number to filter Device OS versions
    • options.page Number? Page number for pagination
    • options.perPage Number? Number of items per page
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the list of Device OS versions.

getDeviceOsVersion

src/Particle.js:2652-2661

Get a specific Device OS version

Parameters

  • options Object Options for this API call
    • options.version String Version of the Device OS
    • options.platformId Number? Optional platform ID to filter Device OS version
    • options.auth string? The access token. Can be ignored if provided in constructor
    • options.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • options.context Object? Request context

Returns Promise<RequestResponse> A promise that resolves to the specified Device OS version data.

setDefaultAuth

src/Particle.js:2668-2674

Set default auth token that will be used in each method if auth is not provided

Parameters

  • auth string The access token

  • Throws Error When not auth string is provided

get

src/Particle.js:2724-2728

Make a GET request

Parameters

  • params object
    • params.uri string The URI to request
    • params.auth string? Authorization token to use
    • params.headers object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • params.query object? Key/Value pairs of query params or a correctly formatted string
    • params.context object? The invocation context, describing the tool and project

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

head

src/Particle.js:2740-2744

Make a HEAD request

Parameters

  • params object
    • params.uri string The URI to request
    • params.auth string? Authorization token to use
    • params.headers object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • params.query object? Key/Value pairs of query params or a correctly formatted string
    • params.context object? The invocation context, describing the tool and project

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

post

src/Particle.js:2756-2760

Make a POST request

Parameters

  • params object
    • params.uri string The URI to request
    • params.auth string? Authorization token to use
    • params.headers object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • params.data (string | object)? Request body
    • params.context object? The invocation context, describing the tool and project

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

put

src/Particle.js:2773-2777

Make a PUT request

Parameters

  • params object
    • params.uri string The URI to request
    • params.auth string? Authorization token to use
    • params.headers object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • params.data (string | object)? Request body
    • params.query object? Key/Value pairs of query params or a correctly formatted string
    • params.context object? The invocation context, describing the tool and project

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

delete

src/Particle.js:2789-2793

Make a DELETE request

Parameters

  • params object
    • params.uri string The URI to request
    • params.auth string? Authorization token to use
    • params.headers object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • params.data (string | object)? Request body
    • params.context object? The invocation context, describing the tool and project

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object

request

src/Particle.js:2810-2814

Parameters

  • args Object An obj with all the possible request configurations
    • args.uri String The URI to request
    • args.method String The method used to request the URI, should be in uppercase.
    • args.headers Object? Key/Value pairs like { 'X-FOO': 'foo', X-BAR: 'bar' } to send as headers.
    • args.data object? Arbitrary data to send as the body.
    • args.auth string? Authorization
    • args.query Object? Query parameters
    • args.form Object? Form fields
    • args.files Object? Array of file names and file content
    • args.context Object? The invocation context, describing the tool and project.
    • args.isBuffer boolean? Indicate if the response should be treated as Buffer instead of JSON

Returns Promise<RequestResponse, RequestError> A promise that resolves with either the requested data or an error object