What genuine fuck just happened ?
This commit is contained in:
142
api-customer/api-resources/message-components/docs/MessageApi.md
Normal file
142
api-customer/api-resources/message-components/docs/MessageApi.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# board_mate.message.MessageApi
|
||||
|
||||
All URIs are relative to *https://boardmate_api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**history**](MessageApi.md#history) | **GET** /message/history/{clientId} | GET message/history/{clientId}
|
||||
[**post_message**](MessageApi.md#post_message) | **POST** /message/send | POST message/send
|
||||
|
||||
|
||||
# **history**
|
||||
> List[ResponseBodyListMessageDto] history(client_id, top=top)
|
||||
|
||||
GET message/history/{clientId}
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import board_mate.message
|
||||
from board_mate.message.models.response_body_list_message_dto import ResponseBodyListMessageDto
|
||||
from board_mate.message.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://boardmate_api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = board_mate.message.Configuration(
|
||||
host = "https://boardmate_api"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with board_mate.message.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = board_mate.message.MessageApi(api_client)
|
||||
client_id = 'client_id_example' # str |
|
||||
top = 20 # int | (optional) (default to 20)
|
||||
|
||||
try:
|
||||
# GET message/history/{clientId}
|
||||
api_response = api_instance.history(client_id, top=top)
|
||||
print("The response of MessageApi->history:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling MessageApi->history: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**client_id** | **str**| |
|
||||
**top** | **int**| | [optional] [default to 20]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[ResponseBodyListMessageDto]**](ResponseBodyListMessageDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: */*
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **post_message**
|
||||
> str post_message(message_post_request_dto)
|
||||
|
||||
POST message/send
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import board_mate.message
|
||||
from board_mate.message.models.message_post_request_dto import MessagePostRequestDto
|
||||
from board_mate.message.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://boardmate_api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = board_mate.message.Configuration(
|
||||
host = "https://boardmate_api"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with board_mate.message.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = board_mate.message.MessageApi(api_client)
|
||||
message_post_request_dto = board_mate.message.MessagePostRequestDto() # MessagePostRequestDto |
|
||||
|
||||
try:
|
||||
# POST message/send
|
||||
api_response = api_instance.post_message(message_post_request_dto)
|
||||
print("The response of MessageApi->post_message:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling MessageApi->post_message: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**message_post_request_dto** | [**MessagePostRequestDto**](MessagePostRequestDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
**str**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: */*
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
|
||||
[[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)
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# MessageDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **str** | | [optional]
|
||||
**timestamp** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.message.models.message_dto import MessageDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of MessageDto from a JSON string
|
||||
message_dto_instance = MessageDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print MessageDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
message_dto_dict = message_dto_instance.to_dict()
|
||||
# create an instance of MessageDto from a dict
|
||||
message_dto_form_dict = message_dto.from_dict(message_dto_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# MessagePostRequestDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **str** | | [optional]
|
||||
**client_id** | **str** | | [optional]
|
||||
**time_stamp** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.message.models.message_post_request_dto import MessagePostRequestDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of MessagePostRequestDto from a JSON string
|
||||
message_post_request_dto_instance = MessagePostRequestDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print MessagePostRequestDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
message_post_request_dto_dict = message_post_request_dto_instance.to_dict()
|
||||
# create an instance of MessagePostRequestDto from a dict
|
||||
message_post_request_dto_form_dict = message_post_request_dto.from_dict(message_post_request_dto_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# ResponseBodyListMessageDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**List[MessageDto]**](MessageDto.md) | | [optional]
|
||||
**message** | **str** | | [optional]
|
||||
**success** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.message.models.response_body_list_message_dto import ResponseBodyListMessageDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ResponseBodyListMessageDto from a JSON string
|
||||
response_body_list_message_dto_instance = ResponseBodyListMessageDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ResponseBodyListMessageDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
response_body_list_message_dto_dict = response_body_list_message_dto_instance.to_dict()
|
||||
# create an instance of ResponseBodyListMessageDto from a dict
|
||||
response_body_list_message_dto_form_dict = response_body_list_message_dto.from_dict(response_body_list_message_dto_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user