Skip to content

Latest commit

 

History

History
251 lines (162 loc) · 7.5 KB

PrivacyApi.md

File metadata and controls

251 lines (162 loc) · 7.5 KB

Sendbird.PrivacyApi

All URIs are relative to https://api-APP_ID.sendbird.com

Method HTTP request Description
cancelTheRegistrationOfGdprRequestById DELETE /v3/privacy/gdpr/{request_id} Cancel the registration of a GDPR request
listGdprRequests GET /v3/privacy/gdpr List GDPR requests
registerGdprRequest POST /v3/privacy/gdpr Register a GDPR request
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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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 and right to object will be available soon. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-register-a-gdpr-request

Example

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]