iotdevprov

type APIClient struct {
	DeProvisioningApi *DeProvisioningApiService

	ProvisioningApi *ProvisioningApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

type CredentialSuite struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
	Type     string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error. Note: PSK is only supported in some protocol adapters. For details check the [Hub documentation](https://docs.bosch-iot-suite.com/hub/general-concepts/deviceauthentication.html)
	Secrets []OneOfsecretPsk `json:"secrets"`
}

type CredentialSuiteResponse struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
	Type     string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error. Note: PSK is only supported in some protocol adapters. For details check the [Hub documentation](https://docs.bosch-iot-suite.com/hub/general-concepts/deviceauthentication.html)
	Secrets []OneOfsecretPsk `json:"secrets"`
	// A list of protocol adapters that can be used with these credentials
	Adapters []CredentialSuiteResponseAllOfAdapters `json:"adapters,omitempty"`
}

type CredentialSuiteResponseAllOf struct {
	// A list of protocol adapters that can be used with these credentials
	Adapters []CredentialSuiteResponseAllOfAdapters `json:"adapters,omitempty"`
}

type CredentialSuiteResponseAllOfAdapters struct {
	// The protocol adapter type, e.g. http or mqtt
	Type string `json:"type,omitempty"`
	// The URI of the protocol adapter in the form of `scheme://host[:port]`
	Uri string `json:"uri,omitempty"`
	// The host of the protocol adapter
	Host string `json:"host,omitempty"`
	// The port of the protocol adapter
	Port int32 `json:"port,omitempty"`
}

type CredentialsBase struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
}

type DeProvisioningApiService service

type DeprovisioningResponsePayload struct {
	// A message describing the result of deleting the device resource.
	Device string `json:"device,omitempty"`
	// A message describing the result of deleting the credentials resource.
	Credentials string `json:"credentials,omitempty"`
	// A message describing the result of deleting the thing resource.
	Thing string `json:"thing,omitempty"`
	// A message describing the result of deleting the policy resource.
	Policy string `json:"policy,omitempty"`
}

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

type HashedPassword struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
	Type     string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error.
	Secrets []OneOfsecretHashsecretPasswordsecretPasswordBase64 `json:"secrets"`
}

type HashedPasswordAllOf struct {
	Type string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error.
	Secrets []OneOfsecretHashsecretPasswordsecretPasswordBase64 `json:"secrets"`
}

type HubResources struct {
	Device      RegistrationSuite `json:"device"`
	Credentials CredentialSuite   `json:"credentials,omitempty"`
}

type HubResponse struct {
	Device      RegistrationSuite       `json:"device,omitempty"`
	Credentials CredentialSuiteResponse `json:"credentials,omitempty"`
}

type Provisioning400ErrorPayload struct {
	// A message describing the cause.
	Description string `json:"description,omitempty"`
	// An arbitrary JSON object representing the error.
	ErrorDetails map[string]interface{} `json:"errorDetails,omitempty"`
}

type ProvisioningApiService service

type ProvisioningRequestPayload struct {
	Id     string          `json:"id"`
	Hub    HubResources    `json:"hub"`
	Things ThingsResources `json:"things"`
}

type ProvisioningResponsePayload struct {
	Id     string          `json:"id,omitempty"`
	Hub    HubResponse     `json:"hub,omitempty"`
	Things ThingsResources `json:"things,omitempty"`
}

type Psk struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
	Type     string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error. Note: PSK is only supported in some protocol adapters. For details check the [Hub documentation](https://docs.bosch-iot-suite.com/hub/general-concepts/deviceauthentication.html)
	Secrets []OneOfsecretPsk `json:"secrets"`
}

type PskAllOf struct {
	Type string `json:"type"`
	// A list of secrets scoped to a particular time period. This array must contain at least one element - an empty array is handled as an error. Note: PSK is only supported in some protocol adapters. For details check the [Hub documentation](https://docs.bosch-iot-suite.com/hub/general-concepts/deviceauthentication.html)
	Secrets []OneOfsecretPsk `json:"secrets"`
}

type RegistrationSuite struct {
	DeviceId string `json:"deviceId,omitempty"`
	Enabled  bool   `json:"enabled,omitempty"`
	// Gateway Device that is allowed to send messages on behalf of the device.
	Via      string                    `json:"via,omitempty"`
	Defaults RegistrationSuiteDefaults `json:"defaults,omitempty"`
}

type RegistrationSuiteDefaults struct {
	// The content-type to use for northbound messages published by this device. This can be useful for protocols like MQTT where the content-type cannot be set directly in a message. The content-type is specified in RFC-2046. Example value: 'application/json'
	ContentType string `json:"content-type,omitempty"`
	// The content-encoding can be set optionally in addition to the content-type. It defines what additional content encodings have to be applied to the message content to receive the media-type referenced by the content-type. The main usage of the content-encoding is to allow compression without losing information about the compressed data type. The content-encoding is specified in section 3.5 of RFC 2616.
	ContentEncoding string `json:"content-encoding,omitempty"`
	// The time-to-live (in seconds) to use for events published by this device. This value is limited by the booked service plan's event storage time.
	Ttl int32 `json:"ttl,omitempty"`
}

type SecretCertificate struct {
	// The point in time from which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotBefore string `json:"notBefore,omitempty"`
	// The point in time until which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotAfter string `json:"notAfter,omitempty"`
}

type SecretHash struct {
	// The point in time from which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotBefore string `json:"notBefore,omitempty"`
	// The point in time until which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotAfter string `json:"notAfter,omitempty"`
	// __DEPRECATED!__ The Base64 encoded bytes representing the hashed password. The password hash MUST be computed by applying the hash function to the byte array consisting of the salt bytes (if a salt is used) and the UTF-8 encoding of the clear text password.
	PwdHash string `json:"pwdHash"`
	// __DEPRECATED!__ The Base64 encoded bytes used as salt for the password hash. If not set then the password hash has been created without salt.
	Salt string `json:"salt,omitempty"`
	// __DEPRECATED!__ The name of the hash function used to create the password hash. At the moment sha-256 and sha-512 are supported.
	HashFunction string `json:"hashFunction"`
}

type SecretPassword struct {
	// The point in time from which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotBefore string `json:"notBefore,omitempty"`
	// The point in time until which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotAfter string `json:"notAfter,omitempty"`
	// Plaintext password. Will be salted and hashed by Bosch IoT Hub.
	Password string `json:"password"`
}

type SecretPasswordBase64 struct {
	// The point in time from which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotBefore string `json:"notBefore,omitempty"`
	// The point in time until which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotAfter string `json:"notAfter,omitempty"`
	// Plaintext base64 encoded password. Will be salted and hashed by Bosch IoT Hub.
	PasswordBase64 string `json:"passwordBase64"`
}

type SecretPsk struct {
	// The point in time from which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotBefore string `json:"notBefore,omitempty"`
	// The point in time until which the secret may be used to authenticate devices. This is optional and can be ignored if the validity period is the same as the period indicated by the client certificate’s corresponding properties. If not null, the value MUST be an ISO 8601 compliant combined date and time representation.
	NotAfter string `json:"notAfter,omitempty"`
	// The Base64 encoded bytes representing the shared (secret) key.
	Key string `json:"key"`
}

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

type ServiceInstanceIdDevicesDeviceIdDeleteOpts struct {
	KeepCredentials optional.Bool
	KeepPolicy      optional.Bool
}

type ServiceInstanceIdDevicesPostOpts struct {
	AuthScope                  optional.String
	SkipVorto                  optional.Bool
	ProvisioningRequestPayload optional.Interface
}

type ThingsResources struct {
	// Data structure for creating a Thing in Bosch IoT Things. For details, see `Create a new Thing` at the [Bosch IoT Things Http API Documentation](https://apidocs.bosch-iot-suite.com/index.html?urls.primaryName=Bosch%20IoT%20Things%20-%20API%20v2). Note that in contrast to direct usage of the Things API, the `id` will not be generated, but will be set to the one specified in the request's ProvisioningRequestPayload. If set, it must match the one from the request's ProvisioningRequestPayload. Note that a Vorto model can be used to to define the capabilities of a Thing. To include the capabilities of a Vorto model, the fully qualified name (in the form namespace:name:version) of the model must be set in the 'definition' field of the Thing. The model is then retrieved from the official Eclipse Vorto repository and its capabilities are automatically added to the Thing. Note that each Thing requires a Policy which defines its access control. You can specify the Policy for a Thing in three different ways:  * use a generated Policy (recommended): per default, the Device Provisioning Service creates a Policy for  you (which covers standard usage scenarios)  * use an existing Policy: specify `policyId` appropriately  * define your own Policy: define the Policy as an Inline-Policy (field `_policy`)  The generated Policy contains two entries:  * `DEFAULT`: Defines access for the Provisioner (the one who provisions the device with this API). It  provides full `READ` and `WRITE` access to the Thing, Messages and the Policy itself.  * `DEVICE`: Defines access control for the connectivity of the device. It provides full `READ` and `WRITE`  access to the Thing and Messages, but not to the Policy itself.  “` {   \"policyId\": \"<<provisioningRequestPayload.id>>\",   \"entries\": {       \"DEFAULT\": {         \"subjects\": {           \"{{ request:subjectId }}\": { \"type\": \"suite-auth\" }         },         \"resources\": {           \"thing:/\":   { \"grant\": [\"READ\", \"WRITE\"], \"revoke\": [] },           \"message:/\": { \"grant\": [\"READ\", \"WRITE\"], \"revoke\": [] },           \"policy:/\":  { \"grant\": [\"READ\", \"WRITE\"], \"revoke\": [] }         }       },       \"DEVICE\": {         \"subjects\": {           \"integration:{{ request:solutionId }}:hub\": {             \"type\": \"iot-things-integration\"           }         },         \"resources\": {           \"thing:/\":   { \"grant\": [\"READ\", \"WRITE\"], \"revoke\": [] },           \"message:/\": { \"grant\": [\"READ\", \"WRITE\"], \"revoke\": [] }         }       }   } } “`
	Thing map[string]interface{} `json:"thing"`
}

type X509Cert struct {
	// The identity that the device should be authenticated as.
	AuthId string `json:"authId,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer. This may e.g. be used to disable a particular mechanism for authenticating the device.
	Enabled bool `json:"enabled,omitempty"`
	// The ID of the device to which the credentials belong.
	DeviceId string `json:"deviceId,omitempty"`
	Type     string `json:"type"`
	// A list of secrets scoped to a particular time period.
	Secrets []OneOfsecretCertificate `json:"secrets"`
}

type X509CertAllOf struct {
	Type string `json:"type"`
	// A list of secrets scoped to a particular time period.
	Secrets []OneOfsecretCertificate `json:"secrets"`
}