@sendbird/sendbird-platform-sdk-typescript 2.0.0 → 2.1.1

package/PrivacyApi.md

@@ -1,251 +0,0 @@
-# Sendbird.PrivacyApi
-
-All URIs are relative to *https://api-APP_ID.sendbird.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**cancelTheRegistrationOfGdprRequestById**](PrivacyApi.md#cancelTheRegistrationOfGdprRequestById) | **DELETE** /v3/privacy/gdpr/{request_id} | Cancel the registration of a GDPR request
-[**listGdprRequests**](PrivacyApi.md#listGdprRequests) | **GET** /v3/privacy/gdpr | List GDPR requests
-[**registerGdprRequest**](PrivacyApi.md#registerGdprRequest) | **POST** /v3/privacy/gdpr | Register a GDPR request
-[**viewGdprRequestById**](PrivacyApi.md#viewGdprRequestById) | **GET** /v3/privacy/gdpr/{request_id} | View a GDPR request
-
-
-# **cancelTheRegistrationOfGdprRequestById**
-> void cancelTheRegistrationOfGdprRequestById()
-
-## Cancel the registration of a GDPR request  Cancels the registration of a specific GDPR request.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-cancel-the-registration-of-a-gdpr-request ----------------------------
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PrivacyApi(configuration);
-
-let body:Sendbird.PrivacyApiCancelTheRegistrationOfGdprRequestByIdRequest = {
-  // string
-  requestId: "request_id_example",
-  // string (optional)
-  apiToken: "{{API_TOKEN}}",
-};
-
-apiInstance.cancelTheRegistrationOfGdprRequestById(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **requestId** | [**string**] |  | defaults to undefined
- **apiToken** | [**string**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**void**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-# **listGdprRequests**
-> ListGdprRequestsResponse listGdprRequests()
-
-## List GDPR requests  Retrieves a list of GDPR requests of all types.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-list-gdpr-requests ----------------------------
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PrivacyApi(configuration);
-
-let body:Sendbird.PrivacyApiListGdprRequestsRequest = {
-  // string (optional)
-  apiToken: "{{API_TOKEN}}",
-  // string (optional)
-  token: "token_example",
-  // number (optional)
-  limit: 1,
-};
-
-apiInstance.listGdprRequests(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **apiToken** | [**string**] |  | (optional) defaults to undefined
- **token** | [**string**] |  | (optional) defaults to undefined
- **limit** | [**number**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**ListGdprRequestsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-# **registerGdprRequest**
-> RegisterGdprRequestResponse registerGdprRequest()
-
-## Register a GDPR request  Registers a specific type of GDPR request to meet the GDPR's requirements.  > __Note__: Currently, only delete and access of the user data are supported. The features for the [right to restriction of processing](https://gdpr-info.eu/art-18-gdpr/) and [right to object](https://gdpr-info.eu/art-21-gdpr/) will be available soon.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-register-a-gdpr-request
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PrivacyApi(configuration);
-
-let body:Sendbird.PrivacyApiRegisterGdprRequestRequest = {
-  // string (optional)
-  apiToken: "{{API_TOKEN}}",
-  // RegisterGdprRequestData (optional)
-  registerGdprRequestData: {
-    action: "action_example",
-    userIds: [
-      "userIds_example",
-    ],
-    channelDeleteOption: "channelDeleteOption_example",
-    userId: "userId_example",
-  },
-};
-
-apiInstance.registerGdprRequest(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registerGdprRequestData** | **RegisterGdprRequestData**|  |
- **apiToken** | [**string**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**RegisterGdprRequestResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-# **viewGdprRequestById**
-> ViewGdprRequestByIdResponse viewGdprRequestById()
-
-## View a GDPR request  Retrieves a specific GDPR request.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-view-a-gdpr-request ----------------------------
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PrivacyApi(configuration);
-
-let body:Sendbird.PrivacyApiViewGdprRequestByIdRequest = {
-  // string
-  requestId: "request_id_example",
-  // string (optional)
-  apiToken: "{{API_TOKEN}}",
-};
-
-apiInstance.viewGdprRequestById(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **requestId** | [**string**] |  | defaults to undefined
- **apiToken** | [**string**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**ViewGdprRequestByIdResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-

package/PushNotificationsApi.md

@@ -1,124 +0,0 @@
-# Sendbird.PushNotificationsApi
-
-All URIs are relative to *https://api-APP_ID.sendbird.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**v3ApplicationsPushSettingsGet**](PushNotificationsApi.md#v3ApplicationsPushSettingsGet) | **GET** /v3/applications/push/settings | Check push notifications
-[**v3ApplicationsPushSettingsPut**](PushNotificationsApi.md#v3ApplicationsPushSettingsPut) | **PUT** /v3/applications/push/settings | Turn on push notifications
-
-
-# **v3ApplicationsPushSettingsGet**
-> V3ApplicationsPushSettingsGet200Response v3ApplicationsPushSettingsGet()
-
-## Check push notifications Shows whether the push notifications feature is turned on for an application. https://sendbird.com/docs/chat/v3/platform-api/application/managing-notifications/check-push-notifications -----------------------------  
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PushNotificationsApi(configuration);
-
-let body:Sendbird.PushNotificationsApiV3ApplicationsPushSettingsGetRequest = {
-  // string (optional)
-  apiToken: "Api-Token_example",
-};
-
-apiInstance.v3ApplicationsPushSettingsGet(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **apiToken** | [**string**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**V3ApplicationsPushSettingsGet200Response**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-# **v3ApplicationsPushSettingsPut**
-> ListPushConfigurationsResponse v3ApplicationsPushSettingsPut()
-
-## Turn on push notifications Determines whether to turn on the push notifications feature for an application. https://sendbird.com/docs/chat/v3/platform-api/application/managing-notifications/turn-on-push-notifications -----------------------------  
-
-### Example
-
-
-```typescript
-import { Sendbird } from 'sendbird-platform-sdk';
-import * as fs from 'fs';
-
-const configuration = Sendbird.createConfiguration();
-const apiInstance = new Sendbird.PushNotificationsApi(configuration);
-
-let body:Sendbird.PushNotificationsApiV3ApplicationsPushSettingsPutRequest = {
-  // string (optional)
-  apiToken: "Api-Token_example",
-  // V3ApplicationsPushSettingsGetRequest (optional)
-  v3ApplicationsPushSettingsGetRequest: {
-    pushEnabled: true,
-  },
-};
-
-apiInstance.v3ApplicationsPushSettingsPut(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **v3ApplicationsPushSettingsGetRequest** | **V3ApplicationsPushSettingsGetRequest**|  |
- **apiToken** | [**string**] |  | (optional) defaults to undefined
-
-
-### Return type
-
-**ListPushConfigurationsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful response |  -  |
-
-[[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)
-
-