Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update the Bot SendMessage's request/response spec #18

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ hs_err_pid*
target
.gradle
build

# etc
README.md-e
2 changes: 1 addition & 1 deletion .idea/compiler.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .idea/gradle.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions .idea/jarRepositories.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ docs/SendBirdBaseChannel.md
docs/SendBirdBaseMessageInstance.md
docs/SendBirdBotsMessageResponse.md
docs/SendBirdBotsMessageResponseMessage.md
docs/SendBirdBotsMessageResponseMessageExtendedMessagePayload.md
docs/SendBirdBotsMessageResponseMessageMessageEvents.md
docs/SendBirdChannelResponse.md
docs/SendBirdEmoji.md
Expand Down Expand Up @@ -246,6 +247,7 @@ docs/SendBirdThumbnailSize.md
docs/SendBirdUser.md
docs/SendBirdUserMessageParams.md
docs/SendBotSMessageData.md
docs/SendBotSMessageDataExtendedMessagePayload.md
docs/SendMessageData.md
docs/SetDomainFilterData.md
docs/SetDomainFilterDataDomainFilter.md
Expand Down Expand Up @@ -533,6 +535,7 @@ src/main/java/org/openapitools/client/model/SendBirdBaseChannel.java
src/main/java/org/openapitools/client/model/SendBirdBaseMessageInstance.java
src/main/java/org/openapitools/client/model/SendBirdBotsMessageResponse.java
src/main/java/org/openapitools/client/model/SendBirdBotsMessageResponseMessage.java
src/main/java/org/openapitools/client/model/SendBirdBotsMessageResponseMessageExtendedMessagePayload.java
src/main/java/org/openapitools/client/model/SendBirdBotsMessageResponseMessageMessageEvents.java
src/main/java/org/openapitools/client/model/SendBirdChannelResponse.java
src/main/java/org/openapitools/client/model/SendBirdEmoji.java
Expand Down Expand Up @@ -567,6 +570,7 @@ src/main/java/org/openapitools/client/model/SendBirdThumbnailSize.java
src/main/java/org/openapitools/client/model/SendBirdUser.java
src/main/java/org/openapitools/client/model/SendBirdUserMessageParams.java
src/main/java/org/openapitools/client/model/SendBotSMessageData.java
src/main/java/org/openapitools/client/model/SendBotSMessageDataExtendedMessagePayload.java
src/main/java/org/openapitools/client/model/SendMessageData.java
src/main/java/org/openapitools/client/model/SetDomainFilterData.java
src/main/java/org/openapitools/client/model/SetDomainFilterDataDomainFilter.java
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Add these dependency to your project's POM:
<dependency>
<groupId>org.sendbird</groupId>
<artifactId>sendbird-platform-sdk</artifactId>
<version>1.0.17</version>
<version>1.0.18</version>
</dependency>
</dependencies>
```
Expand All @@ -103,7 +103,7 @@ Add this dependency to your project's build file:
```groovy

dependencies {
implementation "org.sendbird:sendbird-platform-sdk:1.0.17"
implementation "org.sendbird:sendbird-platform-sdk:1.0.18"
}

allprojects {
Expand Down
43 changes: 43 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10925,6 +10925,11 @@ components:
message_retention_hour: 1.4658129805029452
updated_at: 6.027456183070403
translations: "{}"
extended_message_payload:
suggested_replies:
- suggested_replies
- suggested_replies
custom_view: "{}"
mentioned_users:
- metadata:
anyOf: anyOf
Expand Down Expand Up @@ -21386,6 +21391,21 @@ components:
- channel_urls
title: joinChannelsData
type: object
sendBot_sMessageData_extended_message_payload:
description: Specifies the extended message payload which is used to send a
message with a custom message type.
properties:
suggested_replies:
description: Specifies an array of suggested replies to be sent with the
message.
items:
type: string
type: array
custom_view:
description: "JSON format you want to embed in message, eq : {\"title\"\
: \"title\", \"image\": \"https://link.to/image.jpg\"}"
type: object
type: object
sendBot_sMessageData:
properties:
message:
Expand Down Expand Up @@ -21426,6 +21446,8 @@ components:
description: "Specifies the time that the message was sent, in [Unix milliseconds](/docs/chat/v3/platform-api/guides/miscellaneous#2-timestamps)\
\ format."
type: integer
extended_message_payload:
$ref: '#/components/schemas/sendBot_sMessageData_extended_message_payload'
required:
- channel_url
- message
Expand Down Expand Up @@ -21945,6 +21967,20 @@ components:
update_last_message:
type: boolean
type: object
SendBird_BotsMessageResponse_message_extended_message_payload:
example:
suggested_replies:
- suggested_replies
- suggested_replies
custom_view: "{}"
properties:
suggested_replies:
items:
type: string
type: array
custom_view:
type: object
type: object
SendBird_BotsMessageResponse_message:
example:
silent: true
Expand All @@ -21967,6 +22003,11 @@ components:
message_retention_hour: 1.4658129805029452
updated_at: 6.027456183070403
translations: "{}"
extended_message_payload:
suggested_replies:
- suggested_replies
- suggested_replies
custom_view: "{}"
mentioned_users:
- metadata:
anyOf: anyOf
Expand Down Expand Up @@ -22032,6 +22073,8 @@ components:
type: number
message_events:
$ref: '#/components/schemas/SendBird_BotsMessageResponse_message_message_events'
extended_message_payload:
$ref: '#/components/schemas/SendBird_BotsMessageResponse_message_extended_message_payload'
type: object
SendBird_GroupChannel_created_by:
example:
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'com.diffplug.spotless'

group = 'org.sendbird'
version = '1.0.17'
version = '1.0.18'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "org.sendbird",
name := "sendbird-platform-sdk",
version := "1.0.17",
version := "1.0.18",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
Compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 1 addition & 0 deletions docs/SendBirdBotsMessageResponseMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
|**channelUrl** | **String** | | [optional] |
|**messageId** | **BigDecimal** | | [optional] |
|**messageEvents** | [**SendBirdBotsMessageResponseMessageMessageEvents**](SendBirdBotsMessageResponseMessageMessageEvents.md) | | [optional] |
|**extendedMessagePayload** | [**SendBirdBotsMessageResponseMessageExtendedMessagePayload**](SendBirdBotsMessageResponseMessageExtendedMessagePayload.md) | | [optional] |



14 changes: 14 additions & 0 deletions docs/SendBirdBotsMessageResponseMessageExtendedMessagePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# SendBirdBotsMessageResponseMessageExtendedMessagePayload


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**suggestedReplies** | **List&lt;String&gt;** | | [optional] |
|**customView** | **Object** | | [optional] |



1 change: 1 addition & 0 deletions docs/SendBotSMessageData.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
|**markAsRead** | **Boolean** | Determines whether to mark the message as read for the bot. If set to false, the bot&#39;s unread_count and read_receipt remain unchanged after the message is sent. (Default: true) | [optional] |
|**dedupId** | **String** | Specifies the unique ID for the message to prevent the same message data from getting sent to the channel. | [optional] |
|**createdAt** | **Integer** | Specifies the time that the message was sent, in [Unix milliseconds](/docs/chat/v3/platform-api/guides/miscellaneous#2-timestamps) format. | [optional] |
|**extendedMessagePayload** | [**SendBotSMessageDataExtendedMessagePayload**](SendBotSMessageDataExtendedMessagePayload.md) | | [optional] |



15 changes: 15 additions & 0 deletions docs/SendBotSMessageDataExtendedMessagePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# SendBotSMessageDataExtendedMessagePayload

Specifies the extended message payload which is used to send a message with a custom message type.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**suggestedReplies** | **List&lt;String&gt;** | Specifies an array of suggested replies to be sent with the message. | [optional] |
|**customView** | **Object** | JSON format you want to embed in message, eq : {\&quot;title\&quot;: \&quot;title\&quot;, \&quot;image\&quot;: \&quot;https://link.to/image.jpg\&quot;} | [optional] |



2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>sendbird-platform-sdk</artifactId>
<packaging>jar</packaging>
<name>sendbird-platform-sdk</name>
<version>1.0.17</version>
<version>1.0.18</version>
<url>https://github.com/sendbird/sendbird-platform-sdk-java</url>
<description>Sendbird Platform API SDK</description>
<scm>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public abstract class AbstractOpenApiSchema {

// store the actual instance of the schema/object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
AddApnsPushConfigurationData.JSON_PROPERTY_APNS_TYPE
})
@JsonTypeName("addApnsPushConfigurationData")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddApnsPushConfigurationData {
public static final String JSON_PROPERTY_APNS_CERT = "apns_cert";
private File apnsCert;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddApnsPushConfigurationResponse.JSON_PROPERTY_PUSH_CONFIGURATIONS
})
@JsonTypeName("addApnsPushConfigurationResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddApnsPushConfigurationResponse {
public static final String JSON_PROPERTY_PUSH_CONFIGURATIONS = "push_configurations";
private List<AddApnsPushConfigurationResponsePushConfigurationsInner> pushConfigurations = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
AddApnsPushConfigurationResponsePushConfigurationsInner.JSON_PROPERTY_PUSH_SOUND
})
@JsonTypeName("addApnsPushConfigurationResponse_push_configurations_inner")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddApnsPushConfigurationResponsePushConfigurationsInner {
public static final String JSON_PROPERTY_ID = "id";
private String id;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddEmojiCategoriesResponse.JSON_PROPERTY_EMOJI_CATEGORIES
})
@JsonTypeName("addEmojiCategoriesResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddEmojiCategoriesResponse {
public static final String JSON_PROPERTY_EMOJI_CATEGORIES = "emoji_categories";
private List<AddEmojiCategoriesResponseEmojiCategoriesInner> emojiCategories = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddEmojiCategoriesResponseEmojiCategoriesInner.JSON_PROPERTY_URL
})
@JsonTypeName("addEmojiCategoriesResponse_emoji_categories_inner")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddEmojiCategoriesResponseEmojiCategoriesInner {
public static final String JSON_PROPERTY_ID = "id";
private BigDecimal id;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddEmojisData.JSON_PROPERTY_EMOJIS
})
@JsonTypeName("addEmojisData")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddEmojisData {
public static final String JSON_PROPERTY_EMOJI_CATEGORY_ID = "emoji_category_id";
private Integer emojiCategoryId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddEmojisResponse.JSON_PROPERTY_EMOJIS
})
@JsonTypeName("addEmojisResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddEmojisResponse {
public static final String JSON_PROPERTY_EMOJIS = "emojis";
private List<ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner> emojis = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddExtraDataToMessageData.JSON_PROPERTY_SORTED_METAARRAY
})
@JsonTypeName("addExtraDataToMessageData")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddExtraDataToMessageData {
public static final String JSON_PROPERTY_CHANNEL_TYPE = "channel_type";
private String channelType;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddExtraDataToMessageResponse.JSON_PROPERTY_SORTED_METAARRAY
})
@JsonTypeName("addExtraDataToMessageResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddExtraDataToMessageResponse {
public static final String JSON_PROPERTY_SORTED_METAARRAY = "sorted_metaarray";
private List<ListMessagesResponseMessagesInnerSortedMetaarrayInner> sortedMetaarray = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
AddFcmPushConfigurationData.JSON_PROPERTY_PUSH_SOUND
})
@JsonTypeName("addFcmPushConfigurationData")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddFcmPushConfigurationData {
public static final String JSON_PROPERTY_API_KEY = "api_key";
private String apiKey;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddFcmPushConfigurationResponse.JSON_PROPERTY_PUSH_CONFIGURATIONS
})
@JsonTypeName("addFcmPushConfigurationResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddFcmPushConfigurationResponse {
public static final String JSON_PROPERTY_PUSH_CONFIGURATIONS = "push_configurations";
private List<AddFcmPushConfigurationResponsePushConfigurationsInner> pushConfigurations = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddFcmPushConfigurationResponsePushConfigurationsInner.JSON_PROPERTY_PUSH_SOUND
})
@JsonTypeName("addFcmPushConfigurationResponse_push_configurations_inner")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddFcmPushConfigurationResponsePushConfigurationsInner {
public static final String JSON_PROPERTY_ID = "id";
private String id;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
AddHmsPushConfigurationData.JSON_PROPERTY_PUSH_SOUND
})
@JsonTypeName("addHmsPushConfigurationData")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddHmsPushConfigurationData {
public static final String JSON_PROPERTY_HUAWEI_APP_ID = "huawei_app_id";
private String huaweiAppId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
AddHmsPushConfigurationResponse.JSON_PROPERTY_PUSH_CONFIGURATIONS
})
@JsonTypeName("addHmsPushConfigurationResponse")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-10T16:14:48.686+09:00[Asia/Seoul]")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
public class AddHmsPushConfigurationResponse {
public static final String JSON_PROPERTY_PUSH_CONFIGURATIONS = "push_configurations";
private List<AddHmsPushConfigurationResponsePushConfigurationsInner> pushConfigurations = null;
Expand Down
Loading
Loading