chatkitty/docs/ApplicationApi.md

OpenAPI client for chatkitty

# ApplicationApi

All URIs are relative to *https://api.chatkitty.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**retrieveApplication**](#retrieveapplication) | **GET** /application | Retrieve the authenticated application|
|[**retrieveApplicationMessageReadReceiptSummaries**](#retrieveapplicationmessagereadreceiptsummaries) | **GET** /application/message-read-receipt-summaries | Retrieve the authenticated application message read receipt summaries|
|[**retrieveApplicationSettings**](#retrieveapplicationsettings) | **GET** /application/settings | Retrieve the authenticated application settings|
|[**updateApplicationSettings**](#updateapplicationsettings) | **PUT** /application/settings | Update the authenticated application settings|

# **retrieveApplication**
> ApplicationResource retrieveApplication()

Returns the ChatKitty application associated with the authentication credentials used.  You must use an **OAuth V2 Bearer token** to access this endpoint.

### Example

```typescript
import {
    ApplicationApi,
    Configuration
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new ApplicationApi(configuration);

const { status, data } = await apiInstance.retrieveApplication();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ApplicationResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/vnd.chatkitty.v1+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**404** | Resource not found |  -  |
|**403** | Access is denied |  -  |
|**400** | Client error |  -  |
|**401** | Unauthorized: Full authentication is required to access this resource |  -  |
|**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)

# **retrieveApplicationMessageReadReceiptSummaries**
> PagedModelMessageReadReceiptSummaryResource retrieveApplicationMessageReadReceiptSummaries()

Returns the message read receipt summaries for the authenticated application

### Example

```typescript
import {
    ApplicationApi,
    Configuration,
    Pageable
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new ApplicationApi(configuration);

let pageable: Pageable; // (default to undefined)

const { status, data } = await apiInstance.retrieveApplicationMessageReadReceiptSummaries(
    pageable
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **pageable** | **Pageable** |  | defaults to undefined|


### Return type

**PagedModelMessageReadReceiptSummaryResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.chatkitty+json


### 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)

# **retrieveApplicationSettings**
> ApplicationSettingsResource retrieveApplicationSettings()

Returns the current settings configuring this application

### Example

```typescript
import {
    ApplicationApi,
    Configuration
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new ApplicationApi(configuration);

const { status, data } = await apiInstance.retrieveApplicationSettings();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ApplicationSettingsResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/vnd.chatkitty.v1+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**404** | Resource not found |  -  |
|**403** | Access is denied |  -  |
|**400** | Client error |  -  |
|**401** | Unauthorized: Full authentication is required to access this resource |  -  |
|**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)

# **updateApplicationSettings**
> ApplicationSettingsResource updateApplicationSettings(applicationSettingsResource)

Update the settings configuring this application

### Example

```typescript
import {
    ApplicationApi,
    Configuration,
    ApplicationSettingsResource
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new ApplicationApi(configuration);

let applicationSettingsResource: ApplicationSettingsResource; //

const { status, data } = await apiInstance.updateApplicationSettings(
    applicationSettingsResource
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **applicationSettingsResource** | **ApplicationSettingsResource**|  | |


### Return type

**ApplicationSettingsResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: application/vnd.chatkitty+json
 - **Accept**: application/json, application/vnd.chatkitty.v1+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**404** | Resource not found |  -  |
|**403** | Access is denied |  -  |
|**400** | Client error |  -  |
|**401** | Unauthorized: Full authentication is required to access this resource |  -  |
|**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)