add user metadata

.github/workflows/maven.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
         java-version: ${{ matrix.java }}
         distribution: 'temurin'

.openapi-generator/FILES

@@ -24,6 +24,7 @@ docs/CreateAChannelMetadataResponse.md
 docs/CreateAGroupChannelRequest.md
 docs/CreateAUserRequest.md
 docs/CreateAnOpenChannelRequest.md
+docs/CreateUserMetadataRequest.md
 docs/CreateUserTokenRequest.md
 docs/CreateUserTokenResponse.md
 docs/FreezeAGroupChannelRequest.md
@@ -127,6 +128,8 @@ docs/UpdatePushPreferencesForAChannelRequest.md
 docs/UpdatePushPreferencesForAChannelResponse.md
 docs/UpdatePushPreferencesRequest.md
 docs/UpdatePushPreferencesResponse.md
+docs/UpdateSpecificUserMetadataRequest.md
+docs/UpdateUserMetadataRequest.md
 docs/UserApi.md
 docs/ViewBotByIdResponse.md
 docs/ViewBotByIdResponseBot.md
@@ -165,6 +168,7 @@ src/main/java/org/openapitools/client/model/CreateAChannelMetadataResponse.java
 src/main/java/org/openapitools/client/model/CreateAGroupChannelRequest.java
 src/main/java/org/openapitools/client/model/CreateAUserRequest.java
 src/main/java/org/openapitools/client/model/CreateAnOpenChannelRequest.java
+src/main/java/org/openapitools/client/model/CreateUserMetadataRequest.java
 src/main/java/org/openapitools/client/model/CreateUserTokenRequest.java
 src/main/java/org/openapitools/client/model/CreateUserTokenResponse.java
 src/main/java/org/openapitools/client/model/FreezeAGroupChannelRequest.java
@@ -262,6 +266,8 @@ src/main/java/org/openapitools/client/model/UpdatePushPreferencesForAChannelRequ
 src/main/java/org/openapitools/client/model/UpdatePushPreferencesForAChannelResponse.java
 src/main/java/org/openapitools/client/model/UpdatePushPreferencesRequest.java
 src/main/java/org/openapitools/client/model/UpdatePushPreferencesResponse.java
+src/main/java/org/openapitools/client/model/UpdateSpecificUserMetadataRequest.java
+src/main/java/org/openapitools/client/model/UpdateUserMetadataRequest.java
 src/main/java/org/openapitools/client/model/ViewBotByIdResponse.java
 src/main/java/org/openapitools/client/model/ViewBotByIdResponseBot.java
 src/main/java/org/openapitools/client/model/ViewCountPreferenceOfAChannelResponse.java
@@ -313,6 +319,7 @@ src/test/java/org/openapitools/client/model/CreateAChannelMetadataResponseTest.j
 src/test/java/org/openapitools/client/model/CreateAGroupChannelRequestTest.java
 src/test/java/org/openapitools/client/model/CreateAUserRequestTest.java
 src/test/java/org/openapitools/client/model/CreateAnOpenChannelRequestTest.java
+src/test/java/org/openapitools/client/model/CreateUserMetadataRequestTest.java
 src/test/java/org/openapitools/client/model/CreateUserTokenRequestTest.java
 src/test/java/org/openapitools/client/model/CreateUserTokenResponseTest.java
 src/test/java/org/openapitools/client/model/FreezeAGroupChannelRequestTest.java
@@ -410,6 +417,8 @@ src/test/java/org/openapitools/client/model/UpdatePushPreferencesForAChannelRequ
 src/test/java/org/openapitools/client/model/UpdatePushPreferencesForAChannelResponseTest.java
 src/test/java/org/openapitools/client/model/UpdatePushPreferencesRequestTest.java
 src/test/java/org/openapitools/client/model/UpdatePushPreferencesResponseTest.java
+src/test/java/org/openapitools/client/model/UpdateSpecificUserMetadataRequestTest.java
+src/test/java/org/openapitools/client/model/UpdateUserMetadataRequestTest.java
 src/test/java/org/openapitools/client/model/ViewBotByIdResponseBotTest.java
 src/test/java/org/openapitools/client/model/ViewBotByIdResponseTest.java
 src/test/java/org/openapitools/client/model/ViewCountPreferenceOfAChannelResponseTest.java

README.md

@@ -98,7 +98,7 @@ Add these dependency to your project's POM:
     <dependency>
         <groupId>org.sendbird</groupId>
         <artifactId>sendbird-platform-sdk</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
     </dependency>
 </dependencies>
 ```
@@ -110,7 +110,7 @@ Add this dependency to your project's build file:
 ```groovy
 
 dependencies {
-    implementation "org.sendbird:sendbird-platform-sdk:2.1.1
+    implementation "org.sendbird:sendbird-platform-sdk:2.1.2
 }
 
 allprojects {

api/openapi.yaml

@@ -3435,6 +3435,239 @@ paths:
       tags:
       - User
       x-accepts: application/json
+  /v3/users/{user_id}/metadata:
+    delete:
+      description: |-
+        ## Delete metadata You can delete a specific or all metadata of a user. Metadata stores additional user information such as their preference settings.
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-delete-metadata
+      operationId: deleteUserAllMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          type: string
+        style: simple
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/emptyObjectResponse'
+          description: Successful response
+      summary: Delete user metadata
+      tags:
+      - User
+      x-accepts: application/json
+    post:
+      description: '## Create metadata When creating new items of the user metadata.
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-create-metadata'
+      operationId: createUserMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          type: string
+        style: simple
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/createUserMetadata_request'
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/viewAUserMetadataResponse'
+          description: Successful response
+      summary: Create user metadata
+      tags:
+      - User
+      x-content-type: application/json
+      x-accepts: application/json
+    put:
+      description: |-
+        ## Update metadata When updating existing items of the user metadata by their keys or adding new items to the metadata
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-update-metadata
+      operationId: updateUserMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          type: string
+        style: simple
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/updateUserMetadata_request'
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/updateUserMetadataResponse'
+          description: Successful response
+      summary: Update user metadata
+      tags:
+      - User
+      x-content-type: application/json
+      x-accepts: application/json
+  /v3/users/{user_id}/metadata/{key}:
+    delete:
+      description: |-
+        ## Delete metadata
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-delete-metadata
+      operationId: deleteSpecificUserMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: path
+        name: key
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          type: string
+        style: simple
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/emptyObjectResponse'
+          description: Successful response
+      summary: Delete user metadata
+      tags:
+      - User
+      x-accepts: application/json
+    get:
+      description: |-
+        ## Get metadata
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-get-metadata
+      operationId: viewSpecificUserMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: path
+        name: key
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          example: "{{API_TOKEN}}"
+          type: string
+        style: simple
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/viewAUserMetadataResponse'
+          description: Successful response
+      summary: Get specific user metadata
+      tags:
+      - User
+      x-accepts: application/json
+    put:
+      description: |-
+        ## Update metadata
+        https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-update-metadata
+      operationId: updateSpecificUserMetadata
+      parameters:
+      - description: '(Required) '
+        explode: false
+        in: path
+        name: user_id
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: path
+        name: key
+        required: true
+        schema:
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: api-token
+        required: false
+        schema:
+          type: string
+        style: simple
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/updateSpecificUserMetadata_request'
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/updateUserMetadataResponse'
+          description: Successful response
+      summary: Update specific user metadata
+      tags:
+      - User
+      x-content-type: application/json
+      x-accepts: application/json
   /v3/push/device_tokens/{token_type}/{token}:
     delete:
       description: "## Remove a registration or device token from an owner\n\nRemoves\
@@ -8043,6 +8276,10 @@ components:
             $ref: '#/components/schemas/SendbirdUser'
           type: array
       type: object
+    viewAUserMetadataResponse:
+      type: object
+    updateUserMetadataResponse:
+      type: object
     chooseAPushNotificationContentTemplateResponse:
       example:
         name: name
@@ -10101,6 +10338,31 @@ components:
       required:
       - push_trigger_option
       type: object
+    updateUserMetadata_request:
+      properties:
+        metadata:
+          nullable: true
+          type: object
+        upsert:
+          nullable: true
+          type: boolean
+      required:
+      - metadata
+      type: object
+    createUserMetadata_request:
+      properties:
+        metadata:
+          type: object
+      required:
+      - metadata
+      type: object
+    updateSpecificUserMetadata_request:
+      properties:
+        value:
+          type: string
+      required:
+      - value
+      type: object
     updateCountPreferenceOfAChannel_request:
       properties:
         count_preference:

build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'org.sendbird'
-version = '2.1.1'
+version = '2.1.2'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "org.sendbird",
     name := "sendbird-platform-sdk",
-    version := "2.1.1",
+    version := "2.1.2",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     Compile / javacOptions ++= Seq("-Xlint:deprecation"),

docs/CreateUserMetadataRequest.md

@@ -0,0 +1,13 @@
+
+
+# CreateUserMetadataRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**metadata** | **Object** |  |  |
+
+
+