Skip to content

Commit

Permalink
Regenerate client from commit 5a8f8ed of spec repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ArduinoBot committed Jul 24, 2024
1 parent ea44f2c commit 2b12f26
Show file tree
Hide file tree
Showing 136 changed files with 9,441 additions and 129 deletions.
4 changes: 2 additions & 2 deletions .apigentools-info
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"spec_versions": {
"v2": {
"apigentools_version": "1.1.0",
"regenerated": "2024-04-16 08:18:53.737636",
"spec_repo_commit": "28842c9"
"regenerated": "2024-07-24 13:06:50.699634",
"spec_repo_commit": "5a8f8ed"
}
}
}
50 changes: 48 additions & 2 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@ docs/apis/tags/DevicesV2PassApi.md
docs/apis/tags/DevicesV2TagsApi.md
docs/apis/tags/LoraDevicesV1Api.md
docs/apis/tags/LoraFreqPlanV1Api.md
docs/apis/tags/NetworkCredentialsV1Api.md
docs/apis/tags/PropertiesV2Api.md
docs/apis/tags/SeriesV2Api.md
docs/apis/tags/TemplatesApi.md
docs/apis/tags/ThingsV2Api.md
docs/apis/tags/ThingsV2TagsApi.md
docs/models/ArduinoCompressedv2.md
docs/models/ArduinoCredentialsv1.md
docs/models/ArduinoCredentialsv1Collection.md
docs/models/ArduinoDashboardowner.md
docs/models/ArduinoDashboardshare.md
docs/models/ArduinoDashboardshareCollection.md
Expand All @@ -39,6 +43,7 @@ docs/models/ArduinoDevicev2properties.md
docs/models/ArduinoDevicev2propertyvalue.md
docs/models/ArduinoDevicev2propertyvalueCollection.md
docs/models/ArduinoDevicev2propertyvalues.md
docs/models/ArduinoDevicev2templatedevice.md
docs/models/ArduinoLinkedvariable.md
docs/models/ArduinoLinkedvariableCollection.md
docs/models/ArduinoLoradevicev1.md
Expand All @@ -47,18 +52,23 @@ docs/models/ArduinoLorafreqplanv1.md
docs/models/ArduinoProperty.md
docs/models/ArduinoPropertyCollection.md
docs/models/ArduinoSeriesBatch.md
docs/models/ArduinoSeriesBatchSampled.md
docs/models/ArduinoSeriesRawBatch.md
docs/models/ArduinoSeriesRawBatchLastvalue.md
docs/models/ArduinoSeriesRawLastValueResponse.md
docs/models/ArduinoSeriesRawResponse.md
docs/models/ArduinoSeriesResponse.md
docs/models/ArduinoSeriesSampledResponse.md
docs/models/ArduinoTags.md
docs/models/ArduinoTemplate.md
docs/models/ArduinoTemplateproperty.md
docs/models/ArduinoTemplatepropertyCollection.md
docs/models/ArduinoTemplatevariable.md
docs/models/ArduinoTemplatevariableCollection.md
docs/models/ArduinoThing.md
docs/models/ArduinoThingCollection.md
docs/models/ArduinoThingresult.md
docs/models/ArduinoThingresultCollection.md
docs/models/ArduinoThingtemplate.md
docs/models/ArduinoTimeseriesmedia.md
docs/models/ArduinoTimezone.md
Expand All @@ -74,6 +84,8 @@ docs/models/BatchQueryRawRequestsMediaV1.md
docs/models/BatchQueryRawResponseSeriesMediaV1.md
docs/models/BatchQueryRequestMediaV1.md
docs/models/BatchQueryRequestsMediaV1.md
docs/models/BatchQuerySampledRequestMediaV1.md
docs/models/BatchQuerySampledRequestsMediaV1.md
docs/models/CheckDevicesV2PassPayload.md
docs/models/Clone.md
docs/models/CreateDevicesV2CertsPayload.md
Expand All @@ -95,6 +107,7 @@ docs/models/PropertiesValues.md
docs/models/PropertyValue.md
docs/models/Sharerequest.md
docs/models/Tag.md
docs/models/Template.md
docs/models/ThingClone.md
docs/models/ThingCreate.md
docs/models/ThingSketch.md
Expand All @@ -115,15 +128,21 @@ iot_api_client/apis/tags/devices_v2_pass_api.py
iot_api_client/apis/tags/devices_v2_tags_api.py
iot_api_client/apis/tags/lora_devices_v1_api.py
iot_api_client/apis/tags/lora_freq_plan_v1_api.py
iot_api_client/apis/tags/network_credentials_v1_api.py
iot_api_client/apis/tags/properties_v2_api.py
iot_api_client/apis/tags/series_v2_api.py
iot_api_client/apis/tags/templates_api.py
iot_api_client/apis/tags/things_v2_api.py
iot_api_client/apis/tags/things_v2_tags_api.py
iot_api_client/configuration.py
iot_api_client/exceptions.py
iot_api_client/model/__init__.py
iot_api_client/model/arduino_compressedv2.py
iot_api_client/model/arduino_compressedv2.pyi
iot_api_client/model/arduino_credentialsv1.py
iot_api_client/model/arduino_credentialsv1.pyi
iot_api_client/model/arduino_credentialsv1_collection.py
iot_api_client/model/arduino_credentialsv1_collection.pyi
iot_api_client/model/arduino_dashboardowner.py
iot_api_client/model/arduino_dashboardowner.pyi
iot_api_client/model/arduino_dashboardshare.py
Expand Down Expand Up @@ -172,6 +191,8 @@ iot_api_client/model/arduino_devicev2propertyvalue_collection.py
iot_api_client/model/arduino_devicev2propertyvalue_collection.pyi
iot_api_client/model/arduino_devicev2propertyvalues.py
iot_api_client/model/arduino_devicev2propertyvalues.pyi
iot_api_client/model/arduino_devicev2templatedevice.py
iot_api_client/model/arduino_devicev2templatedevice.pyi
iot_api_client/model/arduino_linkedvariable.py
iot_api_client/model/arduino_linkedvariable.pyi
iot_api_client/model/arduino_linkedvariable_collection.py
Expand All @@ -188,6 +209,8 @@ iot_api_client/model/arduino_property_collection.py
iot_api_client/model/arduino_property_collection.pyi
iot_api_client/model/arduino_series_batch.py
iot_api_client/model/arduino_series_batch.pyi
iot_api_client/model/arduino_series_batch_sampled.py
iot_api_client/model/arduino_series_batch_sampled.pyi
iot_api_client/model/arduino_series_raw_batch.py
iot_api_client/model/arduino_series_raw_batch.pyi
iot_api_client/model/arduino_series_raw_batch_lastvalue.py
Expand All @@ -198,8 +221,12 @@ iot_api_client/model/arduino_series_raw_response.py
iot_api_client/model/arduino_series_raw_response.pyi
iot_api_client/model/arduino_series_response.py
iot_api_client/model/arduino_series_response.pyi
iot_api_client/model/arduino_series_sampled_response.py
iot_api_client/model/arduino_series_sampled_response.pyi
iot_api_client/model/arduino_tags.py
iot_api_client/model/arduino_tags.pyi
iot_api_client/model/arduino_template.py
iot_api_client/model/arduino_template.pyi
iot_api_client/model/arduino_templateproperty.py
iot_api_client/model/arduino_templateproperty.pyi
iot_api_client/model/arduino_templateproperty_collection.py
Expand All @@ -212,6 +239,10 @@ iot_api_client/model/arduino_thing.py
iot_api_client/model/arduino_thing.pyi
iot_api_client/model/arduino_thing_collection.py
iot_api_client/model/arduino_thing_collection.pyi
iot_api_client/model/arduino_thingresult.py
iot_api_client/model/arduino_thingresult.pyi
iot_api_client/model/arduino_thingresult_collection.py
iot_api_client/model/arduino_thingresult_collection.pyi
iot_api_client/model/arduino_thingtemplate.py
iot_api_client/model/arduino_thingtemplate.pyi
iot_api_client/model/arduino_timeseriesmedia.py
Expand Down Expand Up @@ -242,6 +273,10 @@ iot_api_client/model/batch_query_request_media_v1.py
iot_api_client/model/batch_query_request_media_v1.pyi
iot_api_client/model/batch_query_requests_media_v1.py
iot_api_client/model/batch_query_requests_media_v1.pyi
iot_api_client/model/batch_query_sampled_request_media_v1.py
iot_api_client/model/batch_query_sampled_request_media_v1.pyi
iot_api_client/model/batch_query_sampled_requests_media_v1.py
iot_api_client/model/batch_query_sampled_requests_media_v1.pyi
iot_api_client/model/check_devices_v2_pass_payload.py
iot_api_client/model/check_devices_v2_pass_payload.pyi
iot_api_client/model/clone.py
Expand Down Expand Up @@ -284,6 +319,8 @@ iot_api_client/model/sharerequest.py
iot_api_client/model/sharerequest.pyi
iot_api_client/model/tag.py
iot_api_client/model/tag.pyi
iot_api_client/model/template.py
iot_api_client/model/template.pyi
iot_api_client/model/thing_clone.py
iot_api_client/model/thing_clone.pyi
iot_api_client/model/thing_create.py
Expand All @@ -309,6 +346,15 @@ setup.py
test-requirements.txt
test/__init__.py
test/test_models/__init__.py
test/test_models/test_arduino_devicev2_otaupload.py
test/test_models/test_devicev2_otaurlpyalod.py
test/test_models/test_arduino_credentialsv1.py
test/test_models/test_arduino_credentialsv1_collection.py
test/test_models/test_arduino_devicev2templatedevice.py
test/test_models/test_arduino_series_batch_sampled.py
test/test_models/test_arduino_series_sampled_response.py
test/test_models/test_arduino_template.py
test/test_models/test_arduino_thingresult.py
test/test_models/test_arduino_thingresult_collection.py
test/test_models/test_batch_query_sampled_request_media_v1.py
test/test_models/test_batch_query_sampled_requests_media_v1.py
test/test_models/test_template.py
tox.ini
42 changes: 7 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,31 +34,12 @@ oauth_client = BackendApplicationClient(client_id=YOUR_CLIENT_ID)
token_url = "https://api2.arduino.cc/iot/v1/clients/token"

oauth = OAuth2Session(client=oauth_client)
token = oauth.fetch_token(
token_url=token_url,
client_id=YOUR_CLIENT_ID,
client_secret=YOUR_CLIENT_SECRET,
include_client_id=True,
audience="https://api2.arduino.cc/iot"
)

print(token.get("access_token"))
```

In case of organization access, you can add organization identifier specifying required header:


```python

org_id="<org-id>"

token = oauth.fetch_token(
token_url=token_url,
client_id=YOUR_CLIENT_ID,
client_secret=YOUR_CLIENT_SECRET,
include_client_id=True,
audience="https://api2.arduino.cc/iot",
headers={"X-Organization":org_id}
)

print(token.get("access_token"))
Expand All @@ -70,45 +51,36 @@ Once you get a token, you can create an instance of the iot-api client:
import iot_api_client as iot
from iot_api_client.rest import ApiException
from iot_api_client.configuration import Configuration
import iot_api_client.apis.tags.devices_v2_api as deviceApi

# configure and instance the API client
client_config = Configuration(host="https://api2.arduino.cc/iot")
client_config.access_token = YOUR_ACCESS_TOKEN
client = iot.ApiClient(client_config)

# as an example, interact with the devices API
devices_api = deviceApi.DevicesV2Api(client)
devices_api = iot.DevicesV2Api(client)

try:
devices = devices_api.devices_v2_list()
if devices.response.status==200:
for device in devices.body:
print("Device ("+device["id"]+"): "+device["name"])
resp = devices_api.devices_v2_list()
print(resp)
except ApiException as e:
print("Got an exception: {}".format(e))
```

In case of organization access, you can specify organization identifier in this way:

```python
client = iot.ApiClient(client_config,header_name="X-Organization",header_value=org_id)
```

For a working example, see [the example folder](https://github.com/arduino/iot-client-py/tree/master/example/main.py) in this repo.

## How to get Arduino IoT Cloud Client Credentials

You can generate Arduino IoT Cloud Client Credentials in `API Keys` section in the [IoT Cloud](https://app.arduino.cc/api-keys):
You can generate Arduino IoT Cloud Client Credentials in the `ARDUINO API` section in the [IoT Cloud things section](https://create.arduino.cc/iot/things):

### Step 1

![IoT Cloud](img/api_step1.png)
![IoT Cloud Site](https://github.com/arduino/iot-client-js/blob/master/img/selection_1.png?raw=true)

### Step 2

![IoT Cloud](img/api_step2.png)
![IoT Cloud Site](https://github.com/arduino/iot-client-js/blob/master/img/selection_2.png?raw=true)

### Step 3

![IoT Cloud](img/api_step3.png)
![IoT Cloud Site](https://github.com/arduino/iot-client-js/blob/master/img/selection_3.png?raw=true)
4 changes: 4 additions & 0 deletions docs/apis/tags/DashboardsV2Api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ with iot_api_client.ApiClient(configuration) as api_client:
header_params = {
}
body = Dashboardv2(
cover_image="cover_image_example",
name="0",
widgets=[
Widget(
Expand Down Expand Up @@ -342,6 +343,7 @@ with iot_api_client.ApiClient(configuration) as api_client:
'X-Organization': "X-Organization_example",
}
body = Dashboardv2(
cover_image="cover_image_example",
name="0",
widgets=[
Widget(
Expand Down Expand Up @@ -2448,6 +2450,7 @@ with iot_api_client.ApiClient(configuration) as api_client:
header_params = {
}
body = Dashboardv2(
cover_image="cover_image_example",
name="0",
widgets=[
Widget(
Expand Down Expand Up @@ -2488,6 +2491,7 @@ with iot_api_client.ApiClient(configuration) as api_client:
'X-Organization': "X-Organization_example",
}
body = Dashboardv2(
cover_image="cover_image_example",
name="0",
widgets=[
Widget(
Expand Down
Loading

0 comments on commit 2b12f26

Please sign in to comment.