Merge pull request #4 from waylayio/chore/regenerate

Regenerate rules sdk 🔁

.github/workflows/python.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v4
@@ -133,4 +133,4 @@ jobs:
     - name: Publish to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        packages-dir: waylay-sdk-rules-types/dist
+        packages-dir: waylay-sdk-rules-types/dist

docs/Operation.md

@@ -34,6 +34,8 @@ response = await waylay_client.demo.gadgets.combatulate_trinket(
     raw_response=False,
     select_path=None,
     response_type=None,
+    # optional flag to disable the validation of the request arguments when using typed requests
+    validate_request=True,
     # optional named arguments passed to the http client  (named)
     timeout=10.0,
 )

docs/PlugsExecutionApi.md

@@ -41,6 +41,8 @@ try:
     # calls `POST /rules/v1/actions/{name}`
     api_response = await waylay_client.rules.plugs_execution.execute_actuator(
         'name_example', # name | path param "name"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_actuator:\n")
     pprint(api_response)
@@ -57,6 +59,7 @@ POST /rules/v1/actions/{name}
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -114,6 +117,8 @@ try:
     api_response = await waylay_client.rules.plugs_execution.execute_actuator_version(
         'name_example', # name | path param "name"
         'version_example', # version | path param "version"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_actuator_version:\n")
     pprint(api_response)
@@ -131,6 +136,7 @@ Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
 **version** | **str** | path parameter `"version"` | Version number of plugin | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -186,6 +192,8 @@ try:
     # calls `POST /rules/v1/sensors/{name}`
     api_response = await waylay_client.rules.plugs_execution.execute_sensor(
         'name_example', # name | path param "name"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_sensor:\n")
     pprint(api_response)
@@ -202,6 +210,7 @@ POST /rules/v1/sensors/{name}
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -259,6 +268,8 @@ try:
     api_response = await waylay_client.rules.plugs_execution.execute_sensor_version(
         'name_example', # name | path param "name"
         'version_example', # version | path param "version"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_sensor_version:\n")
     pprint(api_response)
@@ -276,6 +287,7 @@ Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
 **version** | **str** | path parameter `"version"` | Version number of plugin | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -331,6 +343,8 @@ try:
     # calls `POST /rules/v1/transformers/{name}`
     api_response = await waylay_client.rules.plugs_execution.execute_transformer(
         'name_example', # name | path param "name"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_transformer:\n")
     pprint(api_response)
@@ -347,6 +361,7 @@ POST /rules/v1/transformers/{name}
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -404,6 +419,8 @@ try:
     api_response = await waylay_client.rules.plugs_execution.execute_transformer_version(
         'name_example', # name | path param "name"
         'version_example', # version | path param "version"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.ExecutePlugsSpecification() # ExecutePlugsSpecification | Specification to execute a plug.
     )
     print("The response of rules.plugs_execution.execute_transformer_version:\n")
     pprint(api_response)
@@ -421,6 +438,7 @@ Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` |  | 
 **version** | **str** | path parameter `"version"` | Version number of plugin | 
+**json** | [**ExecutePlugsSpecification**](ExecutePlugsSpecification.md) | json request body | Specification to execute a plug. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type

docs/PushDataApi.md

@@ -33,6 +33,8 @@ try:
     # Push Streaming Data
     # calls `POST /rules/v1/data`
     api_response = await waylay_client.rules.push_data.push(
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.StreamData() # StreamData | Push (real-time) Data Specification
     )
     print("The response of rules.push_data.push:\n")
     pprint(api_response)
@@ -48,6 +50,7 @@ POST /rules/v1/data
 
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
+**json** | [**StreamData**](StreamData.md) | json request body | Push (real-time) Data Specification | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type

docs/TaskNodesApi.md

@@ -256,6 +256,13 @@ try:
     api_response = await waylay_client.rules.task_nodes.update(
         'task_id_example', # task_id | path param "taskId"
         'node_id_example', # node_id | path param "nodeId"
+        # non-json binary data: use a byte array or a generator of bytearray chuncks
+        content=b'my-binary-data',
+        # this operation supports multiple request content types: use `headers` to specify the one used
+        # alternatives: 
+        headers = {
+            'content-type': 'text/plain'
+        },
     )
     print("The response of rules.task_nodes.update:\n")
     pprint(api_response)
@@ -273,7 +280,9 @@ Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **task_id** | **str** | path parameter `"taskId"` | Unique Task identifier | 
 **node_id** | **str** | path parameter `"nodeId"` | Unique node label | 
+**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | Command string to apply to a node of a task. | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
+**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `text/plain`
 
 ### Return type
 

docs/TasksApi.md

@@ -47,6 +47,8 @@ try:
             'failOnWarning': False
             'returnWarnings': False
         },
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TaskSpecification() # TaskSpecification | Task Specification
     )
     print("The response of rules.tasks.create:\n")
     pprint(api_response)
@@ -62,6 +64,7 @@ POST /rules/v1/tasks
 
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
+**json** | [**TaskSpecification**](TaskSpecification.md) | json request body | Task Specification | 
 **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter |  | 
 **query['failOnWarning']** (dict) <br> **query.fail_on_warning** (Query) | **bool** | query parameter `"failOnWarning"` | If &#x60;true&#x60; and there are task warnings, the response will be a &#x60;400 Validation failed&#x60; | [optional] [default False]
 **query['returnWarnings']** (dict) <br> **query.return_warnings** (Query) | **bool** | query parameter `"returnWarnings"` | If &#x60;true&#x60;, result body will contain a list of task warnings that where detected | [optional] [default False]
@@ -436,6 +439,8 @@ try:
     # calls `PUT /rules/v1/tasks/{taskId}`
     api_response = await waylay_client.rules.tasks.replace(
         'task_id_example', # task_id | path param "taskId"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TaskSpecification() # TaskSpecification | Task Specification
     )
     print("The response of rules.tasks.replace:\n")
     pprint(api_response)
@@ -452,6 +457,7 @@ PUT /rules/v1/tasks/{taskId}
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **task_id** | **str** | path parameter `"taskId"` | Unique Task identifier | 
+**json** | [**TaskSpecification**](TaskSpecification.md) | json request body | Task Specification | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type

docs/TasksBatchOperationsApi.md

@@ -104,6 +104,8 @@ try:
     # Start Batch Operations
     # calls `POST /rules/v1/batch`
     api_response = await waylay_client.rules.tasks_batch_operations.start(
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = {"entity":"task","action":"delete","query":{"type":"onetime","status":"stopped","finishedBefore":1648738809733}} # ATasksBatchOperationSpecification | Tasks Batch Operation
     )
     print("The response of rules.tasks_batch_operations.start:\n")
     pprint(api_response)
@@ -119,6 +121,7 @@ POST /rules/v1/batch
 
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
+**json** | [**ATasksBatchOperationSpecification**](ATasksBatchOperationSpecification.md) | json request body | Tasks Batch Operation | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type

docs/TemplateRunsApi.md

@@ -40,6 +40,8 @@ try:
         # query parameters:
         query = {
         },
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TemplateRunWithGraphSpecification() # TemplateRunWithGraphSpecification | Specification to run template through graph/BN.
     )
     print("The response of rules.template_runs.run_graph:\n")
     pprint(api_response)
@@ -55,6 +57,7 @@ POST /rules/v1/templates/run
 
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
+**json** | [**TemplateRunWithGraphSpecification**](TemplateRunWithGraphSpecification.md) | json request body | Specification to run template through graph/BN. | 
 **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter |  | 
 **query['logLevel']** (dict) <br> **query.log_level** (Query) | [**RunTemplateLogLevelParameter**](.md) | query parameter `"logLevel"` | sets the log level for filtering out logs to requested log level or higher from the template run output. Value &#x60;NONE&#x60; will disable all logs. If not specified all logs will be returned. | [optional] 
 **query['targetNode']** (dict) <br> **query.target_node** (Query) | [**List[str]**](str.md) | query parameter `"targetNode"` | The sensors and actuators part of response will contain only elements related to the asked node of the graph. The returned logs also will be filtered and contain only logs related to the asked node(s). | [optional] 
@@ -117,6 +120,8 @@ try:
         # query parameters:
         query = {
         },
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TemplateRunSpecification() # TemplateRunSpecification | Specification to run template
     )
     print("The response of rules.template_runs.run:\n")
     pprint(api_response)
@@ -133,6 +138,7 @@ POST /rules/v1/templates/{name}/run
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` | Unique Template identifier | 
+**json** | [**TemplateRunSpecification**](TemplateRunSpecification.md) | json request body | Specification to run template | 
 **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter |  | 
 **query['logLevel']** (dict) <br> **query.log_level** (Query) | [**RunTemplateLogLevelParameter**](.md) | query parameter `"logLevel"` | sets the log level for filtering out logs to requested log level or higher from the template run output. Value &#x60;NONE&#x60; will disable all logs. If not specified all logs will be returned. | [optional] 
 **query['targetNode']** (dict) <br> **query.target_node** (Query) | [**List[str]**](str.md) | query parameter `"targetNode"` | The sensors and actuators part of response will contain only elements related to the asked node of the graph. The returned logs also will be filtered and contain only logs related to the asked node(s). | [optional] 

docs/TemplatesApi.md

@@ -41,6 +41,8 @@ try:
     # Create Template
     # calls `POST /rules/v1/templates`
     api_response = await waylay_client.rules.templates.create(
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TemplateEntity() # TemplateEntity | Template Specification
     )
     print("The response of rules.templates.create:\n")
     pprint(api_response)
@@ -56,6 +58,7 @@ POST /rules/v1/templates
 
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
+**json** | [**TemplateEntity**](TemplateEntity.md) | json request body | Template Specification | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type
@@ -398,6 +401,8 @@ try:
     # calls `PUT /rules/v1/templates/{name}`
     api_response = await waylay_client.rules.templates.replace(
         'name_example', # name | path param "name"
+        # json data: use a generated model or a json-serializable python data structure (dict, list)
+        json = waylay.services.rules.TemplateEntity() # TemplateEntity | Template Specification
     )
     print("The response of rules.templates.replace:\n")
     pprint(api_response)
@@ -414,6 +419,7 @@ PUT /rules/v1/templates/{name}
 Name     | Type  | API binding   | Description   | Notes
 -------- | ----- | ------------- | ------------- | -------------
 **name** | **str** | path parameter `"name"` | Unique Template identifier | 
+**json** | [**TemplateEntity**](TemplateEntity.md) | json request body | Template Specification | 
 **headers** | [HeaderTypes](Operation.md#req_headers) | request headers |  | 
 
 ### Return type