Merge pull request #25 from sendbird/origin/danney/fixed-nullable-type-error

2.1.1

Author: danney-chun

.gitignore

@@ -23,6 +23,8 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.env.*
+.env
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.openapi-generator-ignore

@@ -21,3 +21,11 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+README.md
+.env
+test/**
+test/*
+requirements.txt
+test-requirements.txt
+tox.ini
+pytest.ini

.openapi-generator/FILES

@@ -1,7 +1,6 @@
 .gitignore
 .gitlab-ci.yml
 .travis.yml
-README.md
 docs/AcceptAnInvitationRequest.md
 docs/AcceptAnInvitationResponse.md
 docs/AddARegistrationOrDeviceTokenRequest.md
@@ -104,8 +103,10 @@ docs/SendbirdFile.md
 docs/SendbirdGroupChannel.md
 docs/SendbirdGroupChannelDetail.md
 docs/SendbirdGroupChannelDetailChannel.md
+docs/SendbirdGroupChannelLastMessage.md
 docs/SendbirdMember.md
 docs/SendbirdMessageResponse.md
+docs/SendbirdMessageResponseExtendedMessagePayload.md
 docs/SendbirdMessageResponseMessageEvents.md
 docs/SendbirdOpenChannel.md
 docs/SendbirdParentMessageInfo.md
@@ -152,7 +153,6 @@ docs/ViewPushPreferencesForAChannelResponse.md
 docs/ViewPushPreferencesResponse.md
 docs/ViewWhoOwnsARegistrationOrDeviceTokenResponse.md
 git_push.sh
-requirements.txt
 sendbird_platform_sdk/__init__.py
 sendbird_platform_sdk/api/__init__.py
 sendbird_platform_sdk/api/announcement_api.py
@@ -264,8 +264,10 @@ sendbird_platform_sdk/model/sendbird_file.py
 sendbird_platform_sdk/model/sendbird_group_channel.py
 sendbird_platform_sdk/model/sendbird_group_channel_detail.py
 sendbird_platform_sdk/model/sendbird_group_channel_detail_channel.py
+sendbird_platform_sdk/model/sendbird_group_channel_last_message.py
 sendbird_platform_sdk/model/sendbird_member.py
 sendbird_platform_sdk/model/sendbird_message_response.py
+sendbird_platform_sdk/model/sendbird_message_response_extended_message_payload.py
 sendbird_platform_sdk/model/sendbird_message_response_message_events.py
 sendbird_platform_sdk/model/sendbird_open_channel.py
 sendbird_platform_sdk/model/sendbird_parent_message_info.py
@@ -314,6 +316,3 @@ sendbird_platform_sdk/models/__init__.py
 sendbird_platform_sdk/rest.py
 setup.cfg
 setup.py
-test-requirements.txt
-test/__init__.py
-tox.ini

ENV_SETUP.md

@@ -0,0 +1,131 @@
+# Environment Setup for Integration Tests
+
+This guide explains how to configure credentials for integration tests.
+
+## Quick Start
+
+1. Create a `.env` file in the project root directory
+2. Add your Sendbird credentials
+3. Run integration tests
+
+## Step-by-Step Setup
+
+### 1. Create .env File
+
+Create a file named `.env` in the project root directory (same directory as `README.md`):
+
+```bash
+# Navigate to project root
+cd /path/to/sendbird-platform-sdk-python
+
+# Create .env file
+touch .env
+```
+
+### 2. Add Your Credentials
+
+Edit the `.env` file and add your Sendbird credentials:
+
+```bash
+# Sendbird Platform SDK - Integration Test Configuration
+
+# Your Sendbird Application ID
+# Find this in Sendbird Dashboard > Settings > Application > App ID
+SENDBIRD_APP_ID=your_app_id_here
+
+# Your Sendbird API Token (Master API Token)
+# Find this in Sendbird Dashboard > Settings > Application > API tokens
+SENDBIRD_API_TOKEN=your_api_token_here
+```
+
+### 3. Get Your Credentials
+
+To find your Sendbird credentials:
+
+1. Log in to [Sendbird Dashboard](https://dashboard.sendbird.com/)
+2. Select your application
+3. Go to **Settings** > **Application**
+4. **App ID**: Copy the Application ID
+5. **API Token**: Go to **API tokens** tab and copy the Master API token
+
+### 4. Verify Setup
+
+Run a simple test to verify your setup:
+
+```bash
+# Test with a single integration test
+python -m pytest test/integration/test_user_integration.py::TestUserApiIntegration::test_list_users -v
+```
+
+If configured correctly, the test will run (not skip).
+
+## Alternative: Environment Variables
+
+Instead of using a `.env` file, you can set environment variables directly:
+
+```bash
+# Set environment variables
+export SENDBIRD_APP_ID=your_app_id_here
+export SENDBIRD_API_TOKEN=your_api_token_here
+
+# Run tests
+python -m pytest test/integration/ -v
+```
+
+## Security Notes
+
+⚠️ **Important Security Considerations:**
+
+1. **Never commit `.env` file**: The `.env` file is automatically ignored by git
+2. **Keep credentials secret**: Do not share your API token
+3. **Use test applications**: Consider using a separate Sendbird application for testing
+4. **Rotate tokens regularly**: Regenerate API tokens periodically
+5. **Limit token permissions**: Use tokens with minimal required permissions if possible
+
+## Troubleshooting
+
+### Tests are being skipped
+
+If you see "Integration tests require SENDBIRD_APP_ID and SENDBIRD_API_TOKEN", check:
+
+1. `.env` file exists in the project root (not in `test/` directory)
+2. Variable names are correct (case-sensitive)
+3. Values don't have quotes or extra spaces
+4. File is saved
+
+### Invalid credentials
+
+If tests run but fail with authentication errors:
+
+1. Verify credentials in Sendbird Dashboard
+2. Check for typos in `.env` file
+3. Ensure API token has required permissions
+4. Try regenerating the API token
+
+### .env file not loading
+
+1. Ensure file is named exactly `.env` (not `.env.txt` or similar)
+2. File should be in project root directory
+3. Check file permissions (should be readable)
+
+## Example .env File
+
+Here's a complete example:
+
+```bash
+# Sendbird Platform SDK - Integration Test Configuration
+# Created: 2024-10-15
+
+# Application ID from Sendbird Dashboard
+SENDBIRD_APP_ID=A1B2C3D4-E5F6-7890-ABCD-EF1234567890
+
+# Master API Token from Sendbird Dashboard  
+SENDBIRD_API_TOKEN=1234567890abcdef1234567890abcdef1234567890
+```
+
+## Additional Resources
+
+- [Sendbird Platform API Documentation](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
+- [Sendbird Dashboard](https://dashboard.sendbird.com/)
+- [Integration Test Guide](test/README.md)
+

KNOWN_ISSUES.md

@@ -0,0 +1,165 @@
+# Known Issues - Sendbird Platform SDK Python
+
+This document tracks known issues and bugs in the SDK that are reflected in failing tests.
+
+## Optional Fields Rejecting None Values
+
+**Status**: 🐛 Bug  
+**Severity**: Medium  
+**Affected Version**: 2.1.1
+
+### Description
+
+Optional fields in model classes incorrectly reject `None` values. According to OpenAPI specification and general API best practices, optional fields should accept `None` values, but the current SDK implementation raises `ApiTypeError` when `None` is explicitly passed to optional fields.
+
+### Expected Behavior
+
+```python
+# This SHOULD work for optional fields
+model = CreateAUserRequest(
+    nickname="John Doe",
+    profile_url="https://example.com/profile.jpg",
+    user_id="user123",
+    discovery_keys=None,  # Optional field - should accept None
+    metadata=None         # Optional field - should accept None
+)
+```
+
+### Actual Behavior
+
+```python
+# This currently FAILS with ApiTypeError
+model = CreateAUserRequest(
+    nickname="John Doe",
+    profile_url="https://example.com/profile.jpg",
+    user_id="user123",
+    discovery_keys=None  # ❌ Raises: Invalid type for variable 'discovery_keys'
+)
+```
+
+### Workaround
+
+Instead of passing `None`, simply omit the field:
+
+```python
+# ✅ This works
+model = CreateAUserRequest(
+    nickname="John Doe",
+    profile_url="https://example.com/profile.jpg",
+    user_id="user123"
+    # discovery_keys and metadata omitted - works fine
+)
+```
+
+Or use empty values:
+
+```python
+# ✅ This also works
+model = CreateAUserRequest(
+    nickname="John Doe",
+    profile_url="https://example.com/profile.jpg",
+    user_id="user123",
+    discovery_keys=[],  # Empty list instead of None
+    metadata={}         # Empty dict instead of None
+)
+```
+
+### Affected Models
+
+The following models have optional fields that incorrectly reject `None`:
+
+1. **AcceptAnInvitationRequest**
+   - `access_code` (optional but not nullable)
+
+2. **CreateAUserRequest**
+   - `discovery_keys` (optional but not nullable)
+   - `metadata` (optional but not nullable)
+   - `profile_file` (optional but not nullable)
+
+3. **SendbirdUser**
+   - `nickname` (optional but not nullable)
+   - `profile_url` (optional but not nullable)
+   - `discovery_keys` (optional but not nullable)
+   - `preferred_languages` (optional but not nullable)
+   - `session_tokens` (optional but not nullable)
+   - `metadata` (optional but not nullable)
+   - **Exception**: `state` field IS nullable (correctly accepts None)
+
+### Failing Tests
+
+The following tests document this issue and currently fail:
+
+```bash
+# Run these tests to see the issue
+pytest test/test_accept_an_invitation_request.py::TestAcceptAnInvitationRequest::testAcceptAnInvitationRequestOptionalFieldShouldAcceptNone -v
+pytest test/test_create_a_user_request.py::TestCreateAUserRequest::testCreateAUserRequestOptionalDiscoveryKeys -v
+pytest test/test_create_a_user_request.py::TestCreateAUserRequest::testCreateAUserRequestOptionalMetadata -v
+pytest test/test_sendbird_user.py::TestSendbirdUser::testSendbirdUserOptionalFields -v
+```
+
+Test results:
+```
+FAILED test/test_accept_an_invitation_request.py - ApiTypeError: Invalid type for variable 'access_code'
+FAILED test/test_create_a_user_request.py (multiple) - ApiTypeError for optional fields
+FAILED test/test_sendbird_user.py (multiple) - ApiTypeError for optional fields
+
+7 failed, 244 passed
+```
+
+### Root Cause
+
+This issue likely stems from the OpenAPI Generator configuration or template. The generator is not properly marking optional fields as nullable in the generated Python code.
+
+In the model files, optional non-nullable fields are defined as:
+```python
+'discovery_keys': ([str],),  # Should be ([str], none_type,) for nullable
+```
+
+While properly nullable fields are defined as:
+```python
+'state': (str, none_type,),  # ✅ Correctly includes none_type
+```
+
+### Potential Solutions
+
+1. **Update OpenAPI Generator Templates**
+   - Modify the Python generator template to mark optional fields as nullable
+   - Location: `sendbird-platform-openapi/` generator configuration
+
+2. **Update OpenAPI Specification**
+   - Explicitly mark optional fields as `nullable: true` in the YAML spec
+   - Location: `sendbird-platform-openapi/sendbird.yaml`
+
+3. **Post-Processing Script**
+   - Create a script to automatically add `none_type` to optional fields after generation
+   - Similar to existing `post_process_nullable_fields_auto.py`
+
+### Recommendation
+
+Update the OpenAPI specification or generator configuration to properly handle optional fields:
+
+```yaml
+# In sendbird.yaml
+properties:
+  discovery_keys:
+    type: array
+    items:
+      type: string
+    nullable: true  # Add this for optional fields
+```
+
+### References
+
+- OpenAPI Specification: [Nullable](https://swagger.io/docs/specification/data-models/data-types/#null)
+- Python OpenAPI Generator: [Issues with nullable](https://github.com/OpenAPITools/openapi-generator/issues?q=nullable+python)
+- Related test files:
+  - `test/test_accept_an_invitation_request.py`
+  - `test/test_create_a_user_request.py`
+  - `test/test_sendbird_user.py`
+
+---
+
+**Last Updated**: 2025-10-16  
+**Reported By**: Automated Test Suite  
+**Priority**: Medium - Affects developer experience but has workarounds
+

README.md

@@ -67,10 +67,9 @@ All the documentation for this project lives in the /docs directory of this repo
 |       | Documentation |
 | ----------- | ----------- |
 | Announcement   | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|
-| Application | [docs/ApplicationApi.md](docs/ApplicationApi.md)  |
 | Bot | [docs/BotApi.md](docs/BotApi.md)  |
 | GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md)  |
 | Message | [docs/MessageApi.md](docs/MessageApi.md)  |
 | OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md)  |
 | User | [docs/UserApi.md](docs/UserApi.md)  |
-
+| Moderation | [docs/ModerationApi.md](docs/ModerationApi.md)  |