diff --git a/docs/Auth/index.html b/docs/Auth/index.html index 2d2f6ae..395313f 100644 --- a/docs/Auth/index.html +++ b/docs/Auth/index.html @@ -95,7 +95,7 @@

diff --git a/docs/AuthProvider/index.html b/docs/AuthProvider/index.html index 779be55..b8ca937 100644 --- a/docs/AuthProvider/index.html +++ b/docs/AuthProvider/index.html @@ -80,7 +80,7 @@

- + BasicAuthAuthenticator->AuthProvider @@ -95,7 +95,7 @@ - + OAuth2Authenticator->AuthProvider @@ -195,7 +195,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/BasicAuthAuthenticator/index.html b/docs/BasicAuthAuthenticator/index.html index 609ef7f..f8e1224 100644 --- a/docs/BasicAuthAuthenticator/index.html +++ b/docs/BasicAuthAuthenticator/index.html @@ -219,7 +219,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/BatteryStatusEvent/index.html b/docs/BatteryStatusEvent/index.html index 52daf46..550cd84 100644 --- a/docs/BatteryStatusEvent/index.html +++ b/docs/BatteryStatusEvent/index.html @@ -69,27 +69,27 @@

- + -Equatable +Decodable -Equatable +Decodable - + -BatteryStatusEvent->Equatable +BatteryStatusEvent->Decodable - + -Decodable +Equatable -Decodable +Equatable - + -BatteryStatusEvent->Decodable +BatteryStatusEvent->Equatable @@ -157,7 +157,7 @@

diff --git a/docs/CellularStatusEvent/index.html b/docs/CellularStatusEvent/index.html index 8b9bd8a..376219a 100644 --- a/docs/CellularStatusEvent/index.html +++ b/docs/CellularStatusEvent/index.html @@ -173,7 +173,7 @@

diff --git a/docs/CellularStatusEvent_ErrorMessage/index.html b/docs/CellularStatusEvent_ErrorMessage/index.html index 1e8190d..c37ea06 100644 --- a/docs/CellularStatusEvent_ErrorMessage/index.html +++ b/docs/CellularStatusEvent_ErrorMessage/index.html @@ -65,27 +65,27 @@

- + -Equatable +Decodable -Equatable +Decodable - - -CellularStatusEvent.ErrorMessage->Equatable + + +CellularStatusEvent.ErrorMessage->Decodable - + -Decodable +Equatable -Decodable +Equatable - - -CellularStatusEvent.ErrorMessage->Decodable + + +CellularStatusEvent.ErrorMessage->Equatable @@ -139,7 +139,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ConnectionStatusEvent/index.html b/docs/ConnectionStatusEvent/index.html index 4c3e7d9..5a47cdd 100644 --- a/docs/ConnectionStatusEvent/index.html +++ b/docs/ConnectionStatusEvent/index.html @@ -178,7 +178,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ConnectionStatusEvent_Available/index.html b/docs/ConnectionStatusEvent_Available/index.html index e6fc641..85aaa23 100644 --- a/docs/ConnectionStatusEvent_Available/index.html +++ b/docs/ConnectionStatusEvent_Available/index.html @@ -167,7 +167,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ConnectionStatusEvent_Connection/index.html b/docs/ConnectionStatusEvent_Connection/index.html index 61ae9ce..9c637dc 100644 --- a/docs/ConnectionStatusEvent_Connection/index.html +++ b/docs/ConnectionStatusEvent_Connection/index.html @@ -77,27 +77,27 @@

- + -Decodable +Equatable -Decodable +Equatable - - -ConnectionStatusEvent.Connection->Decodable + + +ConnectionStatusEvent.Connection->Equatable - + -Equatable +Decodable -Equatable +Decodable - - -ConnectionStatusEvent.Connection->Equatable + + +ConnectionStatusEvent.Connection->Decodable @@ -177,7 +177,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/DataConnector/index.html b/docs/DataConnector/index.html new file mode 100644 index 0000000..9383c90 --- /dev/null +++ b/docs/DataConnector/index.html @@ -0,0 +1,232 @@ + + + + + + Disruptive - DataConnector + + + +
+ + + Disruptive + + Documentation + + Beta +
+ + + + + +
+
+

+ Structure + Data​Connector +

+ +
public struct DataConnector: Decodable, Equatable
+
+

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend +to an external service. It can be set up to send specific types of events to a configurable endpoint through an +HTTP POST request.

+ +
+
+

To learn more about Data Connectors, see the following two articles on the developer website:

+ + + +
+
+ +
+ + + + + + +%3 + + + +DataConnector + + +DataConnector + + + + + +Equatable + +Equatable + + + +DataConnector->Equatable + + + + + +Decodable + +Decodable + + + +DataConnector->Decodable + + + + + + + + +
+

Nested Types

+
+
DataConnector.Metrics
+

Represents the metrics such as success-rate and latency for the past 3 hours of a Data Connector.

+
+
DataConnector.Status
+

The current status of a Data Connector. This will indicate whether or +not the Data Connector is currently sending out events.

+
+
DataConnector.PushType
+

The mechanism used by a Data Connector to push device events to an external service.

+
+
+

Conforms To

+
+
Decodable
+
Equatable
+
+
+
+

Initializers

+ +
+

+ init(from:​) +

+ 
public init(from decoder: Decoder) throws
+
+
+
+

Properties

+ +
+

+ identifier +

+ 
let identifier: String
+
+

The unique identifier of the Data Connector. This will be different from the REST API +in that it is just the identifier without the projects/*/dataconnectors/ prefix.

+ +
+
+
+

+ project​ID +

+ 
let projectID: String
+
+

The identifier of the project the Data Connector is in.

+ +
+
+
+

+ push​Type +

+ 
let pushType: PushType
+
+

Describes the mechanism for how to push events to an external service, with +configurable parameters. See more in the documentation for the type itself.

+ +
+
+
+

+ display​Name +

+ 
let displayName: String
+
+

The display name of the Data Connector.

+ +
+
+
+

+ status +

+ 
let status: Status
+
+

The current status of the Data Connector. This will indicate whether or +not the Data Connector is currently sending out events.

+ +
+
+
+

+ events +

+ 
let events: [EventType]
+
+

The event types that the Data Connector can send.

+ +
+
+
+

+ labels +

+ 
let labels: [String]
+
+

The labels that could be included along with an event (if the label is present +on the device the event comes from).

+ +
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc 1.0.0-beta.5. +

+
+ + diff --git a/docs/DataConnector_Metrics/index.html b/docs/DataConnector_Metrics/index.html new file mode 100644 index 0000000..21a407b --- /dev/null +++ b/docs/DataConnector_Metrics/index.html @@ -0,0 +1,134 @@ + + + + + + Disruptive - DataConnector.Metrics + + + +
+ + + Disruptive + + Documentation + + Beta +
+ + + + + +
+
+

+ Structure + Data​Connector.​Metrics +

+ +
public struct Metrics: Decodable, Equatable
+
+

Represents the metrics such as success-rate and latency for the past 3 hours of a Data Connector.

+ +
+
+ +
+ + + + + + +%3 + + + +DataConnector.Metrics + + +DataConnector.Metrics + + + + + +Decodable + +Decodable + + + +DataConnector.Metrics->Decodable + + + + + +Equatable + +Equatable + + + +DataConnector.Metrics->Equatable + + + + + + + + +
+

Member Of

+
+
DataConnector
+

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend +to an external service. It can be set up to send specific types of events to a configurable endpoint through an +HTTP POST request.

+
+
+

Conforms To

+
+
Decodable
+
Equatable
+
+
+
+

Initializers

+ +
+

+ init(from:​) +

+ 
public init(from decoder: Decoder) throws
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc 1.0.0-beta.5. +

+
+ + diff --git a/docs/DataConnector_PushType/index.html b/docs/DataConnector_PushType/index.html new file mode 100644 index 0000000..b3fae45 --- /dev/null +++ b/docs/DataConnector_PushType/index.html @@ -0,0 +1,147 @@ + + + + + + Disruptive - DataConnector.PushType + + + +
+ + + Disruptive + + Documentation + + Beta +
+ + + + + +
+
+

+ Enumeration + Data​Connector.​Push​Type +

+ +
public enum PushType
+
+

The mechanism used by a Data Connector to push device events to an external service.

+ +
+
+ +
+ + + + + + +%3 + + + +DataConnector.PushType + + +DataConnector.PushType + + + + + +Equatable + +Equatable + + + +DataConnector.PushType->Equatable + + + + + + + + +
+

Member Of

+
+
DataConnector
+

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend +to an external service. It can be set up to send specific types of events to a configurable endpoint through an +HTTP POST request.

+
+
+

Conforms To

+
+
Equatable
+
+
+
+

Enumeration Cases

+ +
+

+ http​Push +

+ 
case httpPush(url: String, signatureSecret: String, headers: [String: String])
+
+

This mechanism pushes device events to an external service using an HTTP POST request, and is +effectively a webhook.

+ +
+
+

An HTTP push Data Connector allows you to specify a signature secret that will be used to sign +each every event sent from the Data Connector. The signature will be included as a JWT in a header. +Read more about it in the Signing events section +of the Data Connectors article on the developer website.

+ +

Parameters:

+ +
    +
  • +

    url: The URL of the external service that the HTTP POST requests will be pushed to.

    +
    • +
  • +

    signatureSecret: Used to sign each event pushed from the Data Connector. See details above.

    +
    • +
  • +

    headers: Any additional headers that should be included with every event pushed from the Data Connector

    +
    • +
+ +
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc 1.0.0-beta.5. +

+
+ + diff --git a/docs/DataConnector_Status/index.html b/docs/DataConnector_Status/index.html new file mode 100644 index 0000000..643189c --- /dev/null +++ b/docs/DataConnector_Status/index.html @@ -0,0 +1,172 @@ + + + + + + Disruptive - DataConnector.Status + + + +
+ + + Disruptive + + Documentation + + Beta +
+ + + + + +
+
+

+ Enumeration + Data​Connector.​Status +

+ +
public enum Status
+
+

The current status of a Data Connector. This will indicate whether or +not the Data Connector is currently sending out events.

+ +
+
+ +
+ + + + + + +%3 + + + +DataConnector.Status + + +DataConnector.Status + + + + + +Equatable + +Equatable + + + +DataConnector.Status->Equatable + + + + + +Decodable + +Decodable + + + +DataConnector.Status->Decodable + + + + + + + + +
+

Member Of

+
+
DataConnector
+

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend +to an external service. It can be set up to send specific types of events to a configurable endpoint through an +HTTP POST request.

+
+
+

Conforms To

+
+
Decodable
+
Equatable
+
+
+
+

Initializers

+ +
+

+ init(from:​) +

+ 
public init(from decoder: Decoder) throws
+
+
+
+

Enumeration Cases

+ +
+

+ active +

+ 
case active
+
+

The Data Connector is currently active, and will push out events for the devices in the project +to an external service.

+ +
+
+
+

+ deactivated +

+ 
case deactivated
+
+

The Data Connector is deactivated. It can be reactivated by calling the updateDataConnector function.

+ +
+
+
+

+ system​Disabled +

+ 
case systemDisabled
+
+

The Data Connector will be set to this state by the system if it has received +too many errors recently, or if it keeps seeing errors for a prolonged period of time. +It can be reactivated by calling the updateDataConnector function.

+ +
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc 1.0.0-beta.5. +

+
+ + diff --git a/docs/Device/index.html b/docs/Device/index.html index 029672c..96b0bed 100644 --- a/docs/Device/index.html +++ b/docs/Device/index.html @@ -69,27 +69,27 @@

- + -Decodable +Equatable -Decodable +Equatable - - -Device->Decodable + + +Device->Equatable - + -Equatable +Decodable -Equatable +Decodable - - -Device->Equatable + + +Device->Decodable @@ -206,7 +206,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/DeviceEventStream/index.html b/docs/DeviceEventStream/index.html index 9b23af1..bb46c84 100644 --- a/docs/DeviceEventStream/index.html +++ b/docs/DeviceEventStream/index.html @@ -86,7 +86,7 @@

URLSessionDataDelegate - + DeviceEventStream->URLSessionDataDelegate @@ -98,7 +98,7 @@ NSObject - + DeviceEventStream->NSObject @@ -297,7 +297,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Device_DeviceType/index.html b/docs/Device_DeviceType/index.html index 9d32e62..0229a42 100644 --- a/docs/Device_DeviceType/index.html +++ b/docs/Device_DeviceType/index.html @@ -65,39 +65,39 @@

- + -Codable +String -Codable +String - + -Device.DeviceType->Codable +Device.DeviceType->String - + -String +CaseIterable -String +CaseIterable - + -Device.DeviceType->String +Device.DeviceType->CaseIterable - + -CaseIterable +Codable -CaseIterable +Codable - + -Device.DeviceType->CaseIterable +Device.DeviceType->Codable @@ -200,7 +200,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Device_ReportedEvents/index.html b/docs/Device_ReportedEvents/index.html index 051162a..78e672f 100644 --- a/docs/Device_ReportedEvents/index.html +++ b/docs/Device_ReportedEvents/index.html @@ -65,27 +65,27 @@

- + -Decodable +Equatable -Decodable +Equatable - - -Device.ReportedEvents->Decodable + + +Device.ReportedEvents->Equatable - + -Equatable +Decodable -Equatable +Decodable - - -Device.ReportedEvents->Equatable + + +Device.ReportedEvents->Decodable @@ -201,7 +201,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Disruptive/index.html b/docs/Disruptive/index.html index 5544d63..ae864c6 100644 --- a/docs/Disruptive/index.html +++ b/docs/Disruptive/index.html @@ -26,7 +26,7 @@ @@ -149,7 +149,408 @@

Methods

-
+
+

+ get​Data​Connectors(project​ID:​completion:​) +

+ 
public func getDataConnectors(projectID: String, completion: @escaping (_ result: Result<[DataConnector], DisruptiveError>) -> ())
+
+

Gets a list of Data Connectors that are available in a specific project.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project to get Data Connectors from.

+
completion@escaping (_ result:​ Result<[Data​Connector], Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain an array of DataConnectors. If a failure occurred, the .failure case will contain a DisruptiveError.

+
result

Result<[DataConnector], DisruptiveError>

+
+
+
+

+ get​Data​Connector(project​ID:​data​Connector​ID:​completion:​) +

+ 
public func getDataConnector(projectID: String, dataConnectorID: String, completion: @escaping (_ result: Result<DataConnector, DisruptiveError>) -> ())
+
+

Gets a specific Data Connector within a project by its identifier.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project to get the Data Connector from.

+
data​Connector​IDString

The identifier of the Data Connector to get within the specified project.

+
completion@escaping (_ result:​ Result<Data​Connector, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the DataConnector. If a failure occurred, the .failure case will contain a DisruptiveError.

+
result

Result<DataConnector, DisruptiveError>

+
+
+
+

+ create​Data​Connector(project​ID:​display​Name:​push​Type:​event​Types:​labels:​is​Active:​completion:​) +

+ 
public func createDataConnector(projectID: String, displayName: String, pushType: DataConnector.PushType, eventTypes: [EventType], labels: [String] = [], isActive: Bool = true, completion: @escaping (_ result: Result<DataConnector, DisruptiveError>) -> ())
+
+

Creates a new Data Connector. See the Data Connectors +guide on the developer website to learn more about how Data Connectors work, and how to +set up an external service to receive the events that are sent out by a Data Connector.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project to create the Data Connector in.

+
display​NameString

The display name to give the Data Connector.

+
push​TypeData​Connector.​Push​Type

The mechanism to use to push events to an external service. This will also include the parameters to configure the push mechanism.

+
event​Types[Event​Type]

The event types that the Data Connector will send to the external service.

+
labels[String]

The labels to be included along with the events. If a device that an event originates from has a label that is not included in this list, it will not be included in the event from the Data Connector. Note that if you want the display name of the device to be included in the events to the external service, you need to include the name label in this list. The default value of this parameter is an empty list, meaning no labels will be included.

+
is​ActiveBool

Whether or not the Data Connector should start in the active state. This can be changed later by calling the updateDataConnector function.

+
completion@escaping (_ result:​ Result<Data​Connector, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the DataConnector (along with its generated identifier). If a failure occurred, the .failure case will contain a DisruptiveError.

+
result

Result<DataConnector, DisruptiveError>

+
+
+
+

+ update​Data​Connector(project​ID:​data​Connector​ID:​display​Name:​http​Push:​is​Active:​event​Types:​labels:​completion:​) +

+ 
public func updateDataConnector(projectID: String, dataConnectorID: String, displayName: String? = nil, httpPush: (url: String?, signatureSecret: String?, headers: [String: String]?)? = nil, isActive: Bool? = nil, eventTypes: [EventType]? = nil, labels: [String]? = nil, completion: @escaping (_ result: Result<DataConnector, DisruptiveError>) -> ())
+
+

Updates the configuration of a Data Connector. Only the parameters that are set will be updated, and the remaining will be left unchanged.

+ +
+
+

Examples:

+ +
// Deactivates a Data Connector by only using the `active` parameter
+updateDataConnector(
+    projectID       : "<PROJECT_ID>",
+    dataConnectorID : "<DC_ID>",
+    active          : false)
+{ result in
+    ...
+}
+  
+// Updates the signature secret of a Data Connector, and nothing else
+updateDataConnector(
+    projectID       : "<PROJECT_ID>",
+    dataConnectorID : "<DC_ID>",
+    httpPush        : (url: nil, signatureSecret: "NEW_SECRET", headers: nil))
+{ result in
+    ...
+}
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project the Data Connector to update is in.

+
data​Connector​IDString

The identifier of the Data Connector to update.

+
display​NameString?

The new display name to use for the Data Connector. Will be ignored if not set (or nil). Defaults to nil.

+
http​Push(url:​ String?, signature​Secret:​ String?, headers:​ [String:​ String]?)?

The new configuration of the httpPush pushType. Only the non-nil tuple values will actually be set. Will be ignored the whole httpPush argument is not set (or nil). Defaults to nil.

+
is​ActiveBool?

The new active status of the Data Connector. Will be ignored if not set (or nil). Defaults to nil.

+
event​Types[Event​Type]?

The new list of event types the Data Connector will send out. Will be ignored if not set (or nil). Defaults to nil.

+
labels[String]?

The new labels that will be included for every event pushed to an external service by the Data Connector. Will be ignored if not set (or nil). Note: if you want the display name of the device to be included in the events to the external service, you need to include the name label in this list. The default value of this parameter is nil.

+
completion@escaping (_ result:​ Result<Data​Connector, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the DataConnector. If a failure occurred, the .failure case will contain a DisruptiveError.

+
result

Result<DataConnector, DisruptiveError>

+
+
+
+

+ delete​Data​Connector(project​ID:​data​Connector​ID:​completion:​) +

+ 
public func deleteDataConnector(projectID: String, dataConnectorID: String, completion: @escaping (_ result: Result<Void, DisruptiveError>) -> ())
+
+

Deletes a Data Connector.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project to delete the Data Connector from.

+
data​Connector​IDString

The identifier of the Data Connector to delete.

+
completion@escaping (_ result:​ Result<Void, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success result case is returned, otherwise a DisruptiveError is returned in the .failure case.

+
result

Result<Void, DisruptiveError>

+
+
+
+

+ get​Data​Connector​Metrics(project​ID:​data​Connector​ID:​completion:​) +

+ 
public func getDataConnectorMetrics(projectID: String, dataConnectorID: String, completion: @escaping (_ result: Result<DataConnector.Metrics, DisruptiveError>) -> ())
+
+

Retrieves the metrics for the past 3 hours for a Data Connector.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project to delete the Data Connector from.

+
data​Connector​IDString

The identifier of the Data Connector to delete.

+
completion@escaping (_ result:​ Result<Data​Connector.​Metrics, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the DataConnector.Metrics. If a failure occurred, the .failure case will contain a DisruptiveError.

+
result

Result<DataConnector.Metrics, DisruptiveError>

+
+
+
+

+ sync​Data​Connector(project​ID:​data​Connector​ID:​completion:​) +

+ 
public func syncDataConnector(projectID: String, dataConnectorID: String, completion: @escaping (_ result: Result<Void, DisruptiveError>) -> ())
+
+

Synchronizes a Data Connector with the external service. When this is called, the last known event for each event type of every device in the project will be re-pushed to the external service.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
project​IDString

The identifier of the project the Data Connector to synchronize is in.

+
data​Connector​IDString

The identifier of the Data Connector to synchronize.

+
completion@escaping (_ result:​ Result<Void, Disruptive​Error>) -> ()

The completion handler to be called when a response is received from the server. If successful, the .success result case is returned, otherwise a DisruptiveError is returned in the .failure case.

+
result

Result<Void, DisruptiveError>

+
+
+

get​Device(project​ID:​device​ID:​completion:​)

@@ -184,7 +585,7 @@

Parameters

completion @escaping (_ result:​ Result<Device, Disruptive​Error>) -> () -

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the Device. If a failure occured, the .failure case will contain a DisruptiveError.

+

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain the Device. If a failure occurred, the .failure case will contain a DisruptiveError.

@@ -225,7 +626,7 @@

Parameters

completion @escaping (_ result:​ Result<[Device], Disruptive​Error>) -> () -

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain an array of Devices. If a failure occured, the .failure case will contain a DisruptiveError.

+

The completion handler to be called when a response is received from the server. If successful, the .success case of the result will contain an array of Devices. If a failure occurred, the .failure case will contain a DisruptiveError.

@@ -1210,7 +1611,7 @@

Parameters

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/DisruptiveError/index.html b/docs/DisruptiveError/index.html index 0f57c5b..d238082 100644 --- a/docs/DisruptiveError/index.html +++ b/docs/DisruptiveError/index.html @@ -201,7 +201,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/EthernetStatusEvent/index.html b/docs/EthernetStatusEvent/index.html index 53f5bed..252b8a2 100644 --- a/docs/EthernetStatusEvent/index.html +++ b/docs/EthernetStatusEvent/index.html @@ -76,7 +76,7 @@

Decodable - + EthernetStatusEvent->Decodable @@ -88,7 +88,7 @@ Equatable - + EthernetStatusEvent->Equatable @@ -183,7 +183,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/EthernetStatusEvent_ErrorMessage/index.html b/docs/EthernetStatusEvent_ErrorMessage/index.html index 55a7c9f..b2adbad 100644 --- a/docs/EthernetStatusEvent_ErrorMessage/index.html +++ b/docs/EthernetStatusEvent_ErrorMessage/index.html @@ -139,7 +139,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/EventType/index.html b/docs/EventType/index.html index 16b031e..b162a00 100644 --- a/docs/EventType/index.html +++ b/docs/EventType/index.html @@ -65,51 +65,51 @@

- + -String +Decodable -String +Decodable - - -EventType->String + + +EventType->Decodable - + -Encodable +CaseIterable -Encodable +CaseIterable - - -EventType->Encodable + + +EventType->CaseIterable - + -CodingKey +String -CodingKey +String - - -EventType->CodingKey + + +EventType->String - + -CaseIterable +CodingKey -CaseIterable +CodingKey - - -EventType->CaseIterable + + +EventType->CodingKey @@ -123,7 +123,7 @@

Conforms To

CaseIterable
CodingKey
-
Encodable
+
Decodable
String
@@ -211,7 +211,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Events/index.html b/docs/Events/index.html index 4395fa3..05bd923 100644 --- a/docs/Events/index.html +++ b/docs/Events/index.html @@ -196,7 +196,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/HumidityEvent/index.html b/docs/HumidityEvent/index.html index 2d3e0d9..487de6a 100644 --- a/docs/HumidityEvent/index.html +++ b/docs/HumidityEvent/index.html @@ -168,7 +168,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/NetworkStatusEvent/index.html b/docs/NetworkStatusEvent/index.html index c04a798..45ea8a0 100644 --- a/docs/NetworkStatusEvent/index.html +++ b/docs/NetworkStatusEvent/index.html @@ -70,27 +70,27 @@

- + -Decodable +Equatable -Decodable +Equatable - + -NetworkStatusEvent->Decodable +NetworkStatusEvent->Equatable - + -Equatable +Decodable -Equatable +Decodable - + -NetworkStatusEvent->Equatable +NetworkStatusEvent->Decodable @@ -213,7 +213,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/NetworkStatusEvent_CloudConnector/index.html b/docs/NetworkStatusEvent_CloudConnector/index.html index 67cb8e7..7e04a52 100644 --- a/docs/NetworkStatusEvent_CloudConnector/index.html +++ b/docs/NetworkStatusEvent_CloudConnector/index.html @@ -72,7 +72,7 @@

Equatable - + NetworkStatusEvent.CloudConnector->Equatable @@ -84,7 +84,7 @@ Decodable - + NetworkStatusEvent.CloudConnector->Decodable @@ -164,7 +164,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/NetworkStatusEvent_TransmissionMode/index.html b/docs/NetworkStatusEvent_TransmissionMode/index.html index 0bb8810..7321ec0 100644 --- a/docs/NetworkStatusEvent_TransmissionMode/index.html +++ b/docs/NetworkStatusEvent_TransmissionMode/index.html @@ -67,39 +67,39 @@

- + -Decodable +String -Decodable +String - + -NetworkStatusEvent.TransmissionMode->Decodable +NetworkStatusEvent.TransmissionMode->String - + -Equatable +Decodable -Equatable +Decodable - - -NetworkStatusEvent.TransmissionMode->Equatable + + +NetworkStatusEvent.TransmissionMode->Decodable - + -String +Equatable -String +Equatable - - -NetworkStatusEvent.TransmissionMode->String + + +NetworkStatusEvent.TransmissionMode->Equatable @@ -155,7 +155,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/OAuth2Authenticator/index.html b/docs/OAuth2Authenticator/index.html index 7496e2d..9e7bcb5 100644 --- a/docs/OAuth2Authenticator/index.html +++ b/docs/OAuth2Authenticator/index.html @@ -246,7 +246,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ObjectPresentCountEvent/index.html b/docs/ObjectPresentCountEvent/index.html index f4a235d..856a8dc 100644 --- a/docs/ObjectPresentCountEvent/index.html +++ b/docs/ObjectPresentCountEvent/index.html @@ -78,7 +78,7 @@

Equatable - + ObjectPresentCountEvent->Equatable @@ -90,7 +90,7 @@ Decodable - + ObjectPresentCountEvent->Decodable @@ -159,7 +159,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ObjectPresentEvent/index.html b/docs/ObjectPresentEvent/index.html index 7cf8697..709daba 100644 --- a/docs/ObjectPresentEvent/index.html +++ b/docs/ObjectPresentEvent/index.html @@ -76,7 +76,7 @@

Decodable - + ObjectPresentEvent->Decodable @@ -88,7 +88,7 @@ Equatable - + ObjectPresentEvent->Equatable @@ -157,7 +157,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Organization/index.html b/docs/Organization/index.html index 5766942..5e944a6 100644 --- a/docs/Organization/index.html +++ b/docs/Organization/index.html @@ -147,7 +147,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Permission/index.html b/docs/Permission/index.html index 7a7681b..7e1239a 100644 --- a/docs/Permission/index.html +++ b/docs/Permission/index.html @@ -333,27 +333,27 @@

- + -String +Codable -String +Codable - - -Permission->String + + +Permission->Codable - + -Codable +String -Codable +String - - -Permission->Codable + + +Permission->String @@ -549,7 +549,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Project/index.html b/docs/Project/index.html index 727a070..84f3115 100644 --- a/docs/Project/index.html +++ b/docs/Project/index.html @@ -76,7 +76,7 @@

Equatable - + Project->Equatable @@ -88,7 +88,7 @@ Codable - + Project->Codable @@ -207,7 +207,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/Role/index.html b/docs/Role/index.html index b2b49ef..1f0e801 100644 --- a/docs/Role/index.html +++ b/docs/Role/index.html @@ -72,27 +72,27 @@

- + -Codable +Equatable -Codable +Equatable - + -Role->Codable +Role->Equatable - + -Equatable +Codable -Equatable +Codable - + -Role->Equatable +Role->Codable @@ -160,7 +160,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/ServiceAccount/index.html b/docs/ServiceAccount/index.html index e690870..1ffafd2 100644 --- a/docs/ServiceAccount/index.html +++ b/docs/ServiceAccount/index.html @@ -130,7 +130,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/TemperatureEvent/index.html b/docs/TemperatureEvent/index.html index 9f9bb7e..b42ad89 100644 --- a/docs/TemperatureEvent/index.html +++ b/docs/TemperatureEvent/index.html @@ -69,27 +69,27 @@

- + -Equatable +Decodable -Equatable +Decodable - - -TemperatureEvent->Equatable + + +TemperatureEvent->Decodable - + -Decodable +Equatable -Decodable +Equatable - - -TemperatureEvent->Decodable + + +TemperatureEvent->Equatable @@ -157,7 +157,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/TouchCountEvent/index.html b/docs/TouchCountEvent/index.html index 443b57c..5824943 100644 --- a/docs/TouchCountEvent/index.html +++ b/docs/TouchCountEvent/index.html @@ -70,27 +70,27 @@

- + -Equatable +Decodable -Equatable +Decodable - + -TouchCountEvent->Equatable +TouchCountEvent->Decodable - + -Decodable +Equatable -Decodable +Equatable - + -TouchCountEvent->Decodable +TouchCountEvent->Equatable @@ -158,7 +158,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/TouchEvent/index.html b/docs/TouchEvent/index.html index bf1f21b..83f41cf 100644 --- a/docs/TouchEvent/index.html +++ b/docs/TouchEvent/index.html @@ -70,27 +70,27 @@

- + -Decodable +Equatable -Decodable +Equatable - + -TouchEvent->Decodable +TouchEvent->Equatable - + -Equatable +Decodable -Equatable +Decodable - + -TouchEvent->Equatable +TouchEvent->Decodable @@ -148,7 +148,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/WaterPresentEvent/index.html b/docs/WaterPresentEvent/index.html index a2c20bc..6a13b40 100644 --- a/docs/WaterPresentEvent/index.html +++ b/docs/WaterPresentEvent/index.html @@ -77,7 +77,7 @@

Equatable - + WaterPresentEvent->Equatable @@ -89,7 +89,7 @@ Decodable - + WaterPresentEvent->Decodable @@ -158,7 +158,7 @@

- Generated on using swift-doc 1.0.0-beta.5. + Generated on using swift-doc 1.0.0-beta.5.

diff --git a/docs/index.html b/docs/index.html index 4cea8be..36f6679 100644 --- a/docs/index.html +++ b/docs/index.html @@ -240,6 +240,26 @@

Structures

Indicates an error related to connecting to the cellular network

+
+
+ + Data​Connector + +
+
+

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend +to an external service. It can be set up to send specific types of events to a configurable endpoint through an +HTTP POST request.

+ +
+
+ + Data​Connector.​Metrics + +
+
+

Represents the metrics such as success-rate and latency for the past 3 hours of a Data Connector.

+
@@ -346,6 +366,25 @@

Enumerations

An enumeration of all the possible types of events that a device can emit.

+
+
+ + Data​Connector.​Status + +
+
+

The current status of a Data Connector. This will indicate whether or +not the Data Connector is currently sending out events.

+ +
+
+ + Data​Connector.​Push​Type + +
+
+

The mechanism used by a Data Connector to push device events to an external service.

+
@@ -387,7 +426,7 @@

Protocols