diff --git a/docs/DashboardsV2Api.md b/docs/DashboardsV2Api.md deleted file mode 100644 index 7a820ea..0000000 --- a/docs/DashboardsV2Api.md +++ /dev/null @@ -1,886 +0,0 @@ -# \DashboardsV2Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DashboardsV2Clone**](DashboardsV2Api.md#DashboardsV2Clone) | **Put** /v2/dashboards/{id}/clone | clone dashboards_v2 -[**DashboardsV2Create**](DashboardsV2Api.md#DashboardsV2Create) | **Post** /v2/dashboards | create dashboards_v2 -[**DashboardsV2Delete**](DashboardsV2Api.md#DashboardsV2Delete) | **Delete** /v2/dashboards/{id} | delete dashboards_v2 -[**DashboardsV2DeleteShare**](DashboardsV2Api.md#DashboardsV2DeleteShare) | **Delete** /v2/dashboards/{id}/shares/{user_id} | deleteShare dashboards_v2 -[**DashboardsV2Link**](DashboardsV2Api.md#DashboardsV2Link) | **Put** /v2/dashboards/{id}/widgets/{widgetId}/variables | link dashboards_v2 -[**DashboardsV2List**](DashboardsV2Api.md#DashboardsV2List) | **Get** /v2/dashboards | list dashboards_v2 -[**DashboardsV2ListShares**](DashboardsV2Api.md#DashboardsV2ListShares) | **Get** /v2/dashboards/{id}/shares | listShares dashboards_v2 -[**DashboardsV2RequestAccess**](DashboardsV2Api.md#DashboardsV2RequestAccess) | **Put** /v2/dashboards/{id}/share_request | requestAccess dashboards_v2 -[**DashboardsV2Share**](DashboardsV2Api.md#DashboardsV2Share) | **Put** /v2/dashboards/{id}/shares | share dashboards_v2 -[**DashboardsV2Show**](DashboardsV2Api.md#DashboardsV2Show) | **Get** /v2/dashboards/{id} | show dashboards_v2 -[**DashboardsV2Template**](DashboardsV2Api.md#DashboardsV2Template) | **Get** /v2/dashboards/{id}/template | template dashboards_v2 -[**DashboardsV2Update**](DashboardsV2Api.md#DashboardsV2Update) | **Put** /v2/dashboards/{id} | update dashboards_v2 - - - -## DashboardsV2Clone - -> ArduinoDashboardv2 DashboardsV2Clone(ctx, id).Clone(clone).XOrganization(xOrganization).Execute() - -clone dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - clone := *openapiclient.NewClone() // Clone | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Clone(context.Background(), id).Clone(clone).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Clone``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Clone`: ArduinoDashboardv2 - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Clone`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2CloneRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **clone** | [**Clone**](Clone.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDashboardv2**](ArduinoDashboardv2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.dashboardv2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Create - -> ArduinoDashboardv2 DashboardsV2Create(ctx).Dashboardv2(dashboardv2).XOrganization(xOrganization).Execute() - -create dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - dashboardv2 := *openapiclient.NewDashboardv2() // Dashboardv2 | DashboardV2Payload describes a dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Create(context.Background()).Dashboardv2(dashboardv2).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Create``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Create`: ArduinoDashboardv2 - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Create`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2CreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dashboardv2** | [**Dashboardv2**](Dashboardv2.md) | DashboardV2Payload describes a dashboard | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDashboardv2**](ArduinoDashboardv2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.dashboardv2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Delete - -> DashboardsV2Delete(ctx, id).XOrganization(xOrganization).Execute() - -delete dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DashboardsV2Api.DashboardsV2Delete(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Delete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2DeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2DeleteShare - -> DashboardsV2DeleteShare(ctx, id, userId).XOrganization(xOrganization).Execute() - -deleteShare dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - userId := "userId_example" // string | The id of the user - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DashboardsV2Api.DashboardsV2DeleteShare(context.Background(), id, userId).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2DeleteShare``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | -**userId** | **string** | The id of the user | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2DeleteShareRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Link - -> ArduinoVariableslinks DashboardsV2Link(ctx, id, widgetId).Widgetlink(widgetlink).XOrganization(xOrganization).Execute() - -link dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - widgetId := "widgetId_example" // string | The id of the widget - widgetlink := *openapiclient.NewWidgetlink() // Widgetlink | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Link(context.Background(), id, widgetId).Widgetlink(widgetlink).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Link``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Link`: ArduinoVariableslinks - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Link`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | -**widgetId** | **string** | The id of the widget | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2LinkRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **widgetlink** | [**Widgetlink**](Widgetlink.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoVariableslinks**](ArduinoVariableslinks.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.variableslinks+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2List - -> []ArduinoDashboardv2 DashboardsV2List(ctx).Name(name).UserId(userId).XOrganization(xOrganization).Execute() - -list dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - name := "name_example" // string | The name of the dashboard (optional) - userId := "userId_example" // string | The user_id of the dashboard's owner (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2List(context.Background()).Name(name).UserId(userId).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2List``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2List`: []ArduinoDashboardv2 - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2List`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2ListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **string** | The name of the dashboard | - **userId** | **string** | The user_id of the dashboard's owner | - **xOrganization** | **string** | | - -### Return type - -[**[]ArduinoDashboardv2**](ArduinoDashboardv2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.dashboardv2+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2ListShares - -> []ArduinoDashboardshare DashboardsV2ListShares(ctx, id).XOrganization(xOrganization).Execute() - -listShares dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2ListShares(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2ListShares``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2ListShares`: []ArduinoDashboardshare - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2ListShares`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2ListSharesRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**[]ArduinoDashboardshare**](ArduinoDashboardshare.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.dashboardshare+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2RequestAccess - -> DashboardsV2RequestAccess(ctx, id).Sharerequest(sharerequest).XOrganization(xOrganization).Execute() - -requestAccess dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - sharerequest := *openapiclient.NewSharerequest() // Sharerequest | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DashboardsV2Api.DashboardsV2RequestAccess(context.Background(), id).Sharerequest(sharerequest).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2RequestAccess``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2RequestAccessRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **sharerequest** | [**Sharerequest**](Sharerequest.md) | | - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Share - -> DashboardsV2Share(ctx, id).Dashboardshare(dashboardshare).XOrganization(xOrganization).Execute() - -share dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - dashboardshare := *openapiclient.NewDashboardshare() // Dashboardshare | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DashboardsV2Api.DashboardsV2Share(context.Background(), id).Dashboardshare(dashboardshare).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Share``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2ShareRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **dashboardshare** | [**Dashboardshare**](Dashboardshare.md) | | - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Show - -> ArduinoDashboardv2 DashboardsV2Show(ctx, id).XOrganization(xOrganization).Execute() - -show dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Show(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Show``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Show`: ArduinoDashboardv2 - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Show`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2ShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDashboardv2**](ArduinoDashboardv2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.dashboardv2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Template - -> ArduinoDashboardv2template DashboardsV2Template(ctx, id).XOrganization(xOrganization).Execute() - -template dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Template(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Template``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Template`: ArduinoDashboardv2template - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Template`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2TemplateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDashboardv2template**](ArduinoDashboardv2template.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.dashboardv2template+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DashboardsV2Update - -> ArduinoDashboardv2 DashboardsV2Update(ctx, id).Dashboardv2(dashboardv2).XOrganization(xOrganization).Execute() - -update dashboards_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the dashboard - dashboardv2 := *openapiclient.NewDashboardv2() // Dashboardv2 | DashboardV2Payload describes a dashboard - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DashboardsV2Api.DashboardsV2Update(context.Background(), id).Dashboardv2(dashboardv2).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DashboardsV2Api.DashboardsV2Update``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DashboardsV2Update`: ArduinoDashboardv2 - fmt.Fprintf(os.Stdout, "Response from `DashboardsV2Api.DashboardsV2Update`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the dashboard | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDashboardsV2UpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **dashboardv2** | [**Dashboardv2**](Dashboardv2.md) | DashboardV2Payload describes a dashboard | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDashboardv2**](ArduinoDashboardv2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.dashboardv2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/DevicesV2Api.md b/docs/DevicesV2Api.md deleted file mode 100644 index d60a402..0000000 --- a/docs/DevicesV2Api.md +++ /dev/null @@ -1,751 +0,0 @@ -# \DevicesV2Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DevicesV2Create**](DevicesV2Api.md#DevicesV2Create) | **Put** /v2/devices | create devices_v2 -[**DevicesV2Delete**](DevicesV2Api.md#DevicesV2Delete) | **Delete** /v2/devices/{id} | delete devices_v2 -[**DevicesV2GetEvents**](DevicesV2Api.md#DevicesV2GetEvents) | **Get** /v2/devices/{id}/events | getEvents devices_v2 -[**DevicesV2GetProperties**](DevicesV2Api.md#DevicesV2GetProperties) | **Get** /v2/devices/{id}/properties | getProperties devices_v2 -[**DevicesV2GetStatusEvents**](DevicesV2Api.md#DevicesV2GetStatusEvents) | **Get** /v2/devices/{id}/status | GetStatusEvents devices_v2 -[**DevicesV2List**](DevicesV2Api.md#DevicesV2List) | **Get** /v2/devices | list devices_v2 -[**DevicesV2Show**](DevicesV2Api.md#DevicesV2Show) | **Get** /v2/devices/{id} | show devices_v2 -[**DevicesV2Timeseries**](DevicesV2Api.md#DevicesV2Timeseries) | **Get** /v2/devices/{id}/properties/{pid} | timeseries devices_v2 -[**DevicesV2Update**](DevicesV2Api.md#DevicesV2Update) | **Post** /v2/devices/{id} | update devices_v2 -[**DevicesV2UpdateProperties**](DevicesV2Api.md#DevicesV2UpdateProperties) | **Put** /v2/devices/{id}/properties | updateProperties devices_v2 - - - -## DevicesV2Create - -> ArduinoDevicev2 DevicesV2Create(ctx).CreateDevicesV2Payload(createDevicesV2Payload).XOrganization(xOrganization).Execute() - -create devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - createDevicesV2Payload := *openapiclient.NewCreateDevicesV2Payload("Type_example") // CreateDevicesV2Payload | DeviceV2 describes a device. - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2Create(context.Background()).CreateDevicesV2Payload(createDevicesV2Payload).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2Create``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2Create`: ArduinoDevicev2 - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2Create`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **createDevicesV2Payload** | [**CreateDevicesV2Payload**](CreateDevicesV2Payload.md) | DeviceV2 describes a device. | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2**](ArduinoDevicev2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.devicev2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2Delete - -> DevicesV2Delete(ctx, id).XOrganization(xOrganization).Execute() - -delete devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2Api.DevicesV2Delete(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2Delete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2DeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2GetEvents - -> ArduinoDevicev2EventProperties DevicesV2GetEvents(ctx, id).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - -getEvents devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - limit := int32(56) // int32 | The number of events to select (optional) - start := "start_example" // string | The time at which to start selecting events (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2GetEvents(context.Background(), id).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2GetEvents``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2GetEvents`: ArduinoDevicev2EventProperties - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2GetEvents`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2GetEventsRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **limit** | **int32** | The number of events to select | - **start** | **string** | The time at which to start selecting events | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2EventProperties**](ArduinoDevicev2EventProperties.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2.event.properties+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2GetProperties - -> ArduinoDevicev2properties DevicesV2GetProperties(ctx, id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - -getProperties devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - showDeleted := true // bool | If true, shows the soft deleted properties (optional) (default to false) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2GetProperties(context.Background(), id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2GetProperties``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2GetProperties`: ArduinoDevicev2properties - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2GetProperties`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2GetPropertiesRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **bool** | If true, shows the soft deleted properties | [default to false] - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2properties**](ArduinoDevicev2properties.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2properties+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2GetStatusEvents - -> ArduinoDevicev2StatusEvents DevicesV2GetStatusEvents(ctx, id).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - -GetStatusEvents devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - limit := int32(56) // int32 | The number of events to select (optional) (default to 30) - start := "start_example" // string | The time at which to start selecting events (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2GetStatusEvents(context.Background(), id).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2GetStatusEvents``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2GetStatusEvents`: ArduinoDevicev2StatusEvents - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2GetStatusEvents`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2GetStatusEventsRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **limit** | **int32** | The number of events to select | [default to 30] - **start** | **string** | The time at which to start selecting events | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2StatusEvents**](ArduinoDevicev2StatusEvents.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2.status.events+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2List - -> []ArduinoDevicev2 DevicesV2List(ctx).AcrossUserIds(acrossUserIds).Serial(serial).Tags(tags).XOrganization(xOrganization).Execute() - -list devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - acrossUserIds := true // bool | If true, returns all the devices (optional) (default to false) - serial := "serial_example" // string | Filter by device serial number (optional) - tags := []string{"Inner_example"} // []string | Filter by tags (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2List(context.Background()).AcrossUserIds(acrossUserIds).Serial(serial).Tags(tags).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2List``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2List`: []ArduinoDevicev2 - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2List`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2ListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **acrossUserIds** | **bool** | If true, returns all the devices | [default to false] - **serial** | **string** | Filter by device serial number | - **tags** | **[]string** | Filter by tags | - **xOrganization** | **string** | | - -### Return type - -[**[]ArduinoDevicev2**](ArduinoDevicev2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2Show - -> ArduinoDevicev2 DevicesV2Show(ctx, id).XOrganization(xOrganization).Execute() - -show devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2Show(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2Show``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2Show`: ArduinoDevicev2 - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2Show`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2ShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2**](ArduinoDevicev2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2Timeseries - -> ArduinoDevicev2propertyvalues DevicesV2Timeseries(ctx, id, pid).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - -timeseries devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - pid := "pid_example" // string | The id of the property - limit := int32(56) // int32 | The number of properties to select (optional) - start := "start_example" // string | The time at which to start selecting properties (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2Timeseries(context.Background(), id, pid).Limit(limit).Start(start).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2Timeseries``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2Timeseries`: ArduinoDevicev2propertyvalues - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2Timeseries`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | -**pid** | **string** | The id of the property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2TimeseriesRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **limit** | **int32** | The number of properties to select | - **start** | **string** | The time at which to start selecting properties | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2propertyvalues**](ArduinoDevicev2propertyvalues.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2propertyvalues+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2Update - -> ArduinoDevicev2 DevicesV2Update(ctx, id).Devicev2(devicev2).XOrganization(xOrganization).Execute() - -update devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - devicev2 := *openapiclient.NewDevicev2() // Devicev2 | DeviceV2 describes a device. - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2Api.DevicesV2Update(context.Background(), id).Devicev2(devicev2).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2Update``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2Update`: ArduinoDevicev2 - fmt.Fprintf(os.Stdout, "Response from `DevicesV2Api.DevicesV2Update`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2UpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **devicev2** | [**Devicev2**](Devicev2.md) | DeviceV2 describes a device. | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoDevicev2**](ArduinoDevicev2.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.devicev2+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2UpdateProperties - -> DevicesV2UpdateProperties(ctx, id).PropertiesValues(propertiesValues).XOrganization(xOrganization).Execute() - -updateProperties devices_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - propertiesValues := *openapiclient.NewPropertiesValues([]openapiclient.PropertiesValue{*openapiclient.NewPropertiesValue("Name_example", "Type_example", interface{}(123))}) // PropertiesValues | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2Api.DevicesV2UpdateProperties(context.Background(), id).PropertiesValues(propertiesValues).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2Api.DevicesV2UpdateProperties``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2UpdatePropertiesRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **propertiesValues** | [**PropertiesValues**](PropertiesValues.md) | | - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/DevicesV2CertsApi.md b/docs/DevicesV2CertsApi.md deleted file mode 100644 index 879528b..0000000 --- a/docs/DevicesV2CertsApi.md +++ /dev/null @@ -1,384 +0,0 @@ -# \DevicesV2CertsApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DevicesV2CertsCreate**](DevicesV2CertsApi.md#DevicesV2CertsCreate) | **Put** /v2/devices/{id}/certs | create devices_v2_certs -[**DevicesV2CertsDelete**](DevicesV2CertsApi.md#DevicesV2CertsDelete) | **Delete** /v2/devices/{id}/certs/{cid} | delete devices_v2_certs -[**DevicesV2CertsList**](DevicesV2CertsApi.md#DevicesV2CertsList) | **Get** /v2/devices/{id}/certs | list devices_v2_certs -[**DevicesV2CertsShow**](DevicesV2CertsApi.md#DevicesV2CertsShow) | **Get** /v2/devices/{id}/certs/{cid} | show devices_v2_certs -[**DevicesV2CertsUpdate**](DevicesV2CertsApi.md#DevicesV2CertsUpdate) | **Post** /v2/devices/{id}/certs/{cid} | update devices_v2_certs - - - -## DevicesV2CertsCreate - -> ArduinoDevicev2Cert DevicesV2CertsCreate(ctx, id).CreateDevicesV2CertsPayload(createDevicesV2CertsPayload).Execute() - -create devices_v2_certs - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - createDevicesV2CertsPayload := *openapiclient.NewCreateDevicesV2CertsPayload("-----BEGIN CERTIFICATE----- - MIIBeDCCAR4CAQAwgY0xCzAJBgNVBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRl - MQ8wDQYDVQQHEwZNeUNpdHkxFDASBgNVBAoTC0NvbXBhbnkgTHRkMQswCQYDVQQL - EwJJVDEUMBIGA1UEAxMLZXhhbXBsZS5jb20xHzAdBgkqhkiG9w0BCQEMEHRlc3RA - ZXhhbXBsZS5jb20wWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATf6J9Gk79XGJ2I - +v6p/r0UmPufUcUwtlx7gx87+DaI8Vpj9R5KN71HsHYw5uq+Lm0cr0CZIdtZU4cP - upd6jDQToC4wLAYJKoZIhvcNAQkOMR8wHTAbBgNVHREEFDASgRB0ZXN0QGV4YW1w - bGUuY29tMAoGCCqGSM49BAMCA0gAMEUCIGQqtlGzYdjPwYZYJ41albMBcdrKI7+8 - oiNSNWyDxJSGAiEAqQPPxMdr6vaXCCjr5s1J01WLKHzGoPFCR40rqAPs8eQ= - -----END CERTIFICATE----- - ", false) // CreateDevicesV2CertsPayload | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2CertsApi.DevicesV2CertsCreate(context.Background(), id).CreateDevicesV2CertsPayload(createDevicesV2CertsPayload).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2CertsApi.DevicesV2CertsCreate``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2CertsCreate`: ArduinoDevicev2Cert - fmt.Fprintf(os.Stdout, "Response from `DevicesV2CertsApi.DevicesV2CertsCreate`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CertsCreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **createDevicesV2CertsPayload** | [**CreateDevicesV2CertsPayload**](CreateDevicesV2CertsPayload.md) | | - -### Return type - -[**ArduinoDevicev2Cert**](ArduinoDevicev2Cert.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.devicev2.cert+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2CertsDelete - -> DevicesV2CertsDelete(ctx, cid, id).Execute() - -delete devices_v2_certs - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - cid := "cid_example" // string | The id of the cert - id := "id_example" // string | The id of the device - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2CertsApi.DevicesV2CertsDelete(context.Background(), cid, id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2CertsApi.DevicesV2CertsDelete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**cid** | **string** | The id of the cert | -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CertsDeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2CertsList - -> []ArduinoDevicev2Cert DevicesV2CertsList(ctx, id).Execute() - -list devices_v2_certs - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2CertsApi.DevicesV2CertsList(context.Background(), id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2CertsApi.DevicesV2CertsList``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2CertsList`: []ArduinoDevicev2Cert - fmt.Fprintf(os.Stdout, "Response from `DevicesV2CertsApi.DevicesV2CertsList`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CertsListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - -### Return type - -[**[]ArduinoDevicev2Cert**](ArduinoDevicev2Cert.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2.cert+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2CertsShow - -> ArduinoDevicev2Cert DevicesV2CertsShow(ctx, cid, id).Execute() - -show devices_v2_certs - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - cid := "cid_example" // string | The id of the cert - id := "id_example" // string | The id of the device - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2CertsApi.DevicesV2CertsShow(context.Background(), cid, id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2CertsApi.DevicesV2CertsShow``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2CertsShow`: ArduinoDevicev2Cert - fmt.Fprintf(os.Stdout, "Response from `DevicesV2CertsApi.DevicesV2CertsShow`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**cid** | **string** | The id of the cert | -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CertsShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - -### Return type - -[**ArduinoDevicev2Cert**](ArduinoDevicev2Cert.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2.cert+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2CertsUpdate - -> ArduinoDevicev2Cert DevicesV2CertsUpdate(ctx, cid, id).Devicev2Cert(devicev2Cert).Execute() - -update devices_v2_certs - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - cid := "cid_example" // string | The id of the cert - id := "id_example" // string | The id of the device - devicev2Cert := *openapiclient.NewDevicev2Cert() // Devicev2Cert | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2CertsApi.DevicesV2CertsUpdate(context.Background(), cid, id).Devicev2Cert(devicev2Cert).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2CertsApi.DevicesV2CertsUpdate``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2CertsUpdate`: ArduinoDevicev2Cert - fmt.Fprintf(os.Stdout, "Response from `DevicesV2CertsApi.DevicesV2CertsUpdate`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**cid** | **string** | The id of the cert | -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2CertsUpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **devicev2Cert** | [**Devicev2Cert**](Devicev2Cert.md) | | - -### Return type - -[**ArduinoDevicev2Cert**](ArduinoDevicev2Cert.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.devicev2.cert+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/DevicesV2OtaApi.md b/docs/DevicesV2OtaApi.md deleted file mode 100644 index 04e0ae2..0000000 --- a/docs/DevicesV2OtaApi.md +++ /dev/null @@ -1,227 +0,0 @@ -# \DevicesV2OtaApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DevicesV2OtaSend**](DevicesV2OtaApi.md#DevicesV2OtaSend) | **Put** /v2/devices/{id}/ota | send devices_v2_ota -[**DevicesV2OtaUpload**](DevicesV2OtaApi.md#DevicesV2OtaUpload) | **Post** /v2/devices/{id}/ota | upload devices_v2_ota -[**DevicesV2OtaUrl**](DevicesV2OtaApi.md#DevicesV2OtaUrl) | **Post** /v2/devices/{id}/ota/url | url devices_v2_ota - - - -## DevicesV2OtaSend - -> DevicesV2OtaSend(ctx, id).Devicev2Otabinaryurl(devicev2Otabinaryurl).Execute() - -send devices_v2_ota - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - devicev2Otabinaryurl := *openapiclient.NewDevicev2Otabinaryurl("BinaryKey_example") // Devicev2Otabinaryurl | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2OtaApi.DevicesV2OtaSend(context.Background(), id).Devicev2Otabinaryurl(devicev2Otabinaryurl).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2OtaApi.DevicesV2OtaSend``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2OtaSendRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **devicev2Otabinaryurl** | [**Devicev2Otabinaryurl**](Devicev2Otabinaryurl.md) | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2OtaUpload - -> ArduinoDevicev2Otaupload DevicesV2OtaUpload(ctx, id).OtaFile(otaFile).Async(async).ExpireInMins(expireInMins).Execute() - -upload devices_v2_ota - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - otaFile := os.NewFile(1234, "some_file") // *os.File | OTA file - async := true // bool | If false, wait for the full OTA process, until it gets a result from the device (optional) (default to true) - expireInMins := int32(56) // int32 | Binary expire time in minutes, default 10 mins (optional) (default to 10) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2OtaApi.DevicesV2OtaUpload(context.Background(), id).OtaFile(otaFile).Async(async).ExpireInMins(expireInMins).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2OtaApi.DevicesV2OtaUpload``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2OtaUpload`: ArduinoDevicev2Otaupload - fmt.Fprintf(os.Stdout, "Response from `DevicesV2OtaApi.DevicesV2OtaUpload`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2OtaUploadRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **otaFile** | ***os.File** | OTA file | - **async** | **bool** | If false, wait for the full OTA process, until it gets a result from the device | [default to true] - **expireInMins** | **int32** | Binary expire time in minutes, default 10 mins | [default to 10] - -### Return type - -[**ArduinoDevicev2Otaupload**](ArduinoDevicev2Otaupload.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/vnd.arduino.devicev2.otaupload+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2OtaUrl - -> DevicesV2OtaUrl(ctx, id).Devicev2Otaurlpyalod(devicev2Otaurlpyalod).Execute() - -url devices_v2_ota - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - devicev2Otaurlpyalod := *openapiclient.NewDevicev2Otaurlpyalod() // Devicev2Otaurlpyalod | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2OtaApi.DevicesV2OtaUrl(context.Background(), id).Devicev2Otaurlpyalod(devicev2Otaurlpyalod).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2OtaApi.DevicesV2OtaUrl``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2OtaUrlRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **devicev2Otaurlpyalod** | [**Devicev2Otaurlpyalod**](Devicev2Otaurlpyalod.md) | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/DevicesV2PassApi.md b/docs/DevicesV2PassApi.md deleted file mode 100644 index 21791ab..0000000 --- a/docs/DevicesV2PassApi.md +++ /dev/null @@ -1,294 +0,0 @@ -# \DevicesV2PassApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DevicesV2PassCheck**](DevicesV2PassApi.md#DevicesV2PassCheck) | **Post** /v2/devices/{id}/pass | check devices_v2_pass -[**DevicesV2PassDelete**](DevicesV2PassApi.md#DevicesV2PassDelete) | **Delete** /v2/devices/{id}/pass | delete devices_v2_pass -[**DevicesV2PassGet**](DevicesV2PassApi.md#DevicesV2PassGet) | **Get** /v2/devices/{id}/pass | get devices_v2_pass -[**DevicesV2PassSet**](DevicesV2PassApi.md#DevicesV2PassSet) | **Put** /v2/devices/{id}/pass | set devices_v2_pass - - - -## DevicesV2PassCheck - -> DevicesV2PassCheck(ctx, id).CheckDevicesV2PassPayload(checkDevicesV2PassPayload).Execute() - -check devices_v2_pass - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - checkDevicesV2PassPayload := *openapiclient.NewCheckDevicesV2PassPayload("Password_example") // CheckDevicesV2PassPayload | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2PassApi.DevicesV2PassCheck(context.Background(), id).CheckDevicesV2PassPayload(checkDevicesV2PassPayload).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2PassApi.DevicesV2PassCheck``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2PassCheckRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **checkDevicesV2PassPayload** | [**CheckDevicesV2PassPayload**](CheckDevicesV2PassPayload.md) | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2PassDelete - -> DevicesV2PassDelete(ctx, id).Execute() - -delete devices_v2_pass - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2PassApi.DevicesV2PassDelete(context.Background(), id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2PassApi.DevicesV2PassDelete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2PassDeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2PassGet - -> ArduinoDevicev2Pass DevicesV2PassGet(ctx, id).SuggestedPassword(suggestedPassword).Execute() - -get devices_v2_pass - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - suggestedPassword := true // bool | If true, return a suggested password (optional) (default to false) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2PassApi.DevicesV2PassGet(context.Background(), id).SuggestedPassword(suggestedPassword).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2PassApi.DevicesV2PassGet``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2PassGet`: ArduinoDevicev2Pass - fmt.Fprintf(os.Stdout, "Response from `DevicesV2PassApi.DevicesV2PassGet`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2PassGetRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **suggestedPassword** | **bool** | If true, return a suggested password | [default to false] - -### Return type - -[**ArduinoDevicev2Pass**](ArduinoDevicev2Pass.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.devicev2.pass+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2PassSet - -> ArduinoDevicev2Pass DevicesV2PassSet(ctx, id).Devicev2Pass(devicev2Pass).Execute() - -set devices_v2_pass - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - devicev2Pass := *openapiclient.NewDevicev2Pass() // Devicev2Pass | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2PassApi.DevicesV2PassSet(context.Background(), id).Devicev2Pass(devicev2Pass).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2PassApi.DevicesV2PassSet``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2PassSet`: ArduinoDevicev2Pass - fmt.Fprintf(os.Stdout, "Response from `DevicesV2PassApi.DevicesV2PassSet`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2PassSetRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **devicev2Pass** | [**Devicev2Pass**](Devicev2Pass.md) | | - -### Return type - -[**ArduinoDevicev2Pass**](ArduinoDevicev2Pass.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.devicev2.pass+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/DevicesV2TagsApi.md b/docs/DevicesV2TagsApi.md deleted file mode 100644 index d3cec5c..0000000 --- a/docs/DevicesV2TagsApi.md +++ /dev/null @@ -1,222 +0,0 @@ -# \DevicesV2TagsApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DevicesV2TagsDelete**](DevicesV2TagsApi.md#DevicesV2TagsDelete) | **Delete** /v2/devices/{id}/tags/{key} | delete devices_v2_tags -[**DevicesV2TagsList**](DevicesV2TagsApi.md#DevicesV2TagsList) | **Get** /v2/devices/{id}/tags | list devices_v2_tags -[**DevicesV2TagsUpsert**](DevicesV2TagsApi.md#DevicesV2TagsUpsert) | **Put** /v2/devices/{id}/tags | upsert devices_v2_tags - - - -## DevicesV2TagsDelete - -> DevicesV2TagsDelete(ctx, id, key).Execute() - -delete devices_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - key := "key_example" // string | The key of the tag - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2TagsApi.DevicesV2TagsDelete(context.Background(), id, key).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2TagsApi.DevicesV2TagsDelete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | -**key** | **string** | The key of the tag | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2TagsDeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2TagsList - -> ArduinoTags DevicesV2TagsList(ctx, id).Execute() - -list devices_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.DevicesV2TagsApi.DevicesV2TagsList(context.Background(), id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2TagsApi.DevicesV2TagsList``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `DevicesV2TagsList`: ArduinoTags - fmt.Fprintf(os.Stdout, "Response from `DevicesV2TagsApi.DevicesV2TagsList`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2TagsListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - -### Return type - -[**ArduinoTags**](ArduinoTags.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.tags+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DevicesV2TagsUpsert - -> DevicesV2TagsUpsert(ctx, id).Tag(tag).Execute() - -upsert devices_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the device - tag := *openapiclient.NewTag("Key_example", "Value_example") // Tag | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.DevicesV2TagsApi.DevicesV2TagsUpsert(context.Background(), id).Tag(tag).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `DevicesV2TagsApi.DevicesV2TagsUpsert``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the device | - -### Other Parameters - -Other parameters are passed through a pointer to a apiDevicesV2TagsUpsertRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **tag** | [**Tag**](Tag.md) | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/LoraDevicesV1Api.md b/docs/LoraDevicesV1Api.md deleted file mode 100644 index 148cda5..0000000 --- a/docs/LoraDevicesV1Api.md +++ /dev/null @@ -1,77 +0,0 @@ -# \LoraDevicesV1Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**LoraDevicesV1Create**](LoraDevicesV1Api.md#LoraDevicesV1Create) | **Put** /v1/lora-devices/ | create lora_devices_v1 - - - -## LoraDevicesV1Create - -> ArduinoLoradevicev1 LoraDevicesV1Create(ctx).CreateLoraDevicesV1Payload(createLoraDevicesV1Payload).XOrganization(xOrganization).Execute() - -create lora_devices_v1 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - createLoraDevicesV1Payload := *openapiclient.NewCreateLoraDevicesV1Payload("App_example", "Eui_example", "FrequencyPlan_example", "Name_example", "Type_example", "UserId_example") // CreateLoraDevicesV1Payload | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.LoraDevicesV1Api.LoraDevicesV1Create(context.Background()).CreateLoraDevicesV1Payload(createLoraDevicesV1Payload).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `LoraDevicesV1Api.LoraDevicesV1Create``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `LoraDevicesV1Create`: ArduinoLoradevicev1 - fmt.Fprintf(os.Stdout, "Response from `LoraDevicesV1Api.LoraDevicesV1Create`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiLoraDevicesV1CreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **createLoraDevicesV1Payload** | [**CreateLoraDevicesV1Payload**](CreateLoraDevicesV1Payload.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoLoradevicev1**](ArduinoLoradevicev1.md) - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.loradevicev1+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/LoraFreqPlanV1Api.md b/docs/LoraFreqPlanV1Api.md deleted file mode 100644 index 9086bc3..0000000 --- a/docs/LoraFreqPlanV1Api.md +++ /dev/null @@ -1,70 +0,0 @@ -# \LoraFreqPlanV1Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**LoraFreqPlanV1List**](LoraFreqPlanV1Api.md#LoraFreqPlanV1List) | **Get** /v1/lora-freq-plans/ | list lora_freq_plan_v1 - - - -## LoraFreqPlanV1List - -> ArduinoLorafreqplansv1 LoraFreqPlanV1List(ctx).Execute() - -list lora_freq_plan_v1 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.LoraFreqPlanV1Api.LoraFreqPlanV1List(context.Background()).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `LoraFreqPlanV1Api.LoraFreqPlanV1List``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `LoraFreqPlanV1List`: ArduinoLorafreqplansv1 - fmt.Fprintf(os.Stdout, "Response from `LoraFreqPlanV1Api.LoraFreqPlanV1List`: %v\n", resp) -} -``` - -### Path Parameters - -This endpoint does not need any parameter. - -### Other Parameters - -Other parameters are passed through a pointer to a apiLoraFreqPlanV1ListRequest struct via the builder pattern - - -### Return type - -[**ArduinoLorafreqplansv1**](ArduinoLorafreqplansv1.md) - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.lorafreqplansv1+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/NetworkCredentialsV1Api.md b/docs/NetworkCredentialsV1Api.md deleted file mode 100644 index 8865b9f..0000000 --- a/docs/NetworkCredentialsV1Api.md +++ /dev/null @@ -1,150 +0,0 @@ -# \NetworkCredentialsV1Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**NetworkCredentialsV1Show**](NetworkCredentialsV1Api.md#NetworkCredentialsV1Show) | **Get** /v1/network_credentials/{type} | show network_credentials_v1 -[**NetworkCredentialsV1ShowByDevice**](NetworkCredentialsV1Api.md#NetworkCredentialsV1ShowByDevice) | **Get** /v1/network_credentials/{type}/connections | showByDevice network_credentials_v1 - - - -## NetworkCredentialsV1Show - -> []ArduinoCredentialsv1 NetworkCredentialsV1Show(ctx, type_).Connection(connection).Execute() - -show network_credentials_v1 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - type_ := "type__example" // string | Device type - connection := "connection_example" // string | Connection used by the device (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.NetworkCredentialsV1Api.NetworkCredentialsV1Show(context.Background(), type_).Connection(connection).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `NetworkCredentialsV1Api.NetworkCredentialsV1Show``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `NetworkCredentialsV1Show`: []ArduinoCredentialsv1 - fmt.Fprintf(os.Stdout, "Response from `NetworkCredentialsV1Api.NetworkCredentialsV1Show`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**type_** | **string** | Device type | - -### Other Parameters - -Other parameters are passed through a pointer to a apiNetworkCredentialsV1ShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **connection** | **string** | Connection used by the device | - -### Return type - -[**[]ArduinoCredentialsv1**](ArduinoCredentialsv1.md) - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.credentialsv1+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## NetworkCredentialsV1ShowByDevice - -> NetworkCredentialsV1ShowByDevice(ctx, type_).Execute() - -showByDevice network_credentials_v1 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - type_ := "type__example" // string | Device type - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.NetworkCredentialsV1Api.NetworkCredentialsV1ShowByDevice(context.Background(), type_).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `NetworkCredentialsV1Api.NetworkCredentialsV1ShowByDevice``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**type_** | **string** | Device type | - -### Other Parameters - -Other parameters are passed through a pointer to a apiNetworkCredentialsV1ShowByDeviceRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - -### Return type - - (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/PropertiesV1Api.md b/docs/PropertiesV1Api.md deleted file mode 100644 index fcee88f..0000000 --- a/docs/PropertiesV1Api.md +++ /dev/null @@ -1,254 +0,0 @@ -# \PropertiesV1Api - -All URIs are relative to *http://api-dev.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**PropertiesV1Create**](PropertiesV1Api.md#PropertiesV1Create) | **Put** /v1/things/{id}/properties | create properties_v1 -[**PropertiesV1Delete**](PropertiesV1Api.md#PropertiesV1Delete) | **Delete** /v1/things/{id}/properties/{pid} | delete properties_v1 -[**PropertiesV1List**](PropertiesV1Api.md#PropertiesV1List) | **Get** /v1/things/{id}/properties | list properties_v1 -[**PropertiesV1Send**](PropertiesV1Api.md#PropertiesV1Send) | **Put** /v1/things/{id}/properties/{pid}/send | send properties_v1 -[**PropertiesV1Show**](PropertiesV1Api.md#PropertiesV1Show) | **Get** /v1/things/{id}/properties/{pid} | show properties_v1 -[**PropertiesV1Update**](PropertiesV1Api.md#PropertiesV1Update) | **Post** /v1/things/{id}/properties/{pid} | update properties_v1 - - - -## PropertiesV1Create - -> ArduinoProperty PropertiesV1Create(ctx, id, property) -create properties_v1 - -Creates a new property associated to a thing - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**property** | [**Property**](Property.md)| PropertyPayload describes a property of a thing. No field is mandatory | - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV1Delete - -> PropertiesV1Delete(ctx, id, pid, optional) -delete properties_v1 - -Removes a property associated to a thing - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**pid** | **string**| The id of the property | - **optional** | ***PropertiesV1DeleteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a PropertiesV1DeleteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **force** | **optional.Bool**| If true, hard delete the property | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV1List - -> []ArduinoProperty PropertiesV1List(ctx, id, optional) -list properties_v1 - -Returns the list of properties associated to the thing - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | - **optional** | ***PropertiesV1ListOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a PropertiesV1ListOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **optional.Bool**| If true, shows the soft deleted properties | [default to false] - -### Return type - -[**[]ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.property+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV1Send - -> PropertiesV1Send(ctx, id, pid, propertyStringValue) -send properties_v1 - -Publish a property value to MQTT, as string - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**pid** | **string**| The id of the property | -**propertyStringValue** | [**PropertyStringValue**](PropertyStringValue.md)| PropertyStringValuePayload describes a property value | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV1Show - -> ArduinoProperty PropertiesV1Show(ctx, id, pid, optional) -show properties_v1 - -Returns the property requested by the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**pid** | **string**| The id of the property | - **optional** | ***PropertiesV1ShowOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a PropertiesV1ShowOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **showDeleted** | **optional.Bool**| If true, shows the soft deleted properties | [default to false] - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV1Update - -> ArduinoProperty PropertiesV1Update(ctx, id, pid, property) -update properties_v1 - -Updates a property associated to a thing - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**pid** | **string**| The id of the property | -**property** | [**Property**](Property.md)| PropertyPayload describes a property of a thing. No field is mandatory | - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/PropertiesV2Api.md b/docs/PropertiesV2Api.md deleted file mode 100644 index 4a59267..0000000 --- a/docs/PropertiesV2Api.md +++ /dev/null @@ -1,552 +0,0 @@ -# \PropertiesV2Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**PropertiesV2Create**](PropertiesV2Api.md#PropertiesV2Create) | **Put** /v2/things/{id}/properties | create properties_v2 -[**PropertiesV2Delete**](PropertiesV2Api.md#PropertiesV2Delete) | **Delete** /v2/things/{id}/properties/{pid} | delete properties_v2 -[**PropertiesV2List**](PropertiesV2Api.md#PropertiesV2List) | **Get** /v2/things/{id}/properties | list properties_v2 -[**PropertiesV2Publish**](PropertiesV2Api.md#PropertiesV2Publish) | **Put** /v2/things/{id}/properties/{pid}/publish | publish properties_v2 -[**PropertiesV2Show**](PropertiesV2Api.md#PropertiesV2Show) | **Get** /v2/things/{id}/properties/{pid} | show properties_v2 -[**PropertiesV2Timeseries**](PropertiesV2Api.md#PropertiesV2Timeseries) | **Get** /v2/things/{id}/properties/{pid}/timeseries | timeseries properties_v2 -[**PropertiesV2Update**](PropertiesV2Api.md#PropertiesV2Update) | **Post** /v2/things/{id}/properties/{pid} | update properties_v2 - - - -## PropertiesV2Create - -> ArduinoProperty PropertiesV2Create(ctx, id).Property(property).XOrganization(xOrganization).Execute() - -create properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - property := *openapiclient.NewProperty("Name_example", "Permission_example", "Type_example", "UpdateStrategy_example") // Property | PropertyPayload describes a property of a thing. No field is mandatory - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertiesV2Api.PropertiesV2Create(context.Background(), id).Property(property).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Create``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertiesV2Create`: ArduinoProperty - fmt.Fprintf(os.Stdout, "Response from `PropertiesV2Api.PropertiesV2Create`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2CreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **property** | [**Property**](Property.md) | PropertyPayload describes a property of a thing. No field is mandatory | - **xOrganization** | **string** | The id of the organization | - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2Delete - -> PropertiesV2Delete(ctx, id, pid).Force(force).XOrganization(xOrganization).Execute() - -delete properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - pid := "pid_example" // string | The id of the property - force := true // bool | If true, hard delete the property (optional) (default to false) - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.PropertiesV2Api.PropertiesV2Delete(context.Background(), id, pid).Force(force).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Delete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**pid** | **string** | The id of the property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2DeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **force** | **bool** | If true, hard delete the property | [default to false] - **xOrganization** | **string** | The id of the organization | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2List - -> []ArduinoProperty PropertiesV2List(ctx, id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - -list properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - showDeleted := true // bool | If true, shows the soft deleted properties (optional) (default to false) - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertiesV2Api.PropertiesV2List(context.Background(), id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2List``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertiesV2List`: []ArduinoProperty - fmt.Fprintf(os.Stdout, "Response from `PropertiesV2Api.PropertiesV2List`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2ListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **bool** | If true, shows the soft deleted properties | [default to false] - **xOrganization** | **string** | The id of the organization | - -### Return type - -[**[]ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.property+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2Publish - -> PropertiesV2Publish(ctx, id, pid).PropertyValue(propertyValue).XOrganization(xOrganization).Execute() - -publish properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - pid := "pid_example" // string | The id of the property - propertyValue := *openapiclient.NewPropertyValue(interface{}(123)) // PropertyValue | PropertyValuePayload describes a property value - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.PropertiesV2Api.PropertiesV2Publish(context.Background(), id, pid).PropertyValue(propertyValue).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Publish``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**pid** | **string** | The id of the property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2PublishRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **propertyValue** | [**PropertyValue**](PropertyValue.md) | PropertyValuePayload describes a property value | - **xOrganization** | **string** | The id of the organization | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2Show - -> ArduinoProperty PropertiesV2Show(ctx, id, pid).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - -show properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - pid := "pid_example" // string | The id of the property - showDeleted := true // bool | If true, shows the soft deleted properties (optional) (default to false) - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertiesV2Api.PropertiesV2Show(context.Background(), id, pid).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Show``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertiesV2Show`: ArduinoProperty - fmt.Fprintf(os.Stdout, "Response from `PropertiesV2Api.PropertiesV2Show`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**pid** | **string** | The id of the property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2ShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **showDeleted** | **bool** | If true, shows the soft deleted properties | [default to false] - **xOrganization** | **string** | The id of the organization | - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2Timeseries - -> ArduinoTimeseriesmedia PropertiesV2Timeseries(ctx, id, pid).Aggregation(aggregation).Desc(desc).From(from).Interval(interval).To(to).XOrganization(xOrganization).Execute() - -timeseries properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - pid := "pid_example" // string | ID of a numerical property - aggregation := "aggregation_example" // string | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) - desc := true // bool | Whether data's ordering (by time) should be descending (optional) (default to false) - from := "from_example" // string | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) - interval := int32(56) // int32 | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) - to := "to_example" // string | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertiesV2Api.PropertiesV2Timeseries(context.Background(), id, pid).Aggregation(aggregation).Desc(desc).From(from).Interval(interval).To(to).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Timeseries``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertiesV2Timeseries`: ArduinoTimeseriesmedia - fmt.Fprintf(os.Stdout, "Response from `PropertiesV2Api.PropertiesV2Timeseries`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**pid** | **string** | ID of a numerical property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2TimeseriesRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **aggregation** | **string** | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 | - **desc** | **bool** | Whether data's ordering (by time) should be descending | [default to false] - **from** | **string** | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) | - **interval** | **int32** | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) | - **to** | **string** | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) | - **xOrganization** | **string** | The id of the organization | - -### Return type - -[**ArduinoTimeseriesmedia**](ArduinoTimeseriesmedia.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.timeseriesmedia+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PropertiesV2Update - -> ArduinoProperty PropertiesV2Update(ctx, id, pid).Property(property).XOrganization(xOrganization).Execute() - -update properties_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - pid := "pid_example" // string | The id of the property - property := *openapiclient.NewProperty("Name_example", "Permission_example", "Type_example", "UpdateStrategy_example") // Property | PropertyPayload describes a property of a thing. No field is mandatory - xOrganization := "xOrganization_example" // string | The id of the organization (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertiesV2Api.PropertiesV2Update(context.Background(), id, pid).Property(property).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertiesV2Api.PropertiesV2Update``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertiesV2Update`: ArduinoProperty - fmt.Fprintf(os.Stdout, "Response from `PropertiesV2Api.PropertiesV2Update`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**pid** | **string** | The id of the property | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertiesV2UpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **property** | [**Property**](Property.md) | PropertyPayload describes a property of a thing. No field is mandatory | - **xOrganization** | **string** | The id of the organization | - -### Return type - -[**ArduinoProperty**](ArduinoProperty.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.property+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/PropertyTypesV1Api.md b/docs/PropertyTypesV1Api.md deleted file mode 100644 index 17c46ab..0000000 --- a/docs/PropertyTypesV1Api.md +++ /dev/null @@ -1,70 +0,0 @@ -# \PropertyTypesV1Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**PropertyTypesV1ListTypes**](PropertyTypesV1Api.md#PropertyTypesV1ListTypes) | **Get** /v1/property_types | listTypes property_types_v1 - - - -## PropertyTypesV1ListTypes - -> []ArduinoPropertytype PropertyTypesV1ListTypes(ctx).Execute() - -listTypes property_types_v1 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.PropertyTypesV1Api.PropertyTypesV1ListTypes(context.Background()).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `PropertyTypesV1Api.PropertyTypesV1ListTypes``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `PropertyTypesV1ListTypes`: []ArduinoPropertytype - fmt.Fprintf(os.Stdout, "Response from `PropertyTypesV1Api.PropertyTypesV1ListTypes`: %v\n", resp) -} -``` - -### Path Parameters - -This endpoint does not need any parameter. - -### Other Parameters - -Other parameters are passed through a pointer to a apiPropertyTypesV1ListTypesRequest struct via the builder pattern - - -### Return type - -[**[]ArduinoPropertytype**](ArduinoPropertytype.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.propertytype+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/SeriesV1Api.md b/docs/SeriesV1Api.md deleted file mode 100644 index d6f7ad2..0000000 --- a/docs/SeriesV1Api.md +++ /dev/null @@ -1,76 +0,0 @@ -# \SeriesV1Api - -All URIs are relative to *http://api-dev.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**SeriesV1BatchQuery**](SeriesV1Api.md#SeriesV1BatchQuery) | **Post** /v1/series/batch_query | batch_query series_v1 -[**SeriesV1BatchQueryRaw**](SeriesV1Api.md#SeriesV1BatchQueryRaw) | **Post** /v1/series/batch_query_raw | batch_query_raw series_v1 - - - -## SeriesV1BatchQuery - -> ArduinoSeriesBatch SeriesV1BatchQuery(ctx, batchQueryRequestsMediaV1) -batch_query series_v1 - -Returns the batch of time-series data - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**batchQueryRequestsMediaV1** | [**BatchQueryRequestsMediaV1**](BatchQueryRequestsMediaV1.md)| | - -### Return type - -[**ArduinoSeriesBatch**](ArduinoSeriesBatch.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.series.batch+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## SeriesV1BatchQueryRaw - -> ArduinoSeriesRawBatch SeriesV1BatchQueryRaw(ctx, batchQueryRawRequestsMediaV1) -batch_query_raw series_v1 - -Returns the batch of time-series data raw - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**batchQueryRawRequestsMediaV1** | [**BatchQueryRawRequestsMediaV1**](BatchQueryRawRequestsMediaV1.md)| | - -### Return type - -[**ArduinoSeriesRawBatch**](ArduinoSeriesRawBatch.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.series.raw.batch+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/SeriesV2Api.md b/docs/SeriesV2Api.md deleted file mode 100644 index 25ea761..0000000 --- a/docs/SeriesV2Api.md +++ /dev/null @@ -1,353 +0,0 @@ -# \SeriesV2Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**SeriesV2BatchQuery**](SeriesV2Api.md#SeriesV2BatchQuery) | **Post** /v2/series/batch_query | batch_query series_v2 -[**SeriesV2BatchQueryRaw**](SeriesV2Api.md#SeriesV2BatchQueryRaw) | **Post** /v2/series/batch_query_raw | batch_query_raw series_v2 -[**SeriesV2BatchQueryRawLastValue**](SeriesV2Api.md#SeriesV2BatchQueryRawLastValue) | **Post** /v2/series/batch_query_raw/lastvalue | batch_query_raw_last_value series_v2 -[**SeriesV2BatchQuerySampling**](SeriesV2Api.md#SeriesV2BatchQuerySampling) | **Post** /v2/series/batch_query_sampling | batch_query_sampling series_v2 -[**SeriesV2HistoricData**](SeriesV2Api.md#SeriesV2HistoricData) | **Post** /v2/series/historic_data | historic_data series_v2 - - - -## SeriesV2BatchQuery - -> ArduinoSeriesBatch SeriesV2BatchQuery(ctx).BatchQueryRequestsMediaV1(batchQueryRequestsMediaV1).XOrganization(xOrganization).Execute() - -batch_query series_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - "time" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - batchQueryRequestsMediaV1 := *openapiclient.NewBatchQueryRequestsMediaV1([]openapiclient.BatchQueryRequestMediaV1{*openapiclient.NewBatchQueryRequestMediaV1(time.Now(), "Q_example", time.Now())}, int64(123)) // BatchQueryRequestsMediaV1 | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.SeriesV2Api.SeriesV2BatchQuery(context.Background()).BatchQueryRequestsMediaV1(batchQueryRequestsMediaV1).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `SeriesV2Api.SeriesV2BatchQuery``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `SeriesV2BatchQuery`: ArduinoSeriesBatch - fmt.Fprintf(os.Stdout, "Response from `SeriesV2Api.SeriesV2BatchQuery`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSeriesV2BatchQueryRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batchQueryRequestsMediaV1** | [**BatchQueryRequestsMediaV1**](BatchQueryRequestsMediaV1.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoSeriesBatch**](ArduinoSeriesBatch.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.series.batch+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## SeriesV2BatchQueryRaw - -> ArduinoSeriesRawBatch SeriesV2BatchQueryRaw(ctx).BatchQueryRawRequestsMediaV1(batchQueryRawRequestsMediaV1).XOrganization(xOrganization).Execute() - -batch_query_raw series_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - batchQueryRawRequestsMediaV1 := *openapiclient.NewBatchQueryRawRequestsMediaV1([]openapiclient.BatchQueryRawRequestMediaV1{*openapiclient.NewBatchQueryRawRequestMediaV1("Q_example")}, int64(123)) // BatchQueryRawRequestsMediaV1 | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.SeriesV2Api.SeriesV2BatchQueryRaw(context.Background()).BatchQueryRawRequestsMediaV1(batchQueryRawRequestsMediaV1).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `SeriesV2Api.SeriesV2BatchQueryRaw``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `SeriesV2BatchQueryRaw`: ArduinoSeriesRawBatch - fmt.Fprintf(os.Stdout, "Response from `SeriesV2Api.SeriesV2BatchQueryRaw`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSeriesV2BatchQueryRawRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batchQueryRawRequestsMediaV1** | [**BatchQueryRawRequestsMediaV1**](BatchQueryRawRequestsMediaV1.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoSeriesRawBatch**](ArduinoSeriesRawBatch.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.series.raw.batch+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## SeriesV2BatchQueryRawLastValue - -> ArduinoSeriesRawBatchLastvalue SeriesV2BatchQueryRawLastValue(ctx).BatchLastValueRequestsMediaV1(batchLastValueRequestsMediaV1).XOrganization(xOrganization).Execute() - -batch_query_raw_last_value series_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - batchLastValueRequestsMediaV1 := *openapiclient.NewBatchLastValueRequestsMediaV1([]openapiclient.BatchQueryRawLastValueRequestMediaV1{*openapiclient.NewBatchQueryRawLastValueRequestMediaV1("PropertyId_example", "ThingId_example")}) // BatchLastValueRequestsMediaV1 | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.SeriesV2Api.SeriesV2BatchQueryRawLastValue(context.Background()).BatchLastValueRequestsMediaV1(batchLastValueRequestsMediaV1).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `SeriesV2Api.SeriesV2BatchQueryRawLastValue``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `SeriesV2BatchQueryRawLastValue`: ArduinoSeriesRawBatchLastvalue - fmt.Fprintf(os.Stdout, "Response from `SeriesV2Api.SeriesV2BatchQueryRawLastValue`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSeriesV2BatchQueryRawLastValueRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batchLastValueRequestsMediaV1** | [**BatchLastValueRequestsMediaV1**](BatchLastValueRequestsMediaV1.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoSeriesRawBatchLastvalue**](ArduinoSeriesRawBatchLastvalue.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.series.raw.batch.lastvalue+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## SeriesV2BatchQuerySampling - -> ArduinoSeriesBatchSampled SeriesV2BatchQuerySampling(ctx).BatchQuerySampledRequestsMediaV1(batchQuerySampledRequestsMediaV1).XOrganization(xOrganization).Execute() - -batch_query_sampling series_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - batchQuerySampledRequestsMediaV1 := *openapiclient.NewBatchQuerySampledRequestsMediaV1([]openapiclient.BatchQuerySampledRequestMediaV1{*openapiclient.NewBatchQuerySampledRequestMediaV1("Q_example")}, int64(123)) // BatchQuerySampledRequestsMediaV1 | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.SeriesV2Api.SeriesV2BatchQuerySampling(context.Background()).BatchQuerySampledRequestsMediaV1(batchQuerySampledRequestsMediaV1).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `SeriesV2Api.SeriesV2BatchQuerySampling``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `SeriesV2BatchQuerySampling`: ArduinoSeriesBatchSampled - fmt.Fprintf(os.Stdout, "Response from `SeriesV2Api.SeriesV2BatchQuerySampling`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSeriesV2BatchQuerySamplingRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batchQuerySampledRequestsMediaV1** | [**BatchQuerySampledRequestsMediaV1**](BatchQuerySampledRequestsMediaV1.md) | | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoSeriesBatchSampled**](ArduinoSeriesBatchSampled.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.series.batch.sampled+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## SeriesV2HistoricData - -> SeriesV2HistoricData(ctx).HistoricDataRequest(historicDataRequest).XOrganization(xOrganization).Execute() - -historic_data series_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - "time" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - historicDataRequest := *openapiclient.NewHistoricDataRequest(time.Now(), []string{"Properties_example"}, time.Now()) // HistoricDataRequest | - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.SeriesV2Api.SeriesV2HistoricData(context.Background()).HistoricDataRequest(historicDataRequest).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `SeriesV2Api.SeriesV2HistoricData``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSeriesV2HistoricDataRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **historicDataRequest** | [**HistoricDataRequest**](HistoricDataRequest.md) | | - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md deleted file mode 100644 index 220de8b..0000000 --- a/docs/TemplatesApi.md +++ /dev/null @@ -1,77 +0,0 @@ -# \TemplatesApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**TemplatesApply**](TemplatesApi.md#TemplatesApply) | **Put** /v1/templates | apply templates - - - -## TemplatesApply - -> ArduinoTemplate TemplatesApply(ctx).Template(template).XOrganization(xOrganization).Execute() - -apply templates - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - template := *openapiclient.NewTemplate("remote-controlled-lights") // Template | TemplatePayload describes the needed attribute to apply a template - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TemplatesApi.TemplatesApply(context.Background()).Template(template).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `TemplatesApi.TemplatesApply``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `TemplatesApply`: ArduinoTemplate - fmt.Fprintf(os.Stdout, "Response from `TemplatesApi.TemplatesApply`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiTemplatesApplyRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **template** | [**Template**](Template.md) | TemplatePayload describes the needed attribute to apply a template | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoTemplate**](ArduinoTemplate.md) - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.template+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/ThingsV1Api.md b/docs/ThingsV1Api.md deleted file mode 100644 index d139929..0000000 --- a/docs/ThingsV1Api.md +++ /dev/null @@ -1,382 +0,0 @@ -# \ThingsV1Api - -All URIs are relative to *http://api-dev.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ThingsV1Create**](ThingsV1Api.md#ThingsV1Create) | **Put** /v1/things | create things_v1 -[**ThingsV1CreateSketch**](ThingsV1Api.md#ThingsV1CreateSketch) | **Put** /v1/things/{id}/sketch | createSketch things_v1 -[**ThingsV1Delete**](ThingsV1Api.md#ThingsV1Delete) | **Delete** /v1/things/{id} | delete things_v1 -[**ThingsV1DeleteSketch**](ThingsV1Api.md#ThingsV1DeleteSketch) | **Delete** /v1/things/{id}/sketch | deleteSketch things_v1 -[**ThingsV1Layout**](ThingsV1Api.md#ThingsV1Layout) | **Get** /v1/things/{id}/layout | layout things_v1 -[**ThingsV1List**](ThingsV1Api.md#ThingsV1List) | **Get** /v1/things | list things_v1 -[**ThingsV1Show**](ThingsV1Api.md#ThingsV1Show) | **Get** /v1/things/{id} | show things_v1 -[**ThingsV1Update**](ThingsV1Api.md#ThingsV1Update) | **Post** /v1/things/{id} | update things_v1 -[**ThingsV1UpdateSketch**](ThingsV1Api.md#ThingsV1UpdateSketch) | **Put** /v1/things/{id}/sketch/{sketchId} | updateSketch things_v1 - - - -## ThingsV1Create - -> ArduinoThing ThingsV1Create(ctx, createThingsV1Payload, optional) -create things_v1 - -Creates a new thing associated to the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**createThingsV1Payload** | [**CreateThingsV1Payload**](CreateThingsV1Payload.md)| ThingPayload describes a thing | - **optional** | ***ThingsV1CreateOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1CreateOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **force** | **optional.Bool**| If true, detach device from the other thing, and attach to this thing | [default to false] - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1CreateSketch - -> ArduinoThing ThingsV1CreateSketch(ctx, id, thingSketch) -createSketch things_v1 - -Creates a new sketch thing associated to the thing - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**thingSketch** | [**ThingSketch**](ThingSketch.md)| ThingSketchPayload describes a sketch of a thing | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1Delete - -> ThingsV1Delete(ctx, id, optional) -delete things_v1 - -Removes a thing associated to the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | - **optional** | ***ThingsV1DeleteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1DeleteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **force** | **optional.Bool**| If true, hard delete the thing | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: Not defined - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1DeleteSketch - -> ArduinoThing ThingsV1DeleteSketch(ctx, id) -deleteSketch things_v1 - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1Layout - -> ArduinoThinglayout ThingsV1Layout(ctx, id, optional) -layout things_v1 - -Returns the thing requested by the user, without last values data - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | - **optional** | ***ThingsV1LayoutOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1LayoutOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **optional.Bool**| If true, shows the soft deleted thing | [default to false] - -### Return type - -[**ArduinoThinglayout**](ArduinoThinglayout.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thinglayout+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1List - -> []ArduinoThing ThingsV1List(ctx, optional) -list things_v1 - -Returns the list of things associated to the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***ThingsV1ListOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1ListOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **acrossUserIds** | **optional.Bool**| If true, returns all the things | [default to false] - **deviceId** | **optional.String**| The id of the device you want to filter | - **showDeleted** | **optional.Bool**| If true, shows the soft deleted things | [default to false] - -### Return type - -[**[]ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json; type=collection - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1Show - -> ArduinoThing ThingsV1Show(ctx, id, optional) -show things_v1 - -Returns the thing requested by the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | - **optional** | ***ThingsV1ShowOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1ShowOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **optional.Bool**| If true, shows the soft deleted thing | [default to false] - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1Update - -> ArduinoThing ThingsV1Update(ctx, id, thing, optional) -update things_v1 - -Updates a thing associated to the user - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**thing** | [**Thing**](Thing.md)| ThingPayload describes a thing | - **optional** | ***ThingsV1UpdateOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ThingsV1UpdateOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **force** | **optional.Bool**| If true, detach device from the other thing, and attach to this thing | [default to false] - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV1UpdateSketch - -> ArduinoThing ThingsV1UpdateSketch(ctx, id, sketchId) -updateSketch things_v1 - -Update an existing thing sketch - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| The id of the thing | -**sketchId** | **string**| The id of the sketch | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/ThingsV2Api.md b/docs/ThingsV2Api.md deleted file mode 100644 index b489c31..0000000 --- a/docs/ThingsV2Api.md +++ /dev/null @@ -1,755 +0,0 @@ -# \ThingsV2Api - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ThingsV2Clone**](ThingsV2Api.md#ThingsV2Clone) | **Put** /v2/things/{id}/clone | clone things_v2 -[**ThingsV2Create**](ThingsV2Api.md#ThingsV2Create) | **Put** /v2/things | create things_v2 -[**ThingsV2CreateSketch**](ThingsV2Api.md#ThingsV2CreateSketch) | **Put** /v2/things/{id}/sketch | createSketch things_v2 -[**ThingsV2Delete**](ThingsV2Api.md#ThingsV2Delete) | **Delete** /v2/things/{id} | delete things_v2 -[**ThingsV2DeleteSketch**](ThingsV2Api.md#ThingsV2DeleteSketch) | **Delete** /v2/things/{id}/sketch | deleteSketch things_v2 -[**ThingsV2List**](ThingsV2Api.md#ThingsV2List) | **Get** /v2/things | list things_v2 -[**ThingsV2Show**](ThingsV2Api.md#ThingsV2Show) | **Get** /v2/things/{id} | show things_v2 -[**ThingsV2Template**](ThingsV2Api.md#ThingsV2Template) | **Get** /v2/things/{id}/template | template things_v2 -[**ThingsV2Update**](ThingsV2Api.md#ThingsV2Update) | **Post** /v2/things/{id} | update things_v2 -[**ThingsV2UpdateSketch**](ThingsV2Api.md#ThingsV2UpdateSketch) | **Put** /v2/things/{id}/sketch/{sketchId} | updateSketch things_v2 - - - -## ThingsV2Clone - -> ArduinoThing ThingsV2Clone(ctx, id).ThingClone(thingClone).XOrganization(xOrganization).Execute() - -clone things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - thingClone := *openapiclient.NewThingClone("Name_example") // ThingClone | Payload to clone a new thing from an existing one - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2Clone(context.Background(), id).ThingClone(thingClone).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Clone``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2Clone`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2Clone`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2CloneRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **thingClone** | [**ThingClone**](ThingClone.md) | Payload to clone a new thing from an existing one | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2Create - -> ArduinoThing ThingsV2Create(ctx).ThingCreate(thingCreate).Force(force).XOrganization(xOrganization).Execute() - -create things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - thingCreate := *openapiclient.NewThingCreate() // ThingCreate | Payload to create a new thing - force := true // bool | If true, detach device from the other thing, and attach to this thing (optional) (default to false) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2Create(context.Background()).ThingCreate(thingCreate).Force(force).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Create``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2Create`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2Create`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2CreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **thingCreate** | [**ThingCreate**](ThingCreate.md) | Payload to create a new thing | - **force** | **bool** | If true, detach device from the other thing, and attach to this thing | [default to false] - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2CreateSketch - -> ArduinoThing ThingsV2CreateSketch(ctx, id).ThingSketch(thingSketch).XOrganization(xOrganization).Execute() - -createSketch things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - thingSketch := *openapiclient.NewThingSketch() // ThingSketch | ThingSketchPayload describes a sketch of a thing - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2CreateSketch(context.Background(), id).ThingSketch(thingSketch).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2CreateSketch``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2CreateSketch`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2CreateSketch`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2CreateSketchRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **thingSketch** | [**ThingSketch**](ThingSketch.md) | ThingSketchPayload describes a sketch of a thing | - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2Delete - -> ThingsV2Delete(ctx, id).Force(force).XOrganization(xOrganization).Execute() - -delete things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - force := true // bool | If true, hard delete the thing (optional) (default to false) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.ThingsV2Api.ThingsV2Delete(context.Background(), id).Force(force).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Delete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2DeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **force** | **bool** | If true, hard delete the thing | [default to false] - **xOrganization** | **string** | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2DeleteSketch - -> ArduinoThing ThingsV2DeleteSketch(ctx, id).XOrganization(xOrganization).Execute() - -deleteSketch things_v2 - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2DeleteSketch(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2DeleteSketch``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2DeleteSketch`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2DeleteSketch`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2DeleteSketchRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2List - -> []ArduinoThing ThingsV2List(ctx).AcrossUserIds(acrossUserIds).DeviceId(deviceId).Ids(ids).ShowDeleted(showDeleted).ShowProperties(showProperties).Tags(tags).XOrganization(xOrganization).Execute() - -list things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - acrossUserIds := true // bool | If true, returns all the things (optional) (default to false) - deviceId := "deviceId_example" // string | The id of the device you want to filter (optional) - ids := []string{"Inner_example"} // []string | Filter only the desired things (optional) - showDeleted := true // bool | If true, shows the soft deleted things (optional) (default to false) - showProperties := true // bool | If true, returns things with their properties, and last values (optional) (default to false) - tags := []string{"Inner_example"} // []string | Filter by tags (optional) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2List(context.Background()).AcrossUserIds(acrossUserIds).DeviceId(deviceId).Ids(ids).ShowDeleted(showDeleted).ShowProperties(showProperties).Tags(tags).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2List``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2List`: []ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2List`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2ListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **acrossUserIds** | **bool** | If true, returns all the things | [default to false] - **deviceId** | **string** | The id of the device you want to filter | - **ids** | **[]string** | Filter only the desired things | - **showDeleted** | **bool** | If true, shows the soft deleted things | [default to false] - **showProperties** | **bool** | If true, returns things with their properties, and last values | [default to false] - **tags** | **[]string** | Filter by tags | - **xOrganization** | **string** | | - -### Return type - -[**[]ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json; type=collection, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2Show - -> ArduinoThing ThingsV2Show(ctx, id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - -show things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - showDeleted := true // bool | If true, shows the soft deleted thing (optional) (default to false) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2Show(context.Background(), id).ShowDeleted(showDeleted).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Show``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2Show`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2Show`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2ShowRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **showDeleted** | **bool** | If true, shows the soft deleted thing | [default to false] - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2Template - -> ArduinoThingtemplate ThingsV2Template(ctx, id).XOrganization(xOrganization).Execute() - -template things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2Template(context.Background(), id).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Template``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2Template`: ArduinoThingtemplate - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2Template`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2TemplateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThingtemplate**](ArduinoThingtemplate.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.thingtemplate+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2Update - -> ArduinoThing ThingsV2Update(ctx, id).ThingUpdate(thingUpdate).Force(force).XOrganization(xOrganization).Execute() - -update things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - thingUpdate := *openapiclient.NewThingUpdate() // ThingUpdate | Payload to update an existing thing - force := true // bool | If true, detach device from the other thing, and attach to this thing (optional) (default to false) - xOrganization := "xOrganization_example" // string | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2Update(context.Background(), id).ThingUpdate(thingUpdate).Force(force).XOrganization(xOrganization).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2Update``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2Update`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2Update`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2UpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **thingUpdate** | [**ThingUpdate**](ThingUpdate.md) | Payload to update an existing thing | - **force** | **bool** | If true, detach device from the other thing, and attach to this thing | [default to false] - **xOrganization** | **string** | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2UpdateSketch - -> ArduinoThing ThingsV2UpdateSketch(ctx, id, sketchId).XOrganization(xOrganization).UpdateSketch(updateSketch).Execute() - -updateSketch things_v2 - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - sketchId := "sketchId_example" // string | The id of the sketch - xOrganization := "xOrganization_example" // string | (optional) - updateSketch := *openapiclient.NewUpdateSketch() // UpdateSketch | (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2Api.ThingsV2UpdateSketch(context.Background(), id, sketchId).XOrganization(xOrganization).UpdateSketch(updateSketch).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2Api.ThingsV2UpdateSketch``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2UpdateSketch`: ArduinoThing - fmt.Fprintf(os.Stdout, "Response from `ThingsV2Api.ThingsV2UpdateSketch`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**sketchId** | **string** | The id of the sketch | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2UpdateSketchRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **xOrganization** | **string** | | - **updateSketch** | [**UpdateSketch**](UpdateSketch.md) | | - -### Return type - -[**ArduinoThing**](ArduinoThing.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.arduino.thing+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/ThingsV2TagsApi.md b/docs/ThingsV2TagsApi.md deleted file mode 100644 index 6eae91b..0000000 --- a/docs/ThingsV2TagsApi.md +++ /dev/null @@ -1,222 +0,0 @@ -# \ThingsV2TagsApi - -All URIs are relative to *https://api2.arduino.cc/iot* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ThingsV2TagsDelete**](ThingsV2TagsApi.md#ThingsV2TagsDelete) | **Delete** /v2/things/{id}/tags/{key} | delete things_v2_tags -[**ThingsV2TagsList**](ThingsV2TagsApi.md#ThingsV2TagsList) | **Get** /v2/things/{id}/tags | list things_v2_tags -[**ThingsV2TagsUpsert**](ThingsV2TagsApi.md#ThingsV2TagsUpsert) | **Put** /v2/things/{id}/tags | upsert things_v2_tags - - - -## ThingsV2TagsDelete - -> ThingsV2TagsDelete(ctx, id, key).Execute() - -delete things_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - key := "key_example" // string | The key of the tag - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.ThingsV2TagsApi.ThingsV2TagsDelete(context.Background(), id, key).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2TagsApi.ThingsV2TagsDelete``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | -**key** | **string** | The key of the tag | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2TagsDeleteRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2TagsList - -> ArduinoTags ThingsV2TagsList(ctx, id).Execute() - -list things_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ThingsV2TagsApi.ThingsV2TagsList(context.Background(), id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2TagsApi.ThingsV2TagsList``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ThingsV2TagsList`: ArduinoTags - fmt.Fprintf(os.Stdout, "Response from `ThingsV2TagsApi.ThingsV2TagsList`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2TagsListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - -### Return type - -[**ArduinoTags**](ArduinoTags.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/vnd.arduino.tags+json, application/vnd.goa.error+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ThingsV2TagsUpsert - -> ThingsV2TagsUpsert(ctx, id).Tag(tag).Execute() - -upsert things_v2_tags - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/arduino/iot-client-go/v2" -) - -func main() { - id := "id_example" // string | The id of the thing - tag := *openapiclient.NewTag("Key_example", "Value_example") // Tag | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.ThingsV2TagsApi.ThingsV2TagsUpsert(context.Background(), id).Tag(tag).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `ThingsV2TagsApi.ThingsV2TagsUpsert``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | The id of the thing | - -### Other Parameters - -Other parameters are passed through a pointer to a apiThingsV2TagsUpsertRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **tag** | [**Tag**](Tag.md) | | - -### Return type - - (empty response body) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded -- **Accept**: application/vnd.goa.error+json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) -