diff --git a/paas/docs/CfReprocessingJobConfiguration.md b/paas/docs/CfReprocessingJobConfiguration.md index 2bf41cff..d4edac26 100644 --- a/paas/docs/CfReprocessingJobConfiguration.md +++ b/paas/docs/CfReprocessingJobConfiguration.md @@ -37,9 +37,59 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + --- ### Conventions diff --git a/paas/docs/CfReprocessingJobResult.md b/paas/docs/CfReprocessingJobResult.md index 1370a065..c831e272 100644 --- a/paas/docs/CfReprocessingJobResult.md +++ b/paas/docs/CfReprocessingJobResult.md @@ -14,6 +14,8 @@ ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entity_type: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobResult | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -38,6 +40,59 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) + --- ### Conventions diff --git a/paas/docs/DeviceProfile.md b/paas/docs/DeviceProfile.md index 8ee5bf75..4601bdeb 100644 --- a/paas/docs/DeviceProfile.md +++ b/paas/docs/DeviceProfile.md @@ -157,6 +157,70 @@ A JSON value representing the device profile. |------|------|-------------|-------| | security_mode | str | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -242,7 +306,7 @@ A JSON value representing the device profile. | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/paas/docs/DeviceProfileData.md b/paas/docs/DeviceProfileData.md index db18d333..6d740255 100644 --- a/paas/docs/DeviceProfileData.md +++ b/paas/docs/DeviceProfileData.md @@ -118,6 +118,70 @@ |------|------|-------------|-------| | security_mode | str | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -203,7 +267,7 @@ | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/paas/docs/DeviceProfileTransportConfiguration.md b/paas/docs/DeviceProfileTransportConfiguration.md index 66fa9fe0..84499ea8 100644 --- a/paas/docs/DeviceProfileTransportConfiguration.md +++ b/paas/docs/DeviceProfileTransportConfiguration.md @@ -89,6 +89,70 @@ Configuration for device profile transport |------|------|-------------|-------| | security_mode | str | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -174,7 +238,7 @@ Configuration for device profile transport | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### SnmpCommunicationSpec (enum) `TELEMETRY_QUERYING` | `CLIENT_ATTRIBUTES_QUERYING` | `SHARED_ATTRIBUTES_SETTING` | `TO_DEVICE_RPC_REQUEST` | `TO_SERVER_RPC_REQUEST` diff --git a/paas/docs/DummyJobConfiguration.md b/paas/docs/DummyJobConfiguration.md index f531323f..c1b0ca27 100644 --- a/paas/docs/DummyJobConfiguration.md +++ b/paas/docs/DummyJobConfiguration.md @@ -25,6 +25,8 @@ Dummy job configuration ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entity_type: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -42,6 +44,59 @@ Dummy job configuration | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) + --- ### Conventions diff --git a/paas/docs/DummyJobResult.md b/paas/docs/DummyJobResult.md index 65dba3ae..4e2d079f 100644 --- a/paas/docs/DummyJobResult.md +++ b/paas/docs/DummyJobResult.md @@ -14,6 +14,8 @@ ## Referenced Types +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entity_type: EntityType, id: UUID}` — all EntityId subtypes share this structure. + #### JobResult | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -38,6 +40,59 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) + --- ### Conventions diff --git a/paas/docs/Job.md b/paas/docs/Job.md index 830e9747..0f503f2b 100644 --- a/paas/docs/Job.md +++ b/paas/docs/Job.md @@ -111,6 +111,21 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -163,6 +178,19 @@ | user_id | UserId | | | | owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/paas/docs/JobConfiguration.md b/paas/docs/JobConfiguration.md index 8fc494bf..5a6612f8 100644 --- a/paas/docs/JobConfiguration.md +++ b/paas/docs/JobConfiguration.md @@ -65,6 +65,21 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -149,6 +164,32 @@ | all_enabled | bool | Debug All. Used as a trigger for updating debugAllUntil. | [optional] | | all_enabled_until | int | Timestamp of the end time for the processing debug events. | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + #### NotificationType (enum) `GENERAL` | `ALARM` | `DEVICE_ACTIVITY` | `ENTITY_ACTION` | `ALARM_COMMENT` | `RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT` | `ALARM_ASSIGNMENT` | `NEW_PLATFORM_VERSION` | `ENTITIES_LIMIT` | `ENTITIES_LIMIT_INCREASE_REQUEST` | … (24 values total) @@ -161,6 +202,9 @@ | user_id | UserId | | [optional] | | timezone | str | | [optional] | +#### TbReportFormat (enum) +`PDF` | `CSV` + #### DeliveryMethodNotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/paas/docs/JobResult.md b/paas/docs/JobResult.md index f83ff74a..e1d506e2 100644 --- a/paas/docs/JobResult.md +++ b/paas/docs/JobResult.md @@ -49,6 +49,21 @@ Job execution result | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### Report | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -65,9 +80,28 @@ Job execution result #### TbReportFormat (enum) `PDF` | `CSV` +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + --- ### Conventions diff --git a/paas/docs/LwM2MBootstrapServerCredential.md b/paas/docs/LwM2MBootstrapServerCredential.md index 7d91ad50..70ea4d5a 100644 --- a/paas/docs/LwM2MBootstrapServerCredential.md +++ b/paas/docs/LwM2MBootstrapServerCredential.md @@ -11,6 +11,72 @@ +## Subtypes + +#### NoSecLwM2MBootstrapServerCredential *(security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + --- ### Conventions diff --git a/paas/docs/Lwm2mDeviceProfileTransportConfiguration.md b/paas/docs/Lwm2mDeviceProfileTransportConfiguration.md index 00bf6ef5..5ca85a90 100644 --- a/paas/docs/Lwm2mDeviceProfileTransportConfiguration.md +++ b/paas/docs/Lwm2mDeviceProfileTransportConfiguration.md @@ -39,6 +39,70 @@ |------|------|-------------|-------| | security_mode | str | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -71,7 +135,7 @@ | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/paas/docs/PageDataDeviceProfile.md b/paas/docs/PageDataDeviceProfile.md index 88cb5cf6..79bc3e10 100644 --- a/paas/docs/PageDataDeviceProfile.md +++ b/paas/docs/PageDataDeviceProfile.md @@ -163,6 +163,70 @@ |------|------|-------------|-------| | security_mode | str | | | +#### NoSecLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`NO_SEC`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### PSKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`PSK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### RPKLwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`RPK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + +#### X509LwM2MBootstrapServerCredential *(extends LwM2MBootstrapServerCredential, security_mode=`X509`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| short_server_id | int | Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server. | [optional] [readonly] | +| bootstrap_server_is | bool | Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified. | [optional] [readonly] | +| host | str | Host for 'No Security' mode | [optional] [readonly] | +| port | int | Port for Lwm2m Server: 'No Security' mode: Lwm2m Server or Bootstrap Server | [optional] [readonly] | +| client_hold_off_time | int | Client Hold Off Time. The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. (This information is relevant for use with a Bootstrap-Server only.) | [optional] [readonly] | +| server_public_key | str | Server Public Key for 'Security' mode (DTLS): RPK or X509. Format: base64 encoded | [optional] [readonly] | +| server_certificate | str | Server Public Key for 'Security' mode (DTLS): X509. Format: base64 encoded | [optional] [readonly] | +| bootstrap_server_account_timeout | int | Bootstrap Server Account Timeout (If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.) | [optional] [readonly] | +| lifetime | int | Specify the lifetime of the registration in seconds. | [optional] [readonly] | +| default_min_period | int | The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. If this Resource doesn’t exist, the default value is 0. | [optional] [readonly] | +| notif_if_disabled | bool | If true, the LwM2M Client stores “Notify” operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored “Notify” operations to the Server. If false, the LwM2M Client discards all the “Notify” operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. The default value is true. | [optional] [readonly] | +| binding | str | This Resource defines the transport binding configured for the LwM2M Client. If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode. | [optional] [readonly] | + #### OtherConfiguration | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -248,7 +312,7 @@ | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### PowerMode (enum) `PSM` | `DRX` | `E_DRX` diff --git a/paas/docs/PageDataJob.md b/paas/docs/PageDataJob.md index 92cf0355..689357d1 100644 --- a/paas/docs/PageDataJob.md +++ b/paas/docs/PageDataJob.md @@ -119,6 +119,21 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationRequest | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -171,6 +186,19 @@ | user_id | UserId | | | | owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/paas/docs/ReportJobConfiguration.md b/paas/docs/ReportJobConfiguration.md index b524e79f..a620a257 100644 --- a/paas/docs/ReportJobConfiguration.md +++ b/paas/docs/ReportJobConfiguration.md @@ -83,6 +83,21 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### NotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -140,6 +155,32 @@ | user_id | UserId | | [optional] | | timezone | str | | [optional] | +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + #### DeliveryMethodNotificationTemplate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -177,6 +218,9 @@ | subject | str | Subject line for the web notification | | | additional_config | object | Additional JSON configuration for web buttons/actions | [optional] | +#### TbReportFormat (enum) +`PDF` | `CSV` + #### Button | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/paas/docs/ReportJobResult.md b/paas/docs/ReportJobResult.md index 052386e9..4b0bb534 100644 --- a/paas/docs/ReportJobResult.md +++ b/paas/docs/ReportJobResult.md @@ -54,12 +54,46 @@ | error | str | | [optional] | | job_type | str | | | +#### CfReprocessingTaskResult *(extends TaskResult, job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(extends TaskResult, job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(extends TaskResult, job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + #### TbReportFormat (enum) `PDF` | `CSV` #### EntityType (enum) `TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + --- ### Conventions diff --git a/paas/docs/TaskResult.md b/paas/docs/TaskResult.md index c57060b4..c9371c88 100644 --- a/paas/docs/TaskResult.md +++ b/paas/docs/TaskResult.md @@ -16,6 +16,65 @@ +## Subtypes + +#### CfReprocessingTaskResult *(job_type=`CF_REPROCESSING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | CfReprocessingTaskFailure | | [optional] | + +#### DummyTaskResult *(job_type=`DUMMY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failure | DummyTaskFailure | | [optional] | + +#### ReportTaskResult *(job_type=`REPORT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| report | Report | | [optional] | + +## Referenced Types + +> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entity_type: EntityType, id: UUID}` — all EntityId subtypes share this structure. + +#### CfReprocessingTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| entity_info | EntityInfo | | [optional] | + +#### DummyTaskFailure +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| error | str | | [optional] | +| number | int | | [optional] | +| fail_always | bool | | [optional] | + +#### Report +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | ReportId | | [optional] | +| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] | +| tenant_id | TenantId | | | +| customer_id | CustomerId | | [optional] | +| template_id | ReportTemplateId | | | +| format | TbReportFormat | | | +| name | str | | | +| user_id | UserId | | | +| owner_id | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] | + +#### EntityInfo +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| id | EntityId | JSON object with the entity Id. | [optional] | +| name | str | Entity Name | [optional] | + +#### TbReportFormat (enum) +`PDF` | `CSV` + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total) + --- ### Conventions diff --git a/paas/docs/TelemetryMappingConfiguration.md b/paas/docs/TelemetryMappingConfiguration.md index 61894802..dc3eb403 100644 --- a/paas/docs/TelemetryMappingConfiguration.md +++ b/paas/docs/TelemetryMappingConfiguration.md @@ -36,7 +36,7 @@ | epmax | int | | [optional] | #### TelemetryObserveStrategy (enum) -`SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` | `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` | `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` +`SINGLE` | `COMPOSITE_ALL` | `COMPOSITE_BY_OBJECT` #### LwM2mVersion | Name | Type | Description | Notes | diff --git a/paas/docs/TelemetryObserveStrategy.md b/paas/docs/TelemetryObserveStrategy.md index 6130bc50..ea047c6c 100644 --- a/paas/docs/TelemetryObserveStrategy.md +++ b/paas/docs/TelemetryObserveStrategy.md @@ -3,14 +3,16 @@ `tb_paas_client.models.TelemetryObserveStrategy` +Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object. + ## Enum Values -* `SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST` (value: `'SINGLE (0): One resource equals one single observe request'`) +* `SINGLE` (value: `'SINGLE'`) -* `COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST` (value: `'COMPOSITE_ALL (1): All resources in one composite observe request'`) +* `COMPOSITE_ALL` (value: `'COMPOSITE_ALL'`) -* `COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT` (value: `'COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object'`) +* `COMPOSITE_BY_OBJECT` (value: `'COMPOSITE_BY_OBJECT'`) diff --git a/paas/spec/openapi.json b/paas/spec/openapi.json index 82286076..b5fdbc77 100644 --- a/paas/spec/openapi.json +++ b/paas/spec/openapi.json @@ -16,7 +16,7 @@ }, "servers": [ { - "url": "http://localhost:39647", + "url": "http://localhost:34449", "description": "Generated server url" } ], @@ -138445,7 +138445,25 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "CF_REPROCESSING", + "failure": { + "error": null, + "entityInfo": { + "id": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "name": null + } + } + } }, "CfReprocessingValidationResult": { "type": "object", @@ -142538,7 +142556,20 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "DUMMY", + "failure": { + "error": null, + "number": null, + "failAlways": null + } + } }, "DurationAlarmCondition": { "allOf": [ @@ -147930,7 +147961,28 @@ }, "LwM2MBootstrapServerCredential": { "discriminator": { - "propertyName": "securityMode" + "propertyName": "securityMode", + "mapping": { + "NO_SEC": "#/components/schemas/NoSecLwM2MBootstrapServerCredential", + "PSK": "#/components/schemas/PSKLwM2MBootstrapServerCredential", + "RPK": "#/components/schemas/RPKLwM2MBootstrapServerCredential", + "X509": "#/components/schemas/X509LwM2MBootstrapServerCredential" + } + }, + "example": { + "securityMode": "NO_SEC", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" }, "properties": { "securityMode": { @@ -149274,7 +149326,22 @@ } } } - ] + ], + "example": { + "securityMode": "NO_SEC", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "NodeConnectionInfo": { "type": "object", @@ -151318,7 +151385,22 @@ } } } - ] + ], + "example": { + "securityMode": "PSK", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "PageBreakComponent": { "allOf": [ @@ -154210,7 +154292,22 @@ } } } - ] + ], + "example": { + "securityMode": "RPK", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "RateLimitsNotificationRuleTriggerConfig": { "allOf": [ @@ -155297,7 +155394,44 @@ } } } - ] + ], + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "REPORT", + "report": { + "id": { + "entityType": "REPORT", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "createdTime": 1746028547220, + "tenantId": { + "entityType": "TENANT", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "customerId": { + "entityType": "CUSTOMER", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "templateId": { + "entityType": "REPORT_TEMPLATE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "format": {}, + "name": null, + "userId": { + "entityType": "USER", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "ownerId": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + } + } + } }, "ReportTemplate": { "type": "object", @@ -159405,7 +159539,30 @@ "TaskResult": { "type": "object", "discriminator": { - "propertyName": "jobType" + "propertyName": "jobType", + "mapping": { + "CF_REPROCESSING": "#/components/schemas/CfReprocessingTaskResult", + "REPORT": "#/components/schemas/ReportTaskResult", + "DUMMY": "#/components/schemas/DummyTaskResult" + } + }, + "example": { + "key": null, + "success": null, + "discarded": null, + "finishTs": null, + "error": null, + "jobType": "CF_REPROCESSING", + "failure": { + "error": null, + "entityInfo": { + "id": { + "entityType": "DEVICE", + "id": "784f394c-42b6-435a-983c-b7beff2784f9" + }, + "name": null + } + } }, "properties": { "key": { @@ -159915,10 +160072,11 @@ }, "TelemetryObserveStrategy": { "type": "string", + "description": "Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object.", "enum": [ - "SINGLE (0): One resource equals one single observe request", - "COMPOSITE_ALL (1): All resources in one composite observe request", - "COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object" + "SINGLE", + "COMPOSITE_ALL", + "COMPOSITE_BY_OBJECT" ] }, "TelemetryQueryingSnmpCommunicationConfig": { @@ -163797,7 +163955,22 @@ } } } - ] + ], + "example": { + "securityMode": "X509", + "shortServerId": 123, + "bootstrapServerIs": true, + "host": "0.0.0.0", + "port": "'5685' or '5687'", + "clientHoldOffTime": 1, + "serverPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", + "serverCertificate": "MMIICODCCAd6gAwIBAgIUI88U1zowOdrxDK/dOV+36gJxI2MwCgYIKoZIzj0EAwIwejELMAkGA1UEBhMCVUs\nxEjAQBgNVBAgTCUt5aXYgY2l0eTENMAsGA1UEBxMES3lpdjEUMBIGA1UEChMLVGhpbmdzYm9hcmQxFzAVBgNVBAsMDkRFVkVMT1BFUl9URVNUMRkwFwYDVQQDDBBpbnRlcm1lZGlhdGVfY2EwMB4XDTIyMDEwOTEzMDMwMFoXDTI3MDEwODEzMDMwMFowFDESMBAGA1UEAxM\nJbG9jYWxob3N0MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUO3vBo/JTv0eooY7XHiKAIVDoWKFqtrU7C6q8AIKqpLcqhCdW+haFeBOH3PjY6EwaWkY04Bir4oanU0s7tz2uKOBpzCBpDAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/\nBAIwADAdBgNVHQ4EFgQUEjc3Q4a0TxzP/3x3EV4fHxYUg0YwHwYDVR0jBBgwFoAUuSquGycMU6Q0SYNcbtSkSD3TfH0wLwYDVR0RBCgwJoIVbG9jYWxob3N0LmxvY2FsZG9tYWlugglsb2NhbGhvc3SCAiAtMAoGCCqGSM49BAMCA0gAMEUCIQD7dbZObyUaoDiNbX+9fUNp\nAWrD7N7XuJUwZ9FcN75R3gIgb2RNjDkHoyUyF1YajwkBk+7XmIXNClmizNJigj908mw=", + "bootstrapServerAccountTimeout": 0, + "lifetime": 300, + "defaultMinPeriod": 1, + "notifIfDisabled": true, + "binding": "U" + } }, "YearInterval": { "allOf": [ diff --git a/paas/tb_paas_client/configuration.py b/paas/tb_paas_client/configuration.py index 52c01278..2ed558f1 100644 --- a/paas/tb_paas_client/configuration.py +++ b/paas/tb_paas_client/configuration.py @@ -227,7 +227,7 @@ def __init__( ) -> None: """Constructor """ - self._base_path = "http://localhost:39647" if host is None else host + self._base_path = "http://localhost:34449" if host is None else host """Default Base url """ self.server_index = 0 if server_index is None and host is None else server_index @@ -560,7 +560,7 @@ def get_host_settings(self) -> List[HostSetting]: """ return [ { - 'url': "http://localhost:39647", + 'url': "http://localhost:34449", 'description': "Generated server url", } ] diff --git a/paas/tb_paas_client/models/cf_reprocessing_task_result.py b/paas/tb_paas_client/models/cf_reprocessing_task_result.py index 3036befd..b4afc5f7 100644 --- a/paas/tb_paas_client/models/cf_reprocessing_task_result.py +++ b/paas/tb_paas_client/models/cf_reprocessing_task_result.py @@ -21,7 +21,7 @@ import re # noqa: F401 import json -from pydantic import ConfigDict +from pydantic import ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from tb_paas_client.models.cf_reprocessing_task_failure import CfReprocessingTaskFailure from tb_paas_client.models.task_result import TaskResult @@ -32,6 +32,7 @@ class CfReprocessingTaskResult(TaskResult): """ CfReprocessingTaskResult """ # noqa: E501 + job_type: StrictStr = Field(default="CF_REPROCESSING", serialization_alias="jobType") # post_process: discriminator default failure: Optional[CfReprocessingTaskFailure] = None __properties: ClassVar[List[str]] = ["key", "success", "discarded", "finishTs", "error", "jobType", "failure"] diff --git a/paas/tb_paas_client/models/dummy_task_result.py b/paas/tb_paas_client/models/dummy_task_result.py index b3e4fe1e..cf8c73b8 100644 --- a/paas/tb_paas_client/models/dummy_task_result.py +++ b/paas/tb_paas_client/models/dummy_task_result.py @@ -21,7 +21,7 @@ import re # noqa: F401 import json -from pydantic import ConfigDict +from pydantic import ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from tb_paas_client.models.dummy_task_failure import DummyTaskFailure from tb_paas_client.models.task_result import TaskResult @@ -32,6 +32,7 @@ class DummyTaskResult(TaskResult): """ DummyTaskResult """ # noqa: E501 + job_type: StrictStr = Field(default="DUMMY", serialization_alias="jobType") # post_process: discriminator default failure: Optional[DummyTaskFailure] = None __properties: ClassVar[List[str]] = ["key", "success", "discarded", "finishTs", "error", "jobType", "failure"] diff --git a/paas/tb_paas_client/models/lw_m2_m_bootstrap_server_credential.py b/paas/tb_paas_client/models/lw_m2_m_bootstrap_server_credential.py index 4eacfea7..5dbadc02 100644 --- a/paas/tb_paas_client/models/lw_m2_m_bootstrap_server_credential.py +++ b/paas/tb_paas_client/models/lw_m2_m_bootstrap_server_credential.py @@ -53,7 +53,7 @@ class LwM2MBootstrapServerCredential(BaseModel): # discriminator mappings __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'NoSecLwM2MBootstrapServerCredential': 'NoSecLwM2MBootstrapServerCredential','PSKLwM2MBootstrapServerCredential': 'PSKLwM2MBootstrapServerCredential','RPKLwM2MBootstrapServerCredential': 'RPKLwM2MBootstrapServerCredential','X509LwM2MBootstrapServerCredential': 'X509LwM2MBootstrapServerCredential' + 'NO_SEC': 'NoSecLwM2MBootstrapServerCredential','PSK': 'PSKLwM2MBootstrapServerCredential','RPK': 'RPKLwM2MBootstrapServerCredential','X509': 'X509LwM2MBootstrapServerCredential' } @classmethod diff --git a/paas/tb_paas_client/models/no_sec_lw_m2_m_bootstrap_server_credential.py b/paas/tb_paas_client/models/no_sec_lw_m2_m_bootstrap_server_credential.py index bf95d5cc..06190ea0 100644 --- a/paas/tb_paas_client/models/no_sec_lw_m2_m_bootstrap_server_credential.py +++ b/paas/tb_paas_client/models/no_sec_lw_m2_m_bootstrap_server_credential.py @@ -31,6 +31,7 @@ class NoSecLwM2MBootstrapServerCredential(LwM2MBootstrapServerCredential): """ NoSecLwM2MBootstrapServerCredential """ # noqa: E501 + security_mode: StrictStr = Field(default="NO_SEC", serialization_alias="securityMode") # post_process: discriminator default short_server_id: Optional[StrictInt] = Field(default=None, description="Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server.", serialization_alias="shortServerId") bootstrap_server_is: Optional[StrictBool] = Field(default=None, description="Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified.", serialization_alias="bootstrapServerIs") host: Optional[StrictStr] = Field(default=None, description="Host for 'No Security' mode") diff --git a/paas/tb_paas_client/models/psklw_m2_m_bootstrap_server_credential.py b/paas/tb_paas_client/models/psklw_m2_m_bootstrap_server_credential.py index 1e75c2cc..7eade30f 100644 --- a/paas/tb_paas_client/models/psklw_m2_m_bootstrap_server_credential.py +++ b/paas/tb_paas_client/models/psklw_m2_m_bootstrap_server_credential.py @@ -31,6 +31,7 @@ class PSKLwM2MBootstrapServerCredential(LwM2MBootstrapServerCredential): """ PSKLwM2MBootstrapServerCredential """ # noqa: E501 + security_mode: StrictStr = Field(default="PSK", serialization_alias="securityMode") # post_process: discriminator default short_server_id: Optional[StrictInt] = Field(default=None, description="Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server.", serialization_alias="shortServerId") bootstrap_server_is: Optional[StrictBool] = Field(default=None, description="Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified.", serialization_alias="bootstrapServerIs") host: Optional[StrictStr] = Field(default=None, description="Host for 'No Security' mode") diff --git a/paas/tb_paas_client/models/report_task_result.py b/paas/tb_paas_client/models/report_task_result.py index 1b04f901..4ef5e1da 100644 --- a/paas/tb_paas_client/models/report_task_result.py +++ b/paas/tb_paas_client/models/report_task_result.py @@ -21,7 +21,7 @@ import re # noqa: F401 import json -from pydantic import ConfigDict +from pydantic import ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from tb_paas_client.models.report import Report from tb_paas_client.models.task_result import TaskResult @@ -32,6 +32,7 @@ class ReportTaskResult(TaskResult): """ ReportTaskResult """ # noqa: E501 + job_type: StrictStr = Field(default="REPORT", serialization_alias="jobType") # post_process: discriminator default report: Optional[Report] = None __properties: ClassVar[List[str]] = ["key", "success", "discarded", "finishTs", "error", "jobType", "report"] diff --git a/paas/tb_paas_client/models/rpklw_m2_m_bootstrap_server_credential.py b/paas/tb_paas_client/models/rpklw_m2_m_bootstrap_server_credential.py index e3381829..eed32838 100644 --- a/paas/tb_paas_client/models/rpklw_m2_m_bootstrap_server_credential.py +++ b/paas/tb_paas_client/models/rpklw_m2_m_bootstrap_server_credential.py @@ -31,6 +31,7 @@ class RPKLwM2MBootstrapServerCredential(LwM2MBootstrapServerCredential): """ RPKLwM2MBootstrapServerCredential """ # noqa: E501 + security_mode: StrictStr = Field(default="RPK", serialization_alias="securityMode") # post_process: discriminator default short_server_id: Optional[StrictInt] = Field(default=None, description="Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server.", serialization_alias="shortServerId") bootstrap_server_is: Optional[StrictBool] = Field(default=None, description="Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified.", serialization_alias="bootstrapServerIs") host: Optional[StrictStr] = Field(default=None, description="Host for 'No Security' mode") diff --git a/paas/tb_paas_client/models/task_result.py b/paas/tb_paas_client/models/task_result.py index 03d5d6dc..429584be 100644 --- a/paas/tb_paas_client/models/task_result.py +++ b/paas/tb_paas_client/models/task_result.py @@ -57,7 +57,7 @@ class TaskResult(BaseModel): # discriminator mappings __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'CfReprocessingTaskResult': 'CfReprocessingTaskResult','DummyTaskResult': 'DummyTaskResult','ReportTaskResult': 'ReportTaskResult' + 'CF_REPROCESSING': 'CfReprocessingTaskResult','DUMMY': 'DummyTaskResult','REPORT': 'ReportTaskResult' } @classmethod diff --git a/paas/tb_paas_client/models/telemetry_observe_strategy.py b/paas/tb_paas_client/models/telemetry_observe_strategy.py index 256043e4..c52f8fc2 100644 --- a/paas/tb_paas_client/models/telemetry_observe_strategy.py +++ b/paas/tb_paas_client/models/telemetry_observe_strategy.py @@ -24,15 +24,15 @@ class TelemetryObserveStrategy(str, Enum): """ - TelemetryObserveStrategy + Observation strategy for telemetry. SINGLE (0): one resource equals one single observe request. COMPOSITE_ALL (1): all resources in one composite observe request. COMPOSITE_BY_OBJECT (2): grouped composite observe requests by object. """ """ allowed enum values """ - SINGLE_LEFT_PARENTHESIS_0_RIGHT_PARENTHESIS_COLON__ONE_RESOURCE_EQUALS_ONE_SINGLE_OBSERVE_REQUEST = 'SINGLE (0): One resource equals one single observe request' - COMPOSITE_ALL_LEFT_PARENTHESIS_1_RIGHT_PARENTHESIS_COLON__ALL_RESOURCES_IN_ONE_COMPOSITE_OBSERVE_REQUEST = 'COMPOSITE_ALL (1): All resources in one composite observe request' - COMPOSITE_BY_OBJECT_LEFT_PARENTHESIS_2_RIGHT_PARENTHESIS_COLON__GROUPED_COMPOSITE_OBSERVE_REQUESTS_BY_OBJECT = 'COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object' + SINGLE = 'SINGLE' + COMPOSITE_ALL = 'COMPOSITE_ALL' + COMPOSITE_BY_OBJECT = 'COMPOSITE_BY_OBJECT' @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/paas/tb_paas_client/models/x509_lw_m2_m_bootstrap_server_credential.py b/paas/tb_paas_client/models/x509_lw_m2_m_bootstrap_server_credential.py index fb36d9a5..bcdb0770 100644 --- a/paas/tb_paas_client/models/x509_lw_m2_m_bootstrap_server_credential.py +++ b/paas/tb_paas_client/models/x509_lw_m2_m_bootstrap_server_credential.py @@ -31,6 +31,7 @@ class X509LwM2MBootstrapServerCredential(LwM2MBootstrapServerCredential): """ X509LwM2MBootstrapServerCredential """ # noqa: E501 + security_mode: StrictStr = Field(default="X509", serialization_alias="securityMode") # post_process: discriminator default short_server_id: Optional[StrictInt] = Field(default=None, description="Server short Id. Used as link to associate server Object Instance. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server.", serialization_alias="shortServerId") bootstrap_server_is: Optional[StrictBool] = Field(default=None, description="Is Bootstrap Server or Lwm2m Server. The LwM2M Client MAY be configured to use one or more LwM2M Server Account(s). The LwM2M Client MUST have at most one LwM2M Bootstrap-Server Account. (*) The LwM2M client MUST have at least one LwM2M server account after completing the boot sequence specified.", serialization_alias="bootstrapServerIs") host: Optional[StrictStr] = Field(default=None, description="Host for 'No Security' mode")