Documentation

Mistake on this page? Email us

DefaultApi DefaultApi DefaultApi

Hierarchy

  • ApiBase
  • ApiBase
  • ApiBase
    • DefaultApi

Index

Constructors

constructor

  • Parameters

    • Optional options: ConfigOptions
    • Default value responseHandler: function = null
        • (sdkError: SDKError, response: superagent.Response): any
        • Parameters

          • sdkError: SDKError
          • response: superagent.Response

          Returns any

    Returns DefaultApi

Methods

complete

  • complete(error: any, response: any, acceptHeader: string, callback?: function): void
  • Parameters

    • error: any
    • response: any
    • acceptHeader: string
    • Optional callback: function
        • Parameters

          Returns any

    Returns void

currentConfig

  • currentConfig(): object
  • Returns the current configuration of this API module

    Returns object

    • apiKey: any
    • host: any

deviceCreate

  • deviceCreate(device: DeviceDataPostRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a device Create a new device.

    Parameters

    • device: DeviceDataPostRequest
    • Optional callback: function
        • (error: any, data?: DeviceData, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceData
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceDestroy

  • deviceDestroy(id: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a device. Delete device. Only available for devices with a developer certificate. Attempts to delete a device with a production certicate will return a 400 response.

    Parameters

    • id: string
    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceEventList

  • deviceEventList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List all device events. List all device events for an account.

    Parameters

    • Optional limit: number

      How many objects to retrieve in the page.

    • Optional order: string

      The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.

    • Optional after: string

      The ID of The item after which to retrieve the next page.

    • Optional filter: string

      URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:------------:|:----------------:|:-------------:|:-------------:| | date_time | ✓ | ✓ | ✓ | | description | ✓ | ✓ | | | id | ✓ | ✓ | | | device_id | ✓ | ✓ | | | event_type | ✓ | ✓ | | | state_change | ✓ | ✓ | | The examples below show the queries in unencoded form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```gte``` * less than or equal to – field name suffixed with ```lte``` Lower and upper limits to a date-time range may be specified by including both the ```gte``` and ```lte``` forms in the filter. ```{field name}[|lte|gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_timegte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: `total_count`

    • Optional callback: function
        • (error: any, data?: DeviceEventPage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceEventPage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceEventRetrieve

  • deviceEventRetrieve(deviceEventId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Retrieve a device event. Retrieve a specific device event.

    Parameters

    • deviceEventId: string
    • Optional callback: function
        • (error: any, data?: DeviceEventData, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceEventData
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceList

  • deviceList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List all devices. List all devices.

    Parameters

    • Optional limit: number

      How many objects to retrieve in the page.

    • Optional order: string

      The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.

    • Optional after: string

      The ID of The item after which to retrieve the next page.

    • Optional filter: string

      URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:-------------------------:|:----------------:|:-------------:|:-------------:| | account_id | ✓ | ✓ | | | auto_update | ✓ | ✓ | | | bootstrap_expiration_date | ✓ | ✓ | ✓ | | bootstrapped_timestamp | ✓ | ✓ | ✓ | | ca_id | ✓ | ✓ | | | connector_expiration_date | ✓ | ✓ | ✓ | | created_at | ✓ | ✓ | ✓ | | custom_attributes | ✓ | | | | deployed_state | ✓ | ✓ | | | deployment | ✓ | ✓ | | | description | ✓ | ✓ | | | device_class | ✓ | ✓ | | | device_execution_mode | ✓ | ✓ | | | device_key | ✓ | ✓ | | | endpoint_name | ✓ | ✓ | | | endpoint_type | ✓ | ✓ | | | enrolment_list_timestamp | ✓ | ✓ | ✓ | | etag | ✓ | ✓ | ✓ | | firmware_checksum | ✓ | ✓ | | | host_gateway | ✓ | ✓ | | | id | ✓ | ✓ | | | manifest | ✓ | ✓ | | | manifest_timestamp | ✓ | ✓ | ✓ | | mechanism | ✓ | ✓ | | | mechanism_url | ✓ | ✓ | | | name | ✓ | ✓ | | | serial_number | ✓ | ✓ | | | state | ✓ | ✓ | | | updated_at | ✓ | ✓ | ✓ | | vendor_id | ✓ | ✓ | | The examples below show the queries in unencoded form. ###### By device properties (all properties are filterable): ```state=[unenrolled|cloud_enrolling|bootstrapped|registered]``` ```device_class={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```gte``` * less than or equal to – field name suffixed with ```lte``` Lower and upper limits to a date-time range may be specified by including both the ```gte``` and ```lte``` forms in the filter. ```{field name}[|lte|gte]={UTC RFC3339 date-time}``` ###### On device custom attributes: ```custom_attributes{param}={value}``` ```custom_attributes__tag=TAG1``` ##### Multi-field example ```state=bootstrapped&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```?filter=state%3Dbootstrapped%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `state__nin=unenrolled,dergistered`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: `total_count`.

    • Optional callback: function
        • (error: any, data?: DevicePage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DevicePage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceLogList

  • deviceLogList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • DEPRECATED: List all device events. DEPRECATED: List all device events. Use `/v3/device-events/` instead.

    Parameters

    • Optional limit: number

      How many objects to retrieve in the page.

    • Optional order: string

      The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.

    • Optional after: string

      The ID of The item after which to retrieve the next page.

    • Optional filter: string

      URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:------------:|:----------------:|:-------------:|:-------------:| | date_time | ✓ | ✓ | ✓ | | description | ✓ | ✓ | | | id | ✓ | ✓ | | | device_id | ✓ | ✓ | | | event_type | ✓ | ✓ | | | state_change | ✓ | ✓ | | The examples below show the queries in unencoded form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```gte``` * less than or equal to – field name suffixed with ```lte``` Lower and upper limits to a date-time range may be specified by including both the ```gte``` and ```lte``` forms in the filter. ```{field name}[|lte|gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_timegte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: `total_count`.

    • Optional callback: function
        • (error: any, data?: DeviceEventPage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceEventPage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceLogRetrieve

  • deviceLogRetrieve(deviceEventId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • DEPRECATED: Retrieve a device event. Retrieve device event (deprecated, use /v3/device-events/{device_event_id}/ instead)

    Parameters

    • deviceEventId: string
    • Optional callback: function
        • (error: any, data?: DeviceEventData, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceEventData
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceQueryCreate

  • deviceQueryCreate(device: DeviceQueryPostPutRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a device query Create a new device query.

    Parameters

    • device: DeviceQueryPostPutRequest
    • Optional callback: function
        • (error: any, data?: DeviceQuery, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceQuery
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceQueryDestroy

  • deviceQueryDestroy(queryId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a device query Delete a device query.

    Parameters

    • queryId: string
    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceQueryList

  • deviceQueryList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List device queries. List all device queries. The result will be paged into pages of 100.

    Parameters

    • Optional limit: number

      How many objects to retrieve in the page.

    • Optional order: string

      The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.

    • Optional after: string

      The ID of The item after which to retrieve the next page.

    • Optional filter: string

      URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:----------:|:----------------:|:-------------:|:-------------:| | created_at | ✓ | ✓ | ✓ | | etag | ✓ | ✓ | ✓ | | id | ✓ | ✓ | | | name | ✓ | ✓ | | | query | ✓ | ✓ | | | updated_at | ✓ | ✓ | ✓ | The examples below show the queries in unencoded form. ###### By device query properties (all properties are filterable): For example: ```description={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```gte``` * less than or equal to – field name suffixed with ```lte``` Lower and upper limits to a date-time range may be specified by including both the ```gte``` and ```lte``` forms in the filter. ```{field name}[|lte|gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```query_id=0158d38771f70000000000010010038c&created_atgte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```filter=query_id%3D0158d38771f70000000000010010038c%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `name__nin=query1,query2`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: `total_count`.

    • Optional callback: function
        • (error: any, data?: DeviceQueryPage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceQueryPage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceQueryRetrieve

  • deviceQueryRetrieve(queryId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Retrieve a device query. Retrieve a specific device query.

    Parameters

    • queryId: string
    • Optional callback: function
        • (error: any, data?: DeviceQuery, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceQuery
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceQueryUpdate

  • deviceQueryUpdate(queryId: string, body: DeviceQueryPostPutRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update a device query Update a specifc device query.

    Parameters

    • queryId: string
    • body: DeviceQueryPostPutRequest

      Device query update object.

    • Optional callback: function
        • (error: any, data?: DeviceQuery, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceQuery
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceRetrieve

  • deviceRetrieve(id: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get a devices Retrieve information about a specific device.

    Parameters

    • id: string
    • Optional callback: function
        • (error: any, data?: DeviceData, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceData
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deviceUpdate

  • deviceUpdate(id: string, device: DeviceDataPutRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update a device Update a specific device.

    Parameters

    • id: string

      The ID of the device.

    • device: DeviceDataPutRequest
    • Optional callback: function
        • (error: any, data?: DeviceData, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: DeviceData
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareImageCreate

  • firmwareImageCreate(datafile: any, name: string, description?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create an image Create firmware image.

    Parameters

    • datafile: any

      The firmware image file to upload

    • name: string

      The name of the firmware image

    • Optional description: string

      The description of the firmware image

    • Optional callback: function
        • (error: any, data?: FirmwareImage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: FirmwareImage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareImageDestroy

  • firmwareImageDestroy(imageId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete an image Delete firmware image.

    Parameters

    • imageId: string

      The firmware image ID

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareImageList

  • firmwareImageList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List all images List all firmware images.

    Parameters

    • Optional limit: number

      How many firmware images to retrieve

    • Optional order: string

      ASC or DESC

    • Optional after: string

      The ID of the the item after which to retrieve the next page

    • Optional filter: string

      URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:-----------------:|:----------------:|:-------------:|:-------------:| | created_at | ✓ | ✓ | ✓ | | datafile | ✓ | ✓ | | | datafile_checksum | ✓ | ✓ | | | datafile_size | ✓ | ✓ | | | description | ✓ | ✓ | | | etag | ✓ | ✓ | ✓ | | id | ✓ | ✓ | | | name | ✓ | ✓ | | | timestamp | ✓ | ✓ | ✓ | | updated_at | ✓ | ✓ | ✓ | The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` Filtering by properties `name__eq=myimage` Filtering on date-time fields Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `eq` to the field name * greater than or equal to by appending `gte` to the field name * less than or equal to by appending `lte` to the field name `{field name}[|eq|lte|gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `gte` and `lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering on multiple fields `name__eq=myimage&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `name__in=fw-image1,fw-image2`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: total_count

    • Optional callback: function
        • Parameters

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareImageRetrieve

  • firmwareImageRetrieve(imageId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get an image Retrieve firmware image.

    Parameters

    • imageId: string

      The firmware image ID

    • Optional callback: function
        • (error: any, data?: FirmwareImage, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: FirmwareImage
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareManifestCreate

  • firmwareManifestCreate(datafile: any, name: string, description?: string, keyTable?: any, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a manifest Create firmware manifest.

    Parameters

    • datafile: any

      The manifest file to create. The API gateway enforces the account-specific file size.

    • name: string

      The name of the firmware manifest

    • Optional description: string

      The description of the firmware manifest

    • Optional keyTable: any

      The key table of pre-shared keys for devices

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: FirmwareManifest
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareManifestDestroy

  • firmwareManifestDestroy(manifestId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a manifest Delete firmware manifest.

    Parameters

    • manifestId: string

      The firmware manifest ID

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareManifestList

  • firmwareManifestList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List manifests List firmware manifests.

    Parameters

    • Optional limit: number

      How many firmware manifests to retrieve

    • Optional order: string

      ASC or DESC

    • Optional after: string

      The ID of the the item after which to retrieve the next page.

    • Optional filter: string

      URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:-------------:|:----------------:|:-------------:|:-------------:| | created_at | ✓ | ✓ | ✓ | | datafile | ✓ | ✓ | | | datafile_size | ✓ | ✓ | | | description | ✓ | ✓ | | | device_class | ✓ | ✓ | | | etag | ✓ | ✓ | ✓ | | id | ✓ | ✓ | | | name | ✓ | ✓ | | | timestamp | ✓ | ✓ | ✓ | | updated_at | ✓ | ✓ | ✓ | The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1eq=value1&key2__eq=value2&key3__eq=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` Filtering by properties `name__eq=mymanifest` Filtering on date-time fields Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `eq` to the field name * greater than or equal to by appending `gte` to the field name * less than or equal to by appending `lte` to the field name `{field name}[|eq|lte|gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `gte` and `lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering on multiple fields `name__eq=mymanifest&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `name__in=fw-manifest1,fw-manifest2`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: total_count

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

firmwareManifestRetrieve

  • firmwareManifestRetrieve(manifestId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get a manifest Retrieve firmware manifest.

    Parameters

    • manifestId: string

      The firmware manifest ID

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: FirmwareManifest
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getBillingReport

  • getBillingReport(month: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get billing report. Fetch generated billing report for the currently authenticated commercial non-subtenant account. Billing reports for subtenant accounts are included in their aggregator's billing report response.

    Parameters

    • month: string

      Queried year and month of billing report

    • Optional callback: function
        • (error: any, data?: ReportResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: ReportResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getBillingReportActiveDevices

  • getBillingReportActiveDevices(month: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get raw active devices billing data for the month. Fetch raw active devices billing data for the currently authenticated commercial non-subtenant account. They are supplementary data for billing report. The raw active devices billing data for subtenant accounts are included in their aggregator's raw active devices billing data. Endpoint returns the URL to download the gzipped csv file. First line of the file is the header which describes information of active devices included, e.g. active device id.

    Parameters

    • month: string

      Queried year and month of billing report

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getBillingReportFirmwareUpdates

  • getBillingReportFirmwareUpdates(month: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get raw firmware updates billing data for the month. Fetch raw firmware updates billing data for the currently authenticated commercial non-subtenant account. They are supplementary data for billing report. The raw firmware updates billing data for subtenant accounts are included in their aggregator's raw firmware updates billing data. Endpoint returns the URL to download the gzipped csv file. First line of the file is the header which describes information of firmware updates included, e.g. firmware update device id.

    Parameters

    • month: string

      Queried year and month of billing report

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getServicePackageQuota

  • getServicePackageQuota(callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Service package quota Get the available firmware update quota for the currently authenticated commercial acount.

    Parameters

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getServicePackageQuotaHistory

  • getServicePackageQuotaHistory(limit?: number, after?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Service package quota history Get your quota usage history. This API is available for commercial accounts. Aggregator accounts can see own and subtenant quota usage data. History data is ordered in ascending order based on the added timestamp.

    Parameters

    • Optional limit: number

      Maximum amount of quota history entries contained in one paged response.

    • Optional after: string

      To fetch after which quota history id. The results will contain entries after specified entry.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getServicePackages

  • getServicePackages(callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all service packages. Get information of all service packages for currently authenticated commercial account. The response is returned with descending order by service package created timestamp, listing first pending service package, then active service package, and previous service packages at last.

    Parameters

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

request

  • request<T>(options: object, callback?: function): superagent.SuperAgentRequest
  • Type parameters

    • T

    Parameters

    • options: object
      • acceptTypes: Array<string>
      • Optional body?: any
      • contentTypes: Array<string>
      • Optional file?: boolean
      • formParams: __type
      • headers: object
        • [key: string]: string
      • method: string
      • query: __type
      • Optional requestOptions?: object
        • [key: string]: any
      • url: string
      • useFormData: boolean
    • Optional callback: function
        • Parameters

          Returns any

    Returns superagent.SuperAgentRequest

updateCampaignCreate

  • updateCampaignCreate(campaign: UpdateCampaignPostRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a campaign Create an update campaign.

    Parameters

    • campaign: UpdateCampaignPostRequest

      Update campaign

    • Optional callback: function
        • (error: any, data?: UpdateCampaign, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdateCampaign
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignDestroy

  • updateCampaignDestroy(campaignId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a campaign Delete an update campaign.

    Parameters

    • campaignId: string

      The ID of the update campaign

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignList

  • updateCampaignList(limit?: number, order?: string, after?: string, filter?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List all campaigns Get update campaigns for devices specified by a filter.

    Parameters

    • Optional limit: number

      How many update campaigns to retrieve

    • Optional order: string

      The order of the records. Acceptable values: ASC, DESC. Default: ASC

    • Optional after: string

      The ID of the the item after which to retrieve the next page

    • Optional filter: string

      URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: | Field | = / eq / __neq | __in / __nin | __lte / __gte | |:----------------:|:----------------:|:-------------:|:-------------:| | created_at | ✓ | ✓ | ✓ | | description | ✓ | ✓ | | | device_filter | ✓ | ✓ | | | etag | ✓ | ✓ | ✓ | | finished | ✓ | ✓ | ✓ | | id | ✓ | ✓ | | | name | ✓ | ✓ | | | root_manifest_id | ✓ | ✓ | | | started_at | ✓ | ✓ | ✓ | | state | ✓ | ✓ | | | updated_at | ✓ | ✓ | ✓ | | when | ✓ | ✓ | ✓ | The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1eq=value1&key2__eq=value2&key3__eq=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` Filtering by campaign properties `state__eq=[draft|scheduled|devicefectch|devicecopy|publishing|deploying|deployed|manifestremoved|expired]` `root_manifest_id__eq=43217771234242e594ddb433816c498a` Filtering on date-time fields Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `eq` to the field name * greater than or equal to by appending `gte` to the field name * less than or equal to by appending `lte` to the field name `{field name}[|eq|lte|gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `gte` and `lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering on multiple fields `state__eq=deployed&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` Filtering with filter operators String field filtering supports the following operators: * equality: `eq` * non-equality: `neq` * in : `in` * not in: `nin` For `in` and `nin` filters list of parameters must be comma-separated: `name__in=fw-image1,fw-image2`

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: total_count

    • Optional callback: function
        • Parameters

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignMetadataList

  • updateCampaignMetadataList(campaignId: string, limit?: number, order?: string, after?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • List all campaign device metadata Get campaign device metadata.

    Parameters

    • campaignId: string

      The update campaign ID

    • Optional limit: number

      How many objects to retrieve in the page

    • Optional order: string

      ASC or DESC

    • Optional after: string

      The ID of the the item after which to retrieve the next page

    • Optional include: string

      Comma-separated list of data fields to return. Currently supported: total_count

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignMetadataRetrieve

  • updateCampaignMetadataRetrieve(campaignId: string, campaignDeviceMetadataId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get a campaign device metadata Get update campaign metadata.

    Parameters

    • campaignId: string

      The update campaign ID

    • campaignDeviceMetadataId: string

      The campaign device metadata ID

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignMetadataStop

  • updateCampaignMetadataStop(campaignId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Stop a running campaign Stop a running update campaign.

    Parameters

    • campaignId: string

      The campaign ID

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignRetrieve

  • updateCampaignRetrieve(campaignId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get a campaign. Get an update campaign.

    Parameters

    • campaignId: string

      The campaign ID

    • Optional callback: function
        • (error: any, data?: UpdateCampaign, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdateCampaign
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateCampaignUpdate

  • updateCampaignUpdate(campaignId: string, campaign: UpdateCampaignPutRequest, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Modify a campaign Modify an update campaign.

    Parameters

    • campaignId: string
    • campaign: UpdateCampaignPutRequest

      Update campaign

    • Optional callback: function
        • (error: any, data?: UpdateCampaign, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdateCampaign
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest