orchestrator-swagger-go-client/docs/UserMessageApi.md

83 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

# \UserMessageApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**PlugMessagesPlugIdentifierUserSourceIdGet**](UserMessageApi.md#PlugMessagesPlugIdentifierUserSourceIdGet) | **Get** /plug/messages/{plug_identifier}/{user_source_id} | Get all Messages from a user
## PlugMessagesPlugIdentifierUserSourceIdGet
> []TaskMessage PlugMessagesPlugIdentifierUserSourceIdGet(ctx, userSourceId, plugIdentifier).Execute()
Get all Messages from a user
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userSourceId := "userSourceId_example" // string | User Source ID
plugIdentifier := "plugIdentifier_example" // string | Plug Identifier
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserMessageApi.PlugMessagesPlugIdentifierUserSourceIdGet(context.Background(), userSourceId, plugIdentifier).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserMessageApi.PlugMessagesPlugIdentifierUserSourceIdGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PlugMessagesPlugIdentifierUserSourceIdGet`: []TaskMessage
fmt.Fprintf(os.Stdout, "Response from `UserMessageApi.PlugMessagesPlugIdentifierUserSourceIdGet`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**userSourceId** | **string** | User Source ID |
**plugIdentifier** | **string** | Plug Identifier |
### Other Parameters
Other parameters are passed through a pointer to a apiPlugMessagesPlugIdentifierUserSourceIdGetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**[]TaskMessage**](TaskMessage.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
[[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)