254 lines
6.0 KiB
Markdown
254 lines
6.0 KiB
Markdown
# \DoorAPI
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**CloseDoorApiV1DoorClosePut**](DoorAPI.md#CloseDoorApiV1DoorClosePut) | **Put** /api/v1/door/close | Close Door
|
|
[**IsDoorOpenApiV1DoorStatusPut**](DoorAPI.md#IsDoorOpenApiV1DoorStatusPut) | **Put** /api/v1/door/status | Is Door Open
|
|
[**OpenDoorApiV1DoorOpenPut**](DoorAPI.md#OpenDoorApiV1DoorOpenPut) | **Put** /api/v1/door/open | Open Door
|
|
[**TestAccessApiV1DoorTestPost**](DoorAPI.md#TestAccessApiV1DoorTestPost) | **Post** /api/v1/door/test | Test Access
|
|
|
|
|
|
|
|
## CloseDoorApiV1DoorClosePut
|
|
|
|
> interface{} CloseDoorApiV1DoorClosePut(ctx).Execute()
|
|
|
|
Close Door
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.DoorAPI.CloseDoorApiV1DoorClosePut(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.CloseDoorApiV1DoorClosePut``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `CloseDoorApiV1DoorClosePut`: interface{}
|
|
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.CloseDoorApiV1DoorClosePut`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiCloseDoorApiV1DoorClosePutRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
**interface{}**
|
|
|
|
### Authorization
|
|
|
|
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/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)
|
|
|
|
|
|
## IsDoorOpenApiV1DoorStatusPut
|
|
|
|
> interface{} IsDoorOpenApiV1DoorStatusPut(ctx).Execute()
|
|
|
|
Is Door Open
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.DoorAPI.IsDoorOpenApiV1DoorStatusPut(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.IsDoorOpenApiV1DoorStatusPut``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `IsDoorOpenApiV1DoorStatusPut`: interface{}
|
|
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.IsDoorOpenApiV1DoorStatusPut`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiIsDoorOpenApiV1DoorStatusPutRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
**interface{}**
|
|
|
|
### Authorization
|
|
|
|
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/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)
|
|
|
|
|
|
## OpenDoorApiV1DoorOpenPut
|
|
|
|
> interface{} OpenDoorApiV1DoorOpenPut(ctx).Execute()
|
|
|
|
Open Door
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.DoorAPI.OpenDoorApiV1DoorOpenPut(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.OpenDoorApiV1DoorOpenPut``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `OpenDoorApiV1DoorOpenPut`: interface{}
|
|
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.OpenDoorApiV1DoorOpenPut`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiOpenDoorApiV1DoorOpenPutRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
**interface{}**
|
|
|
|
### Authorization
|
|
|
|
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/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)
|
|
|
|
|
|
## TestAccessApiV1DoorTestPost
|
|
|
|
> interface{} TestAccessApiV1DoorTestPost(ctx).Input(input).Execute()
|
|
|
|
Test Access
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
|
)
|
|
|
|
func main() {
|
|
input := "input_example" // string |
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.DoorAPI.TestAccessApiV1DoorTestPost(context.Background()).Input(input).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.TestAccessApiV1DoorTestPost``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `TestAccessApiV1DoorTestPost`: interface{}
|
|
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.TestAccessApiV1DoorTestPost`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiTestAccessApiV1DoorTestPostRequest struct via the builder pattern
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**input** | **string** | |
|
|
|
|
### Return type
|
|
|
|
**interface{}**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/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)
|
|
|