@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/WebhookApi.md

@@ -0,0 +1,132 @@
+# Sendbird.WebhookApi
+
+All URIs are relative to *https://api-APP_ID.sendbird.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**chooseWhichEventsToSubscribeTo**](WebhookApi.md#chooseWhichEventsToSubscribeTo) | **PUT** /v3/applications/settings/webhook | Choose which events to subscribe to
+[**retrieveListOfSubscribedEvents**](WebhookApi.md#retrieveListOfSubscribedEvents) | **GET** /v3/applications/settings/webhook | Retrieve a list of subscribed events
+
+
+# **chooseWhichEventsToSubscribeTo**
+> ChooseWhichEventsToSubscribeToResponse chooseWhichEventsToSubscribeTo()
+
+## Choose which events to subscribe to  Chooses which events for your webhook server to receive payloads for. By subscribing to specific events based on your own needs, you can control the number of HTTP requests to your webhook server.  https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-choose-which-events-to-subscribe-to
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.WebhookApi(configuration);
+
+let body:Sendbird.WebhookApiChooseWhichEventsToSubscribeToRequest = {
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+  // ChooseWhichEventsToSubscribeToData (optional)
+  chooseWhichEventsToSubscribeToData: {
+    enabled: true,
+    url: "url_example",
+    includeMembers: true,
+    enabledEvents: [
+      "enabledEvents_example",
+    ],
+  },
+};
+
+apiInstance.chooseWhichEventsToSubscribeTo(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **chooseWhichEventsToSubscribeToData** | **ChooseWhichEventsToSubscribeToData**|  |
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**ChooseWhichEventsToSubscribeToResponse**
+
+### 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)
+
+# **retrieveListOfSubscribedEvents**
+> RetrieveListOfSubscribedEventsResponse retrieveListOfSubscribedEvents()
+
+## Retrieve a list of subscribed events  Retrieves a list of events for your webhook server to receive payloads for.  https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-retrieve-a-list-of-subscribed-events ----------------------------
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.WebhookApi(configuration);
+
+let body:Sendbird.WebhookApiRetrieveListOfSubscribedEventsRequest = {
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+  // boolean (optional)
+  displayAllWebhookCategories: true,
+};
+
+apiInstance.retrieveListOfSubscribedEvents(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
+ **displayAllWebhookCategories** | [**boolean**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**RetrieveListOfSubscribedEventsResponse**
+
+### 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/apis/AnnouncementApi.ts

@@ -0,0 +1,96 @@
+// TODO: better import syntax?
+import {BaseAPIRequestFactory, RequiredError} from './baseapi';
+import {Configuration} from '../configuration';
+import {RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http';
+import * as FormData from "form-data";
+import { URLSearchParams } from 'url';
+import {ObjectSerializer} from '../models/ObjectSerializer';
+import {ApiException} from './exception';
+import {canConsumeForm, isCodeInRange} from '../util';
+import {SecurityAuthentication} from '../auth/auth';
+
+
+import { ScheduleAnAnnouncementRequest } from '../models/ScheduleAnAnnouncementRequest';
+import { ScheduleAnAnnouncementResponse } from '../models/ScheduleAnAnnouncementResponse';
+
+/**
+ * no description
+ */
+export class AnnouncementApiRequestFactory extends BaseAPIRequestFactory {
+
+    /**
+     * ## Schedule an announcement  Creates an announcement. You can also schedule an announcement in the [Sendbird Dashboard](https://dashboard.sendbird.com).  [https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement](https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement)
+     * Schedule an announcement
+     * @param apiToken 
+     * @param scheduleAnAnnouncementRequest 
+     */
+    public async scheduleAnAnnouncement(apiToken?: string, scheduleAnAnnouncementRequest?: ScheduleAnAnnouncementRequest, _options?: Configuration): Promise<RequestContext> {
+        let _config = _options || this.configuration;
+
+
+
+        // Path Params
+        const localVarPath = '/v3/announcements';
+
+        // Make Request Context
+        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST);
+        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
+
+        // Header Params
+        requestContext.setHeaderParam("api-token", ObjectSerializer.serialize(apiToken, "string", ""));
+
+
+        // Body Params
+        const contentType = ObjectSerializer.getPreferredMediaType([
+            "application/json"
+        ]);
+        requestContext.setHeaderParam("Content-Type", contentType);
+        const serializedBody = ObjectSerializer.stringify(
+            ObjectSerializer.serialize(scheduleAnAnnouncementRequest, "ScheduleAnAnnouncementRequest", ""),
+            contentType
+        );
+        requestContext.setBody(serializedBody);
+
+        
+        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        if (defaultAuth?.applySecurityAuthentication) {
+            await defaultAuth?.applySecurityAuthentication(requestContext);
+        }
+
+        return requestContext;
+    }
+
+}
+
+export class AnnouncementApiResponseProcessor {
+
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to scheduleAnAnnouncement
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+     public async scheduleAnAnnouncement(response: ResponseContext): Promise<ScheduleAnAnnouncementResponse > {
+        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+        if (isCodeInRange("200", response.httpStatusCode)) {
+            const body: ScheduleAnAnnouncementResponse = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "ScheduleAnAnnouncementResponse", ""
+            ) as ScheduleAnAnnouncementResponse;
+            return body;
+        }
+
+        // Work around for missing responses in specification, e.g. for petstore.yaml
+        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+            const body: ScheduleAnAnnouncementResponse = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "ScheduleAnAnnouncementResponse", ""
+            ) as ScheduleAnAnnouncementResponse;
+            return body;
+        }
+
+        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
+    }
+
+}