Java SDK - Feeds API

Table of Contents

• getApp
• updateApp
• listBlockLists
• createBlockList
• getBlockList
• updateBlockList
• deleteBlockList
• checkPush
• checkSNS
• checkSQS
• listDevices
• createDevice
• deleteDevice
• exportUsers
• listExternalStorage
• createExternalStorage
• updateExternalStorage
• deleteExternalStorage
• checkExternalStorage
• createGuest
• createImportURL
• listImports
• createImport
• listImportV2Tasks
• createImportV2Task
• getImporterExternalStorage
• upsertImporterExternalStorage
• deleteImporterExternalStorage
• validateImporterExternalStorage
• getImportV2Task
• deleteImportV2Task
• getImport
• getOG
• listPermissions
• getPermission
• createPoll
• updatePoll
• queryPolls
• getPoll
• updatePollPartial
• deletePoll
• createPollOption
• updatePollOption
• getPollOption
• deletePollOption
• queryPollVotes
• updatePushNotificationPreferences
• listPushProviders
• upsertPushProvider
• deletePushProvider
• getPushTemplates
• upsertPushTemplate
• getRateLimits
• listRoles
• createRole
• deleteRole
• getTask
• uploadFile
• deleteFile
• uploadImage
• deleteImage
• listUserGroups
• createUserGroup
• searchUserGroups
• getUserGroup
• updateUserGroup
• deleteUserGroup
• addUserGroupMembers
• removeUserGroupMembers
• queryUsers
• updateUsers
• updateUsersPartial
• getBlockedUsers
• blockUsers
• deactivateUsers
• deleteUsers
• getUserLiveLocations
• updateLiveLocation
• reactivateUsers
• restoreUsers
• unblockUsers
• deactivateUser
• exportUser
• reactivateUser
• Types Reference

---

getApp

Retrieve the current application settings to understand and verify the configuration of your app. Use this method when you need to access or review the app's settings for troubleshooting or validation purposes.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get App Settings
        var response = commonClient.getApp().execute();

        System.out.println(response);
    }
}

Response: GetApplicationResponse

---

updateApp

Modify the application settings to adjust the configuration according to your requirements. This method is useful when you need to update settings to improve functionality or comply with new policies.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update App Settings
        var response = commonClient.updateApp(
            new UpdateAppRequest()
                .setActivityMetricsConfig(Map.of())
                .setAllowedFlagReasons(List.of())
                .setApnConfig(new APNConfig().setDisabled(false))
        ).execute();

        System.out.println(response);
    }
}

Example: with async_moderation_config and async_url_enrich_enabled

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update App Settings
        var response = commonClient.updateApp(
            new UpdateAppRequest()
                .setAsyncModerationConfig(new AsyncModerationConfiguration().setCallback(new AsyncModerationCallbackConfig().setMode("value")))
                .setAsyncURLEnrichEnabled(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with auto_translation_enabled and before_message_send_hook_url

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update App Settings
        var response = commonClient.updateApp(
            new UpdateAppRequest()
                .setAutoTranslationEnabled(false)
                .setBeforeMessageSendHookURL("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with cdn_expiration_seconds and channel_hide_members_only

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update App Settings
        var response = commonClient.updateApp(
            new UpdateAppRequest()
                .setCdnExpirationSeconds(10)
                .setChannelHideMembersOnly(false)
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
activity_metrics_config	Map<String, Object>	No	-
allowed_flag_reasons	[]string	No	-
apn_config	APNConfig	No	-
async_moderation_config	AsyncModerationConfiguration	No	-
async_url_enrich_enabled	Boolean	No	-
auto_translation_enabled	Boolean	No	-
before_message_send_hook_url	String	No	-
cdn_expiration_seconds	Integer	No	-
channel_hide_members_only	Boolean	No	-
custom_action_handler_url	String	No	-
datadog_info	DataDogInfo	No	-
disable_auth_checks	Boolean	No	-
disable_permissions_checks	Boolean	No	-
enforce_unique_usernames	String	No	-
event_hooks	[]EventHook	No	-
feeds_moderation_enabled	Boolean	No	-
feeds_v2_region	String	No	-
file_upload_config	FileUploadConfig	No	-
firebase_config	FirebaseConfig	No	-
grants	Map<String, Object>	No	-
guest_user_creation_disabled	Boolean	No	-
huawei_config	HuaweiConfig	No	-
image_moderation_block_labels	[]string	No	-
image_moderation_enabled	Boolean	No	-
image_moderation_labels	[]string	No	-
image_upload_config	FileUploadConfig	No	-
max_aggregated_activities_length	Integer	No	-
migrate_permissions_to_v2	Boolean	No	-
moderation_analytics_enabled	Boolean	No	-
moderation_dashboard_preferences	ModerationDashboardPreferences	No	-
moderation_enabled	Boolean	No	-
moderation_s3_image_access_role_arn	String	No	-
moderation_webhook_url	String	No	-
multi_tenant_enabled	Boolean	No	-
permission_version	String	No	-
push_config	PushConfig	No	-
reminders_interval	Integer	No	-
reminders_max_members	Integer	No	-
revoke_tokens_issued_before	float	No	-
sns_key	String	No	-
sns_secret	String	No	-
sns_topic_arn	String	No	-
sqs_key	String	No	-
sqs_secret	String	No	-
sqs_url	String	No	-
user_response_time_enabled	Boolean	No	-
user_search_disallowed_roles	[]string	No	-
webhook_events	[]string	No	-
webhook_url	String	No	-
xiaomi_config	XiaomiConfig	No	-

---

listBlockLists

Obtain a list of all block lists to manage or review the existing lists effectively. Use this method when you need a comprehensive overview of all block lists in your system.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List block lists
        var response = commonClient.listBlockLists(
            new ListBlockListsRequest()
                .setTeam("value")
        ).execute();

        System.out.println(response);
    }
}

Response: ListBlockListResponse

Parameters

Parameter	Type	Required	Description
team	String	No	-

---

createBlockList

Establish a new block list to prevent certain elements from interacting with your application. This method is essential when introducing new restrictions or security measures.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create block list
        var response = commonClient.createBlockList(
            new CreateBlockListRequest()
                .setName("My Feed")
                .setWords(List.of())
                .setType("like")
                .setIsPluralCheckEnabled(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with team and is_leet_check_enabled

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create block list
        var response = commonClient.createBlockList(
            new CreateBlockListRequest()
                .setName("My Feed")
                .setWords(List.of())
                .setTeam("value")
                .setIsLeetCheckEnabled(false)
        ).execute();

        System.out.println(response);
    }
}

Response: CreateBlockListResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	Block list name
words	[]string	Yes	List of words to block
is_leet_check_enabled	Boolean	No	-
is_plural_check_enabled	Boolean	No	-
team	String	No	-
type	String	No	Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word

---

getBlockList

Access the details of a specific block list to understand its contents and purpose. Use this method when you need to inspect or verify the entries of a particular block list.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get block list
        var response = commonClient.getBlockList(
            "My Feed",
            new GetBlockListRequest()
                .setTeam("value")
        ).execute();

        System.out.println(response);
    }
}

Response: GetBlockListResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	-
team	String	No	-

---

updateBlockList

Modify an existing block list to add, remove, or change its entries. This is useful when updating the list to reflect new restrictions or allow previously blocked interactions.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update block list
        var response = commonClient.updateBlockList(
            "My Feed",
            new UpdateBlockListRequest()
                .setIsLeetCheckEnabled(false)
                .setIsPluralCheckEnabled(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with team and words

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update block list
        var response = commonClient.updateBlockList(
            "My Feed",
            new UpdateBlockListRequest()
                .setTeam("value")
                .setWords(List.of())
        ).execute();

        System.out.println(response);
    }
}

Response: UpdateBlockListResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	-
is_leet_check_enabled	Boolean	No	-
is_plural_check_enabled	Boolean	No	-
team	String	No	-
words	[]string	No	List of words to block

---

deleteBlockList

Remove a block list to eliminate its restrictions from your application. Use this method when a block list is no longer needed, or when consolidating lists for efficiency.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete block list
        var response = commonClient.deleteBlockList(
            "My Feed",
            new DeleteBlockListRequest()
                .setTeam("value")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
name	String	Yes	-
team	String	No	-

---

checkPush

Verify the configuration and status of push notification services to ensure they are functioning correctly. This method is beneficial when diagnosing issues or confirming the setup of push notifications.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check push
        var response = commonClient.checkPush(
            new CheckPushRequest()
                .setUserID("john")
                .setEventType("value")
                .setFirebaseDataTemplate("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with firebase_template and message_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check push
        var response = commonClient.checkPush(
            new CheckPushRequest()
                .setFirebaseTemplate("value")
                .setMessageID("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with push_provider_name and push_provider_type

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check push
        var response = commonClient.checkPush(
            new CheckPushRequest()
                .setPushProviderName("value")
                .setPushProviderType("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with skip_devices and user

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check push
        var response = commonClient.checkPush(
            new CheckPushRequest()
                .setSkipDevices(false)
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Response: CheckPushResponse

Parameters

Parameter	Type	Required	Description
apn_template	String	No	Push message template for APN
event_type	String	No	Type of event for push templates (default: message.new). One of: message.new, message.updated, re...
firebase_data_template	String	No	Push message data template for Firebase
firebase_template	String	No	Push message template for Firebase
message_id	String	No	Message ID to send push notification for
push_provider_name	String	No	Name of push provider
push_provider_type	String	No	Push provider type. One of: firebase, apn, huawei, xiaomi
skip_devices	Boolean	No	Don't require existing devices to render templates
user	UserRequest	No	-
user_id	String	No	-

---

checkSNS

Check the configuration and status of SNS (Simple Notification Service) to ensure proper operation. Use this method when you need to troubleshoot or validate SNS integration.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check SNS
        var response = commonClient.checkSNS(
            new CheckSNSRequest()
                .setSnsKey("value")
                .setSnsSecret("value")
                .setSnsTopicArn("value")
        ).execute();

        System.out.println(response);
    }
}

Response: CheckSNSResponse

Parameters

Parameter	Type	Required	Description
sns_key	String	No	AWS SNS access key
sns_secret	String	No	AWS SNS key secret
sns_topic_arn	String	No	AWS SNS topic ARN

---

checkSQS

Assess the configuration and status of SQS (Simple Queue Service) to ensure messages are being processed correctly. This is helpful for troubleshooting issues or confirming the setup of SQS.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check SQS
        var response = commonClient.checkSQS(
            new CheckSQSRequest()
                .setSqsKey("value")
                .setSqsSecret("value")
                .setSqsURL("value")
        ).execute();

        System.out.println(response);
    }
}

Response: CheckSQSResponse

Parameters

Parameter	Type	Required	Description
sqs_key	String	No	AWS SQS access key
sqs_secret	String	No	AWS SQS key secret
sqs_url	String	No	AWS SQS endpoint URL

---

listDevices

Retrieve a comprehensive list of all registered devices, useful for monitoring and managing device inventory.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List devices
        var response = commonClient.listDevices(
            new ListDevicesRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: ListDevicesResponse

Parameters

Parameter	Type	Required	Description
user_id	String	No	-

---

createDevice

Add a new device to your system, ideal for onboarding new hardware into your network.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create device
        var response = commonClient.createDevice(
            new CreateDeviceRequest()
                .setID("activity-123")
                .setPushProvider("value")
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Example: with push_provider_name and voip_token

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create device
        var response = commonClient.createDevice(
            new CreateDeviceRequest()
                .setID("activity-123")
                .setPushProvider("value")
                .setPushProviderName("value")
                .setVoipToken(false)
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
id	String	Yes	Device ID
push_provider	String	Yes	Push provider
push_provider_name	String	No	Push provider name
user	UserRequest	No	-
user_id	String	No	Server-side only. User ID which server acts upon
voip_token	Boolean	No	When true the token is for Apple VoIP push notifications

---

deleteDevice

Remove a specific device from your records, perfect for decommissioning or replacing outdated equipment.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete device
        var response = commonClient.deleteDevice(
            new DeleteDeviceRequest()
                .setID("activity-123")
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
user_id	String	No	-

---

exportUsers

Generate and download a complete list of users, helpful for data analysis or migration to other systems.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Export users
        var response = commonClient.exportUsers(
            new ExportUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
        ).execute();

        System.out.println(response);
    }
}

Response: ExportUsersResponse

Parameters

Parameter	Type	Required	Description
user_ids	[]string	Yes	-

---

listExternalStorage

Get an overview of all configured external storage options, useful for managing and optimizing data storage solutions.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List external storage
        var response = commonClient.listExternalStorage().execute();

        System.out.println(response);
    }
}

Response: ListExternalStorageResponse

---

createExternalStorage

Set up a new external storage configuration, enabling you to expand your data storage capabilities.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create external storage
        var response = commonClient.createExternalStorage(
            new CreateExternalStorageRequest()
                .setBucket("value")
                .setName("My Feed")
                .setStorageType("value")
                .setAWSS3(new S3Request().setS3Region("value").setS3APIKey("value"))
                .setAzureBlob(new AzureRequest().setAbsAccountName("value").setAbsClientID("value").setAbsClientSecret("value").setAbsTenantID("value"))
        ).execute();

        System.out.println(response);
    }
}

Example: with gcs_credentials and path

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create external storage
        var response = commonClient.createExternalStorage(
            new CreateExternalStorageRequest()
                .setBucket("value")
                .setName("My Feed")
                .setStorageType("value")
                .setGcsCredentials("value")
                .setPath("value")
        ).execute();

        System.out.println(response);
    }
}

Response: CreateExternalStorageResponse

Parameters

Parameter	Type	Required	Description
bucket	String	Yes	The name of the bucket on the service provider
name	String	Yes	The name of the provider, this must be unique
storage_type	String	Yes	The type of storage to use
aws_s3	S3Request	No	Only required if you want to create an Amazon S3 storage
azure_blob	AzureRequest	No	Only required if you want to create an Azure Blob Storage
gcs_credentials	String	No	-
path	String	No	The path prefix to use for storing files

---

updateExternalStorage

Modify an existing external storage setup, allowing for adjustments in storage parameters or credentials.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update External Storage
        var response = commonClient.updateExternalStorage(
            "My Feed",
            new UpdateExternalStorageRequest()
                .setBucket("value")
                .setStorageType("value")
                .setAWSS3(new S3Request().setS3Region("value").setS3APIKey("value"))
                .setAzureBlob(new AzureRequest().setAbsAccountName("value").setAbsClientID("value").setAbsClientSecret("value").setAbsTenantID("value"))
        ).execute();

        System.out.println(response);
    }
}

Example: with gcs_credentials and path

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update External Storage
        var response = commonClient.updateExternalStorage(
            "My Feed",
            new UpdateExternalStorageRequest()
                .setBucket("value")
                .setStorageType("value")
                .setGcsCredentials("value")
                .setPath("value")
        ).execute();

        System.out.println(response);
    }
}

Response: UpdateExternalStorageResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	-
bucket	String	Yes	The name of the bucket on the service provider
storage_type	String	Yes	The type of storage to use
aws_s3	S3Request	No	Only required if you want to create an Amazon S3 storage
azure_blob	AzureRequest	No	Only required if you want to create an Azure Blob Storage
gcs_credentials	String	No	-
path	String	No	The path prefix to use for storing files

---

deleteExternalStorage

Remove an external storage configuration, useful for retiring or replacing storage solutions.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete external storage
        var response = commonClient.deleteExternalStorage(
            "My Feed"
        ).execute();

        System.out.println(response);
    }
}

Response: DeleteExternalStorageResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	-

---

checkExternalStorage

Verify the status and connectivity of an external storage system, ensuring reliable data access and storage integrity.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Check External Storage
        var response = commonClient.checkExternalStorage(
            "My Feed"
        ).execute();

        System.out.println(response);
    }
}

Response: CheckExternalStorageResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	-

---

createGuest

Register a temporary guest user, ideal for providing limited access to your system without creating a permanent account.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create Guest
        var response = commonClient.createGuest(
            new CreateGuestRequest()
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Response: CreateGuestResponse

Parameters

Parameter	Type	Required	Description
user	UserRequest	Yes	User object which server acts upon

---

createImportURL

Generates a URL for importing data into the system, useful for initiating data imports via a web link.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create import URL
        var response = commonClient.createImportURL(
            new CreateImportURLRequest()
                .setFilename("value")
        ).execute();

        System.out.println(response);
    }
}

Response: CreateImportURLResponse

Parameters

Parameter	Type	Required	Description
filename	String	No	-

---

listImports

Retrieves a list of all active and completed data imports, helping users track the status and history of their import activities.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get import
        var response = commonClient.listImports().execute();

        System.out.println(response);
    }
}

Response: ListImportsResponse

---

createImport

Initiates a new data import process, allowing users to bring external data into the system for further analysis or usage.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create import
        var response = commonClient.createImport(
            new CreateImportRequest()
                .setMode("value")
                .setPath("value")
                .setMergeCustom(false)
        ).execute();

        System.out.println(response);
    }
}

Response: CreateImportResponse

Parameters

Parameter	Type	Required	Description
mode	String	Yes	-
path	String	Yes	-
merge_custom	Boolean	No	-

---

listImportV2Tasks

Provides a list of all tasks associated with the version 2 import process, enabling users to monitor and manage complex data import operations.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List import v2 tasks
        var response = commonClient.listImportV2Tasks(
            new ListImportV2TasksRequest()
                .setState(10)
        ).execute();

        System.out.println(response);
    }
}

Response: ListImportV2TasksResponse

Parameters

Parameter	Type	Required	Description
state	Integer	No	-

---

createImportV2Task

Starts a new task within the version 2 import framework, offering more granular control over individual data import operations.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create import v2 task
        var response = commonClient.createImportV2Task(
            new CreateImportV2TaskRequest()
                .setProduct("value")
                .setSettings(new ImportV2TaskSettings().setMergeCustom(false))
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Response: CreateImportV2TaskResponse

Parameters

Parameter	Type	Required	Description
product	String	Yes	-
settings	ImportV2TaskSettings	Yes	-
user	UserRequest	No	-
user_id	String	No	-

---

getImporterExternalStorage

Retrieve details about an external storage configuration. Use this method to check the settings of a previously configured external storage system.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get external storage
        var response = commonClient.getImporterExternalStorage().execute();

        System.out.println(response);
    }
}

Response: GetExternalStorageResponse

---

upsertImporterExternalStorage

Create or update an external storage configuration. Use this method to ensure your external storage settings are current and correct.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upsert external storage
        var response = commonClient.upsertImporterExternalStorage(
            new UpsertImporterExternalStorageRequest()
                .setType("like")
                .setAWSS3(new UpsertExternalStorageAWSS3Request().setBucket("value").setRegion("value").setRoleArn("value").setPathPrefix("value"))
        ).execute();

        System.out.println(response);
    }
}

Response: UpsertExternalStorageResponse

Parameters

Parameter	Type	Required	Description
type	String	Yes	-
aws_s3	UpsertExternalStorageAWSS3Request	No	-

---

deleteImporterExternalStorage

Remove an existing external storage configuration. Use this method when you want to disconnect or clean up unused storage settings.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete external storage
        var response = commonClient.deleteImporterExternalStorage().execute();

        System.out.println(response);
    }
}

Response: DeleteExternalStorageResponse

---

validateImporterExternalStorage

Verify the connectivity and configuration of an external storage system. Use this method to test and confirm that your external storage setup is functioning properly.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Validate external storage
        var response = commonClient.validateImporterExternalStorage().execute();

        System.out.println(response);
    }
}

Response: ValidateExternalStorageResponse

---

getImportV2Task

Fetches detailed information about a specific version 2 import task, allowing users to check the progress and details of their import activities.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get import v2 task
        var response = commonClient.getImportV2Task(
            "activity-123"
        ).execute();

        System.out.println(response);
    }
}

Response: GetImportV2TaskResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-

---

deleteImportV2Task

Removes a specific task from the version 2 import process, useful for canceling unwanted or erroneous data import operations.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete import v2 task
        var response = commonClient.deleteImportV2Task(
            "activity-123"
        ).execute();

        System.out.println(response);
    }
}

Response: DeleteImportV2TaskResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-

---

getImport

Obtains details about a specific data import, providing users with insights into the import’s configuration and status.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get import
        var response = commonClient.getImport(
            "activity-123"
        ).execute();

        System.out.println(response);
    }
}

Response: GetImportResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-

---

getOG

Retrieves Open Graph data, which can be used to enhance the display of web content when shared on social media platforms.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get OG
        var response = commonClient.getOG(
            new GetOGRequest()
                .setURL("value")
        ).execute();

        System.out.println(response);
    }
}

Response: GetOGResponse

Parameters

Parameter	Type	Required	Description
url	String	Yes	-

---

listPermissions

Lists all permissions available to a user or within a system, helping users understand their access rights and control over data and functionalities.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List permissions
        var response = commonClient.listPermissions().execute();

        System.out.println(response);
    }
}

Response: ListPermissionsResponse

---

getPermission

Retrieve the permission settings for a specific user or entity, useful for checking access rights before performing operations.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get permission
        var response = commonClient.getPermission(
            "activity-123"
        ).execute();

        System.out.println(response);
    }
}

Response: GetCustomPermissionResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-

---

createPoll

Initiate a new poll with specified parameters, ideal for gathering feedback or opinions from a group of users.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll
        var response = commonClient.createPoll(
            new CreatePollRequest()
                .setName("My Feed")
                .setUserID("john")
                .setID("activity-123")
        ).execute();

        System.out.println(response);
    }
}

Example: with allow_user_suggested_options and description

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll
        var response = commonClient.createPoll(
            new CreatePollRequest()
                .setName("My Feed")
                .setAllowUserSuggestedOptions(false)
                .setDescription("A description")
        ).execute();

        System.out.println(response);
    }
}

Example: with enforce_unique_vote and Custom

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll
        var response = commonClient.createPoll(
            new CreatePollRequest()
                .setName("My Feed")
                .setEnforceUniqueVote(false)
                .setCustom(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Example: with is_closed and max_votes_allowed

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll
        var response = commonClient.createPoll(
            new CreatePollRequest()
                .setName("My Feed")
                .setIsClosed(false)
                .setMaxVotesAllowed(10)
        ).execute();

        System.out.println(response);
    }
}

Response: PollResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	The name of the poll
Custom	Map<String, Object>	No	-
allow_answers	Boolean	No	Indicates whether users can suggest user defined answers
allow_user_suggested_options	Boolean	No	-
description	String	No	A description of the poll
enforce_unique_vote	Boolean	No	Indicates whether users can cast multiple votes
id	String	No	-
is_closed	Boolean	No	Indicates whether the poll is open for voting
max_votes_allowed	Integer	No	Indicates the maximum amount of votes a user can cast
options	[]PollOptionInput	No	-
user	UserRequest	No	-
user_id	String	No	-
voting_visibility	String	No	-

---

updatePoll

Modify an existing poll's details, such as its title or description, to keep it relevant and up-to-date.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll
        var response = commonClient.updatePoll(
            new UpdatePollRequest()
                .setID("activity-123")
                .setName("My Feed")
                .setUserID("john")
                .setAllowAnswers(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with allow_user_suggested_options and description

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll
        var response = commonClient.updatePoll(
            new UpdatePollRequest()
                .setID("activity-123")
                .setName("My Feed")
                .setAllowUserSuggestedOptions(false)
                .setDescription("A description")
        ).execute();

        System.out.println(response);
    }
}

Example: with enforce_unique_vote and is_closed

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll
        var response = commonClient.updatePoll(
            new UpdatePollRequest()
                .setID("activity-123")
                .setName("My Feed")
                .setEnforceUniqueVote(false)
                .setIsClosed(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with max_votes_allowed and options

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll
        var response = commonClient.updatePoll(
            new UpdatePollRequest()
                .setID("activity-123")
                .setName("My Feed")
                .setMaxVotesAllowed(10)
                .setOptions(List.of())
        ).execute();

        System.out.println(response);
    }
}

Response: PollResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	Poll ID
name	String	Yes	Poll name
Custom	Map<String, Object>	No	-
allow_answers	Boolean	No	Allow answers
allow_user_suggested_options	Boolean	No	Allow user suggested options
description	String	No	Poll description
enforce_unique_vote	Boolean	No	Enforce unique vote
is_closed	Boolean	No	Is closed
max_votes_allowed	Integer	No	Max votes allowed
options	[]PollOptionRequest	No	Poll options
user	UserRequest	No	-
user_id	String	No	-
voting_visibility	String	No	Voting visibility

---

queryPolls

Search and filter through existing polls based on specific criteria, helping you quickly find the polls of interest.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query polls
        var response = commonClient.queryPolls(
            new QueryPollsRequest()
                .setUserID("john")
                .setLimit(25)
                .setFilter(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Example: with sort and prev

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query polls
        var response = commonClient.queryPolls(
            new QueryPollsRequest()
                .setSort(List.of())
                .setPrev(null)
        ).execute();

        System.out.println(response);
    }
}

Example: with next

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query polls
        var response = commonClient.queryPolls(
            new QueryPollsRequest()
                .setNext(null)
        ).execute();

        System.out.println(response);
    }
}

Response: QueryPollsResponse

Parameters

Parameter	Type	Required	Description
user_id	String	No	-
filter	Map<String, Object>	No	Filter to apply to the query
limit	Integer	No	-
next	String	No	-
prev	String	No	-
sort	[]SortParamRequest	No	Array of sort parameters

---

getPoll

Access the details of a specific poll, essential for reviewing its content and status before engagement.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get poll
        var response = commonClient.getPoll(
            "poll-123",
            new GetPollRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: PollResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
user_id	String	No	-

---

updatePollPartial

Make targeted updates to specific fields of a poll without altering its entire structure, useful for quick adjustments.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Partial update poll
        var response = commonClient.updatePollPartial(
            "poll-123",
            new UpdatePollPartialRequest()
                .setUserID("john")
                .setUnset(List.of())
        ).execute();

        System.out.println(response);
    }
}

Example: with user and set

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Partial update poll
        var response = commonClient.updatePollPartial(
            "poll-123",
            new UpdatePollPartialRequest()
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
                .setSet(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Response: PollResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
set	Map<String, Object>	No	Sets new field values
unset	[]string	No	Array of field names to unset
user	UserRequest	No	-
user_id	String	No	-

---

deletePoll

Remove a poll from the system, useful for maintaining a clean and relevant set of active polls.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete poll
        var response = commonClient.deletePoll(
            "poll-123",
            new DeletePollRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
user_id	String	No	-

---

createPollOption

Add a new option to an existing poll, expanding the choices available to participants for more comprehensive feedback.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll option
        var response = commonClient.createPollOption(
            "poll-123",
            new CreatePollOptionRequest()
                .setText("Hello, world!")
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Example: with Custom

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create poll option
        var response = commonClient.createPollOption(
            "poll-123",
            new CreatePollOptionRequest()
                .setText("Hello, world!")
                .setCustom(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Response: PollOptionResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
text	String	Yes	Option text
Custom	Map<String, Object>	No	-
user	UserRequest	No	-
user_id	String	No	-

---

updatePollOption

Modify an existing poll option to correct or improve the available responses, ensuring clarity and accuracy.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll option
        var response = commonClient.updatePollOption(
            "poll-123",
            new UpdatePollOptionRequest()
                .setID("activity-123")
                .setText("Hello, world!")
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Example: with Custom

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update poll option
        var response = commonClient.updatePollOption(
            "poll-123",
            new UpdatePollOptionRequest()
                .setID("activity-123")
                .setText("Hello, world!")
                .setCustom(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Response: PollOptionResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
id	String	Yes	Option ID
text	String	Yes	Option text
Custom	Map<String, Object>	No	-
user	UserRequest	No	-
user_id	String	No	-

---

getPollOption

Retrieve details about a specific poll option, aiding in the analysis or review of available choices within a poll.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get poll option
        var response = commonClient.getPollOption(
            "poll-123",
            "value",
            new GetPollOptionRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: PollOptionResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
option_id	String	Yes	-
user_id	String	No	-

---

deletePollOption

Remove a specific option from a poll, useful for managing and updating active polls by eliminating outdated or incorrect choices.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete poll option
        var response = commonClient.deletePollOption(
            "poll-123",
            "value",
            new DeletePollOptionRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
option_id	String	Yes	-
user_id	String	No	-

---

queryPollVotes

Retrieve the current vote counts for a poll, enabling you to assess poll engagement and results in real-time.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query votes
        var response = commonClient.queryPollVotes(
            "poll-123",
            new QueryPollVotesRequest()
                .setUserID("john")
                .setLimit(25)
        ).execute();

        System.out.println(response);
    }
}

Example: with filter and sort

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query votes
        var response = commonClient.queryPollVotes(
            "poll-123",
            new QueryPollVotesRequest()
                .setFilter(Map.of())
                .setSort(List.of())
        ).execute();

        System.out.println(response);
    }
}

Example: with prev and next

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query votes
        var response = commonClient.queryPollVotes(
            "poll-123",
            new QueryPollVotesRequest()
                .setPrev(null)
                .setNext(null)
        ).execute();

        System.out.println(response);
    }
}

Response: PollVotesResponse

Parameters

Parameter	Type	Required	Description
poll_id	String	Yes	-
user_id	String	No	-
filter	Map<String, Object>	No	Filter to apply to the query
limit	Integer	No	-
next	String	No	-
prev	String	No	-
sort	[]SortParamRequest	No	Array of sort parameters

---

updatePushNotificationPreferences

Modify user preferences for receiving push notifications, ensuring users only receive relevant and desired notifications.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Push notification preferences
        var response = commonClient.updatePushNotificationPreferences(
            new UpdatePushNotificationPreferencesRequest()
                .setPreferences(List.of())
        ).execute();

        System.out.println(response);
    }
}

Response: UpsertPushPreferencesResponse

Parameters

Parameter	Type	Required	Description
preferences	[]PushPreferenceInput	Yes	A list of push preferences for channels, calls, or the user.

---

listPushProviders

Obtain a list of all available push notification providers, helpful for understanding your options and managing your notification delivery services.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List push providers
        var response = commonClient.listPushProviders().execute();

        System.out.println(response);
    }
}

Response: ListPushProvidersResponse

---

upsertPushProvider

Create or update the configuration of a push notification provider, allowing you to maintain an effective notification system by adding new providers or adjusting existing ones.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upsert a push provider
        var response = commonClient.upsertPushProvider(
            new UpsertPushProviderRequest()
                .setPushProvider(new PushProviderRequest().setName("My Feed").setApnAuthKey("value"))
        ).execute();

        System.out.println(response);
    }
}

Response: UpsertPushProviderResponse

Parameters

Parameter	Type	Required	Description
push_provider	PushProviderRequest	No	-

---

deletePushProvider

Remove a push notification provider from your system, ideal for cleaning up outdated configurations or switching to a different service provider.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete a push provider
        var response = commonClient.deletePushProvider(
            "like",
            "My Feed"
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
type	String	Yes	-
name	String	Yes	-

---

getPushTemplates

Access a collection of predefined push notification templates, streamlining the process of sending consistent and branded notifications to your users.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get push notification templates
        var response = commonClient.getPushTemplates(
            new GetPushTemplatesRequest()
                .setPushProviderType("value")
                .setPushProviderName("value")
        ).execute();

        System.out.println(response);
    }
}

Response: GetPushTemplatesResponse

Parameters

Parameter	Type	Required	Description
push_provider_type	String	Yes	-
push_provider_name	String	No	-

---

upsertPushTemplate

Create or update a push notification template, enabling you to maintain up-to-date and relevant messaging for your user communications.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upsert a push notification template
        var response = commonClient.upsertPushTemplate(
            new UpsertPushTemplateRequest()
                .setEventType("value")
                .setPushProviderType("value")
                .setEnablePush(false)
                .setPushProviderName("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with template

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upsert a push notification template
        var response = commonClient.upsertPushTemplate(
            new UpsertPushTemplateRequest()
                .setEventType("value")
                .setPushProviderType("value")
                .setTemplate("value")
        ).execute();

        System.out.println(response);
    }
}

Response: UpsertPushTemplateResponse

Parameters

Parameter	Type	Required	Description
event_type	String	Yes	Event type. One of: message.new, message.updated, reaction.new, notification.reminder_due, feeds....
push_provider_type	String	Yes	Push provider type. One of: firebase, apn, huawei, xiaomi
enable_push	Boolean	No	Whether to send push notification for this event
push_provider_name	String	No	Push provider name
template	String	No	Push template

---

getRateLimits

Retrieve the current rate limits applied to your API usage, helping you understand and manage your application's request throughput.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get rate limits
        var response = commonClient.getRateLimits(
            new GetRateLimitsRequest()
                .setServerSide(false)
                .setAndroid(false)
                .setIos(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with web and endpoints

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get rate limits
        var response = commonClient.getRateLimits(
            new GetRateLimitsRequest()
                .setWeb(false)
                .setEndpoints("value")
        ).execute();

        System.out.println(response);
    }
}

Response: GetRateLimitsResponse

Parameters

Parameter	Type	Required	Description
server_side	Boolean	No	-
android	Boolean	No	-
ios	Boolean	No	-
web	Boolean	No	-
endpoints	String	No	-

---

listRoles

Get a comprehensive list of all defined user roles within your application, useful for managing permissions and access control effectively.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List roles
        var response = commonClient.listRoles().execute();

        System.out.println(response);
    }
}

Response: ListRolesResponse

---

createRole

Create a new role within the system to define specific permissions and access levels for users. Use this method to manage and assign roles that align with your organizational needs.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create role
        var response = commonClient.createRole(
            new CreateRoleRequest()
                .setName("My Feed")
        ).execute();

        System.out.println(response);
    }
}

Response: CreateRoleResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	Role name

---

deleteRole

Remove an existing role from the system to maintain an updated and efficient role management structure. Use this method when a role is no longer needed or applicable.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete role
        var response = commonClient.deleteRole(
            "My Feed"
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
name	String	Yes	-

---

getTask

Retrieve the current status and progress of a specific task to monitor its completion and identify potential issues. Use this method to track task performance and ensure timely updates.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get status of a task
        var response = commonClient.getTask(
            "activity-123"
        ).execute();

        System.out.println(response);
    }
}

Response: GetTaskResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-

---

uploadFile

Add a file to the server to facilitate storage and access within your application. Use this method to manage file resources and enhance document availability for users.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upload file
        var response = commonClient.uploadFile(
            new UploadFileRequest()
                .setFile("value")
                .setUser(new OnlyUserID().setID("activity-123"))
        ).execute();

        System.out.println(response);
    }
}

Response: FileUploadResponse

Parameters

Parameter	Type	Required	Description
file	String	No	file field
user	OnlyUserID	No	user for the request server side only

---

deleteFile

Remove a file from the server to manage storage and ensure only relevant files are retained. Use this method to free up space and maintain an organized file system.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete file
        var response = commonClient.deleteFile(
            new DeleteFileRequest()
                .setURL("value")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
url	String	No	-

---

uploadImage

Upload an image to the server for integration into your application’s content. Use this method to manage visual assets and improve the aesthetic and functional aspects of your application.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upload image
        var response = commonClient.uploadImage(
            new UploadImageRequest()
                .setFile("value")
                .setUploadSizes(List.of())
                .setUser(new OnlyUserID().setID("activity-123"))
        ).execute();

        System.out.println(response);
    }
}

Response: ImageUploadResponse

Parameters

Parameter	Type	Required	Description
file	String	No	-
upload_sizes	[]ImageSize	No	field with JSON-encoded array of image size configurations
user	OnlyUserID	No	-

---

deleteImage

Delete an image from the server to manage space and ensure only necessary images are stored. Use this method when an image is outdated or no longer required.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete image
        var response = commonClient.deleteImage(
            new DeleteImageRequest()
                .setURL("value")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
url	String	No	-

---

listUserGroups

Retrieve a list of all user groups. Use this method to view all existing user groups in your system for management or auditing purposes.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List user groups
        var response = commonClient.listUserGroups(
            new ListUserGroupsRequest()
                .setLimit(25)
                .setIDGt("value")
                .setCreatedAtGt("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with team_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // List user groups
        var response = commonClient.listUserGroups(
            new ListUserGroupsRequest()
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: ListUserGroupsResponse

Parameters

Parameter	Type	Required	Description
limit	Integer	No	-
id_gt	String	No	-
created_at_gt	String	No	-
team_id	String	No	-

---

createUserGroup

Establish a new user group. Use this method to organize users into a new group for easier management and permissions assignment.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create user group
        var response = commonClient.createUserGroup(
            new CreateUserGroupRequest()
                .setName("My Feed")
                .setID("activity-123")
                .setDescription("A description")
        ).execute();

        System.out.println(response);
    }
}

Example: with member_ids and team_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Create user group
        var response = commonClient.createUserGroup(
            new CreateUserGroupRequest()
                .setName("My Feed")
                .setMemberIds(List.of())
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: CreateUserGroupResponse

Parameters

Parameter	Type	Required	Description
name	String	Yes	The user friendly name of the user group
description	String	No	An optional description for the group
id	String	No	Optional user group ID. If not provided, a UUID v7 will be generated
member_ids	[]string	No	Optional initial list of user IDs to add as members
team_id	String	No	Optional team ID to scope the group to a team

---

searchUserGroups

Find user groups based on specific criteria. Use this method to quickly locate user groups that meet certain conditions or attributes.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Search user groups
        var response = commonClient.searchUserGroups(
            new SearchUserGroupsRequest()
                .setQuery("value")
                .setLimit(25)
                .setNameGt("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with id_gt and team_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Search user groups
        var response = commonClient.searchUserGroups(
            new SearchUserGroupsRequest()
                .setQuery("value")
                .setIDGt("value")
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: SearchUserGroupsResponse

Parameters

Parameter	Type	Required	Description
query	String	Yes	-
limit	Integer	No	-
name_gt	String	No	-
id_gt	String	No	-
team_id	String	No	-

---

getUserGroup

Obtain detailed information about a specific user group. Use this method to review the properties and configuration of a particular user group.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get user group
        var response = commonClient.getUserGroup(
            "activity-123",
            new GetUserGroupRequest()
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: GetUserGroupResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
team_id	String	No	-

---

updateUserGroup

Modify the details of an existing user group. Use this method to change the attributes or membership of a user group as needed.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update user group
        var response = commonClient.updateUserGroup(
            "activity-123",
            new UpdateUserGroupRequest()
                .setName("My Feed")
                .setDescription("A description")
        ).execute();

        System.out.println(response);
    }
}

Example: with team_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update user group
        var response = commonClient.updateUserGroup(
            "activity-123",
            new UpdateUserGroupRequest()
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: UpdateUserGroupResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
description	String	No	The new description for the group
name	String	No	The new name of the user group
team_id	String	No	-

---

deleteUserGroup

Remove a user group from the system. Use this method when a user group is no longer needed, to maintain cleanliness and organization.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete user group
        var response = commonClient.deleteUserGroup(
            "activity-123",
            new DeleteUserGroupRequest()
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
team_id	String	No	-

---

addUserGroupMembers

Use this method to add multiple users to a specified user group, streamlining group management and access control. Ideal for onboarding new team members or updating group memberships efficiently.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Add user group members
        var response = commonClient.addUserGroupMembers(
            "activity-123",
            new AddUserGroupMembersRequest()
                .setMemberIds(List.of())
                .setAsAdmin(false)
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: AddUserGroupMembersResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
member_ids	[]string	Yes	List of user IDs to add as members
as_admin	Boolean	No	Whether to add the members as group admins. Defaults to false
team_id	String	No	-

---

removeUserGroupMembers

This method allows you to remove multiple users from a specified user group, helping to maintain organized and current access permissions. It is useful for managing group changes when users no longer need access or have left a team.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Remove user group members
        var response = commonClient.removeUserGroupMembers(
            "activity-123",
            new RemoveUserGroupMembersRequest()
                .setMemberIds(List.of())
                .setTeamID("value")
        ).execute();

        System.out.println(response);
    }
}

Response: RemoveUserGroupMembersResponse

Parameters

Parameter	Type	Required	Description
id	String	Yes	-
member_ids	[]string	Yes	List of user IDs to remove
team_id	String	No	-

---

queryUsers

Retrieve information about users based on specific criteria to analyze user data or make informed decisions. Use this method to efficiently filter and access user details in your application.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Query users
        var response = commonClient.queryUsers(
            new QueryUsersRequest()
                .setPayload("value")
        ).execute();

        System.out.println(response);
    }
}

Response: QueryUsersResponse

Parameters

Parameter	Type	Required	Description
payload		No	-

---

updateUsers

Add or modify user information to ensure current and accurate user data within the system. Use this method to manage user profiles effectively and support proper user engagement.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Upsert users
        var response = commonClient.updateUsers(
            new UpdateUsersRequest()
                .setUsers(Map.of())
        ).execute();

        System.out.println(response);
    }
}

Response: UpdateUsersResponse

Parameters

Parameter	Type	Required	Description
users	Map<String, Object>	Yes	Object containing users

---

updateUsersPartial

Apply partial updates to a user's information, allowing for specific changes without overwriting the entire user profile. Use this method for targeted updates to user data, enhancing flexibility and precision.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Partially update user
        var response = commonClient.updateUsersPartial(
            new UpdateUsersPartialRequest()
                .setUsers(List.of())
        ).execute();

        System.out.println(response);
    }
}

Response: UpdateUsersResponse

Parameters

Parameter	Type	Required	Description
users	[]UpdateUserPartialRequest	Yes	-

---

getBlockedUsers

Retrieve a list of users that have been blocked. Use this method to monitor and manage users who are restricted from accessing certain features or areas of your application.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get list of blocked Users
        var response = commonClient.getBlockedUsers(
            new GetBlockedUsersRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: GetBlockedUsersResponse

Parameters

Parameter	Type	Required	Description
user_id	String	No	-

---

blockUsers

Prevent specified users from accessing certain features or areas of your application. This method is useful for managing user behavior and maintaining community standards.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Block user
        var response = commonClient.blockUsers(
            new BlockUsersRequest()
                .setBlockedUserID("value")
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Response: BlockUsersResponse

Parameters

Parameter	Type	Required	Description
blocked_user_id	String	Yes	User id to block
user	UserRequest	No	-
user_id	String	No	-

---

deactivateUsers

Temporarily disable the accounts of specified users, making them inactive. Use this when you need to pause a user's access without permanently deleting their data.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Deactivate users
        var response = commonClient.deactivateUsers(
            new DeactivateUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setCreatedByID("value")
                .setMarkChannelsDeleted(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with mark_messages_deleted

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Deactivate users
        var response = commonClient.deactivateUsers(
            new DeactivateUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setMarkMessagesDeleted(false)
        ).execute();

        System.out.println(response);
    }
}

Response: DeactivateUsersResponse

Parameters

Parameter	Type	Required	Description
user_ids	[]string	Yes	User IDs to deactivate
created_by_id	String	No	ID of the user who deactivated the users
mark_channels_deleted	Boolean	No	-
mark_messages_deleted	Boolean	No	Makes messages appear to be deleted

---

deleteUsers

Permanently remove users and all their associated data from your application. Use this method for irreversible actions when you need to completely eliminate a user's presence.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete Users
        var response = commonClient.deleteUsers(
            new DeleteUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setCalls("value")
                .setConversations("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with files and messages

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete Users
        var response = commonClient.deleteUsers(
            new DeleteUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setFiles(false)
                .setMessages("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with new_call_owner_id and new_channel_owner_id

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete Users
        var response = commonClient.deleteUsers(
            new DeleteUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setNewCallOwnerID("value")
                .setNewChannelOwnerID("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with user

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Delete Users
        var response = commonClient.deleteUsers(
            new DeleteUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setUser({ id: "john" })
        ).execute();

        System.out.println(response);
    }
}

Response: DeleteUsersResponse

Parameters

Parameter	Type	Required	Description
user_ids	[]string	Yes	IDs of users to delete
calls	String	No	Calls delete mode. Affected calls are those that include exactly two members, one of whom is the ...
conversations	String	No	Conversation channels delete mode. Conversation channel is any channel which only has two members...
files	Boolean	No	Delete user files. * false or empty string - doesn't delete any files * true - deletes all files ...
messages	String	No	Message delete mode. * null or empty string - doesn't delete user messages * soft - marks all use...
new_call_owner_id	String	No	-
new_channel_owner_id	String	No	-
user	String	No	User delete mode. * soft - marks user as deleted and retains all user data * pruning - marks user...

---

getUserLiveLocations

Fetch the current live location data of users. This is useful in applications where real-time location tracking is necessary, such as delivery or ride-sharing services.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Get user live locations
        var response = commonClient.getUserLiveLocations(
            new GetUserLiveLocationsRequest()
                .setUserID("john")
        ).execute();

        System.out.println(response);
    }
}

Response: SharedLocationsResponse

Parameters

Parameter	Type	Required	Description
user_id	String	No	-

---

updateLiveLocation

Update the live location data for a user. Use this method to ensure that your application has the most current and accurate location information for users.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update live location
        var response = commonClient.updateLiveLocation(
            new UpdateLiveLocationRequest()
                .setMessageID("value")
                .setUserID("john")
                .setEndAt(10)
        ).execute();

        System.out.println(response);
    }
}

Example: with latitude and longitude

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Update live location
        var response = commonClient.updateLiveLocation(
            new UpdateLiveLocationRequest()
                .setMessageID("value")
                .setLatitude(10)
                .setLongitude(10)
        ).execute();

        System.out.println(response);
    }
}

Response: SharedLocationResponse

Parameters

Parameter	Type	Required	Description
message_id	String	Yes	Live location ID
user_id	String	No	-
end_at	float	No	Time when the live location expires
latitude	float	No	Latitude coordinate
longitude	float	No	Longitude coordinate

---

reactivateUsers

Reactivate previously deactivated user accounts, restoring their access to the application. Use this method to reinstate users who were temporarily paused.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Reactivate users
        var response = commonClient.reactivateUsers(
            new ReactivateUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setCreatedByID("value")
                .setRestoreChannels(false)
        ).execute();

        System.out.println(response);
    }
}

Example: with restore_messages

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Reactivate users
        var response = commonClient.reactivateUsers(
            new ReactivateUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
                .setRestoreMessages(false)
        ).execute();

        System.out.println(response);
    }
}

Response: ReactivateUsersResponse

Parameters

Parameter	Type	Required	Description
user_ids	[]string	Yes	User IDs to reactivate
created_by_id	String	No	ID of the user who's reactivating the users
restore_channels	Boolean	No	-
restore_messages	Boolean	No	Restore previously deleted messages

---

restoreUsers

Restore users and their data after they have been deleted, if you have a recovery mechanism in place. This is useful for recovering mistakenly deleted user accounts.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Restore users
        var response = commonClient.restoreUsers(
            new RestoreUsersRequest()
                .setUserIds(List.of("user-1", "user-2"))
        ).execute();

        System.out.println(response);
    }
}

Response: Response

Parameters

Parameter	Type	Required	Description
user_ids	[]string	Yes	-

---

unblockUsers

Remove the block on specified users, allowing them to regain access to previously restricted features or areas. Use this to reverse previous blocking actions when a user is deemed compliant.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Unblock user
        var response = commonClient.unblockUsers(
            new UnblockUsersRequest()
                .setBlockedUserID("value")
                .setUserID("john")
                .setUser(new UserRequest().setID("activity-123").setCustom(Map.of()))
        ).execute();

        System.out.println(response);
    }
}

Response: UnblockUsersResponse

Parameters

Parameter	Type	Required	Description
blocked_user_id	String	Yes	-
user	UserRequest	No	-
user_id	String	No	-

---

deactivateUser

Temporarily deactivate a single user account, suspending their access. Use this when you need to pause an individual user's account without deleting their data.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Deactivate user
        var response = commonClient.deactivateUser(
            "john",
            new DeactivateUserRequest()
                .setCreatedByID("value")
                .setMarkMessagesDeleted(false)
        ).execute();

        System.out.println(response);
    }
}

Response: DeactivateUserResponse

Parameters

Parameter	Type	Required	Description
user_id	String	Yes	-
created_by_id	String	No	ID of the user who deactivated the user
mark_messages_deleted	Boolean	No	Makes messages appear to be deleted

---

exportUser

ExportUser allows you to retrieve all data associated with a specific user in a structured format, which is useful for data analysis, migration, or compliance purposes.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Export user
        var response = commonClient.exportUser(
            "john"
        ).execute();

        System.out.println(response);
    }
}

Response: ExportUserResponse

Parameters

Parameter	Type	Required	Description
user_id	String	Yes	-

---

reactivateUser

ReactivateUser enables you to restore a previously deactivated user account, making it active again, which is beneficial for reinstating user access after temporary deactivation.

Example

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Reactivate user
        var response = commonClient.reactivateUser(
            "john",
            new ReactivateUserRequest()
                .setName("My Feed")
                .setCreatedByID("value")
        ).execute();

        System.out.println(response);
    }
}

Example: with restore_messages

import io.getstream.services.CommonImpl;
import io.getstream.services.framework.StreamHTTPClient;
import io.getstream.models.*;
import io.getstream.models.framework.StreamResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        StreamHTTPClient httpClient = new StreamHTTPClient(apiKey, apiSecret);
        CommonImpl commonClient = new CommonImpl(httpClient);

        // Reactivate user
        var response = commonClient.reactivateUser(
            "john",
            new ReactivateUserRequest()
                .setRestoreMessages(false)
        ).execute();

        System.out.println(response);
    }
}

Response: ReactivateUserResponse

Parameters

Parameter	Type	Required	Description
user_id	String	Yes	-
created_by_id	String	No	ID of the user who's reactivating the user
name	String	No	Set this field to put new name for the user
restore_messages	Boolean	No	Restore previously deleted messages

---

Types Reference

This section documents the types/interfaces used in this API. These types are extracted from the OpenAPI specification.

AIImageConfig

public class AIImageConfig {
    private Boolean async;
    private Boolean enabled;
    private List<OCRRule> ocr_rules;
    private List<AWSRekognitionRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
ocr_rules	List<OCRRule>	No
rules	List<AWSRekognitionRule>	No

AITextConfig

public class AITextConfig {
    private Boolean async;
    private Boolean enabled;
    private String profile;
    private List<BodyguardRule> rules;
    private List<BodyguardSeverityRule> severity_rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
profile	String	No
rules	List<BodyguardRule>	No
severity_rules	List<BodyguardSeverityRule>	No

AIVideoConfig

public class AIVideoConfig {
    private Boolean async;
    private Boolean enabled;
    private List<AWSRekognitionRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
rules	List<AWSRekognitionRule>	No

APNConfig

public class APNConfig {
    private Boolean Disabled;
    private String auth_key;
    private String auth_type;
    private String bundle_id;
    private Boolean development;
    private String host;
    private String key_id;
    private String notification_template;
    private String p12_cert;
    private String team_id;
}

Properties:

Property	Type	Required	Description
Disabled	Boolean	No
auth_key	String	No
auth_type	String	No
bundle_id	String	No
development	Boolean	No
host	String	No
key_id	String	No
notification_template	String	No
p12_cert	String	No
team_id	String	No

Action

public class Action {
    private String name;
    private String style;
    private String text;
    private String type;
    private String value;
}

Properties:

Property	Type	Required	Description
name	String	Yes
text	String	Yes
type	String	Yes
style	String	No
value	String	No

AddUserGroupMembersResponse

Response for adding members to a user group

public class AddUserGroupMembersResponse {
    private String duration;
    private UserGroupResponse user_group;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_group	UserGroupResponse	No	The updated user group

AppResponseFields

public class AppResponseFields {
    private Map<String, Object> activity_metrics_config;
    private Boolean allow_multi_user_devices;
    private List<String> allowed_flag_reasons;
    private Boolean async_url_enrich_enabled;
    private Boolean auto_translation_enabled;
    private String before_message_send_hook_url;
    private Map<String, Object> call_types;
    private Boolean campaign_enabled;
    private Integer cdn_expiration_seconds;
    private Map<String, Object> channel_configs;
    private String custom_action_handler_url;
    private DataDogInfo datadog_info;
    private Boolean disable_auth_checks;
    private Boolean disable_permissions_checks;
    private String enforce_unique_usernames;
    private List<EventHook> event_hooks;
    private FileUploadConfig file_upload_config;
    private List<GeofenceResponse> geofences;
    private Map<String, Object> grants;
    private Boolean guest_user_creation_disabled;
    private Integer id;
    private Boolean image_moderation_enabled;
    private List<String> image_moderation_labels;
    private FileUploadConfig image_upload_config;
    private Integer max_aggregated_activities_length;
    private Boolean moderation_audio_call_moderation_enabled;
    private ModerationDashboardPreferences moderation_dashboard_preferences;
    private Boolean moderation_enabled;
    private Boolean moderation_llm_configurability_enabled;
    private Boolean moderation_multitenant_blocklist_enabled;
    private String moderation_s3_image_access_role_arn;
    private Boolean moderation_video_call_moderation_enabled;
    private String moderation_webhook_url;
    private Boolean multi_tenant_enabled;
    private String name;
    private String organization;
    private String permission_version;
    private String placement;
    private Map<String, Object> policies;
    private PushNotificationFields push_notifications;
    private Integer reminders_interval;
    private Double revoke_tokens_issued_before;
    private String sns_key;
    private String sns_secret;
    private String sns_topic_arn;
    private String sqs_key;
    private String sqs_secret;
    private String sqs_url;
    private Boolean suspended;
    private String suspended_explanation;
    private Boolean use_hook_v2;
    private Boolean user_response_time_enabled;
    private List<String> user_search_disallowed_roles;
    private List<String> webhook_events;
    private String webhook_url;
}

Properties:

Property	Type	Required	Description
allow_multi_user_devices	Boolean	Yes
async_url_enrich_enabled	Boolean	Yes
auto_translation_enabled	Boolean	Yes
call_types	Map<String, Object>	Yes
campaign_enabled	Boolean	Yes
cdn_expiration_seconds	Integer	Yes
channel_configs	Map<String, Object>	Yes
custom_action_handler_url	String	Yes
disable_auth_checks	Boolean	Yes
disable_permissions_checks	Boolean	Yes
enforce_unique_usernames	String	Yes
event_hooks	List<EventHook>	Yes
file_upload_config	FileUploadConfig	Yes
grants	Map<String, Object>	Yes
guest_user_creation_disabled	Boolean	Yes
id	Integer	Yes
image_moderation_enabled	Boolean	Yes
image_upload_config	FileUploadConfig	Yes
max_aggregated_activities_length	Integer	Yes
moderation_audio_call_moderation_enabled	Boolean	Yes
moderation_enabled	Boolean	Yes
moderation_llm_configurability_enabled	Boolean	Yes
moderation_multitenant_blocklist_enabled	Boolean	Yes
moderation_video_call_moderation_enabled	Boolean	Yes
moderation_webhook_url	String	Yes
multi_tenant_enabled	Boolean	Yes
name	String	Yes
organization	String	Yes
permission_version	String	Yes
placement	String	Yes
policies	Map<String, Object>	Yes
push_notifications	PushNotificationFields	Yes
reminders_interval	Integer	Yes
sns_key	String	Yes
sns_secret	String	Yes
sns_topic_arn	String	Yes
sqs_key	String	Yes
sqs_secret	String	Yes
sqs_url	String	Yes
suspended	Boolean	Yes
suspended_explanation	String	Yes
use_hook_v2	Boolean	Yes
user_response_time_enabled	Boolean	Yes
user_search_disallowed_roles	List<String>	Yes
webhook_events	List<String>	Yes
webhook_url	String	Yes
activity_metrics_config	Map<String, Object>	No
allowed_flag_reasons	List<String>	No
before_message_send_hook_url	String	No
datadog_info	DataDogInfo	No
geofences	List<GeofenceResponse>	No
image_moderation_labels	List<String>	No
moderation_dashboard_preferences	ModerationDashboardPreferences	No
moderation_s3_image_access_role_arn	String	No
revoke_tokens_issued_before	Double	No

AsyncModerationCallbackConfig

public class AsyncModerationCallbackConfig {
    private String mode;
    private String server_url;
}

Properties:

Property	Type	Required	Description
mode	String	No
server_url	String	No

AsyncModerationConfiguration

public class AsyncModerationConfiguration {
    private AsyncModerationCallbackConfig callback;
    private Integer timeout_ms;
}

Properties:

Property	Type	Required	Description
callback	AsyncModerationCallbackConfig	No
timeout_ms	Integer	No

AutomodPlatformCircumventionConfig

public class AutomodPlatformCircumventionConfig {
    private Boolean async;
    private Boolean enabled;
    private List<AutomodRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
rules	List<AutomodRule>	No

AutomodSemanticFiltersConfig

public class AutomodSemanticFiltersConfig {
    private Boolean async;
    private Boolean enabled;
    private List<AutomodSemanticFiltersRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
rules	List<AutomodSemanticFiltersRule>	No

AutomodToxicityConfig

public class AutomodToxicityConfig {
    private Boolean async;
    private Boolean enabled;
    private List<AutomodRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
rules	List<AutomodRule>	No

AzureRequest

Config for creating Azure Blob Storage storage

public class AzureRequest {
    private String abs_account_name;
    private String abs_client_id;
    private String abs_client_secret;
    private String abs_tenant_id;
}

Properties:

Property	Type	Required	Description
abs_account_name	String	Yes	The account name
abs_client_id	String	Yes	The client id
abs_client_secret	String	Yes	The client secret
abs_tenant_id	String	Yes	The tenant id

BlockListConfig

public class BlockListConfig {
    private Boolean async;
    private Boolean enabled;
    private Boolean match_substring;
    private List<BlockListRule> rules;
}

Properties:

Property	Type	Required	Description
async	Boolean	No
enabled	Boolean	No
match_substring	Boolean	No
rules	List<BlockListRule>	No

BlockListResponse

Block list contains restricted words

public class BlockListResponse {
    private Double created_at;
    private String id;
    private Boolean is_leet_check_enabled;
    private Boolean is_plural_check_enabled;
    private String name;
    private String team;
    private String type;
    private Double updated_at;
    private List<String> words;
}

Properties:

Property	Type	Required	Description
is_leet_check_enabled	Boolean	Yes
is_plural_check_enabled	Boolean	Yes
name	String	Yes	Block list name
type	String	Yes	Block list type. One of: regex, domain, domain_allowlist, email, email_allowl...
words	List<String>	Yes	List of words to block
created_at	Double	No	Date/time of creation
id	String	No
team	String	No
updated_at	Double	No	Date/time of the last update

BlockUsersResponse

public class BlockUsersResponse {
    private String blocked_by_user_id;
    private String blocked_user_id;
    private Double created_at;
    private String duration;
}

Properties:

Property	Type	Required	Description
blocked_by_user_id	String	Yes	User id who blocked another user
blocked_user_id	String	Yes	User id who got blocked
created_at	Double	Yes	Timestamp when the user was blocked
duration	String	Yes	Duration of the request in milliseconds

BlockedUserResponse

public class BlockedUserResponse {
    private UserResponse blocked_user;
    private String blocked_user_id;
    private Double created_at;
    private UserResponse user;
    private String user_id;
}

Properties:

Property	Type	Required	Description
blocked_user	UserResponse	Yes	User who got blocked
blocked_user_id	String	Yes	ID of the user who got blocked
created_at	Double	Yes
user	UserResponse	Yes	User who blocked another user
user_id	String	Yes	ID of the user who blocked another user

BodyguardImageAnalysisConfig

public class BodyguardImageAnalysisConfig {
    private List<BodyguardRule> rules;
}

Properties:

Property	Type	Required	Description
rules	List<BodyguardRule>	No

ChannelResponse

Represents channel in chat

public class ChannelResponse {
    private Boolean auto_translation_enabled;
    private String auto_translation_language;
    private Boolean blocked;
    private String cid;
    private ChannelConfigWithInfo config;
    private Integer cooldown;
    private Double created_at;
    private UserResponse created_by;
    private Map<String, Object> custom;
    private Double deleted_at;
    private Boolean disabled;
    private List<String> filter_tags;
    private Boolean frozen;
    private Boolean hidden;
    private Double hide_messages_before;
    private String id;
    private Double last_message_at;
    private Integer member_count;
    private List<ChannelMemberResponse> members;
    private Integer message_count;
    private Double mute_expires_at;
    private Boolean muted;
    private List<ChannelOwnCapability> own_capabilities;
    private String team;
    private Double truncated_at;
    private UserResponse truncated_by;
    private String type;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
cid	String	Yes	Channel CID (<type>:<id>)
created_at	Double	Yes	Date/time of creation
custom	Map<String, Object>	Yes	Custom data for this object
disabled	Boolean	Yes
frozen	Boolean	Yes	Whether channel is frozen or not
id	String	Yes	Channel unique ID
type	String	Yes	Type of the channel
updated_at	Double	Yes	Date/time of the last update
auto_translation_enabled	Boolean	No	Whether auto translation is enabled or not
auto_translation_language	String	No	Language to translate to when auto translation is active
blocked	Boolean	No	Whether this channel is blocked by current user or not
config	ChannelConfigWithInfo	No	Channel configuration
cooldown	Integer	No	Cooldown period after sending each message
created_by	UserResponse	No	Creator of the channel
deleted_at	Double	No	Date/time of deletion
filter_tags	List<String>	No	List of filter tags associated with the channel
hidden	Boolean	No	Whether this channel is hidden by current user or not
hide_messages_before	Double	No	Date since when the message history is accessible
last_message_at	Double	No	Date of the last message sent
member_count	Integer	No	Number of members in the channel
members	List<ChannelMemberResponse>	No	List of channel members (max 100)
message_count	Integer	No	Number of messages in the channel
mute_expires_at	Double	No	Date of mute expiration
muted	Boolean	No	Whether this channel is muted or not
own_capabilities	List<ChannelOwnCapability>	No	List of channel capabilities of authenticated user
team	String	No	Team the channel belongs to (multi-tenant only)
truncated_at	Double	No	Date of the latest truncation of the channel
truncated_by	UserResponse	No

ChatPreferencesInput

public class ChatPreferencesInput {
    private String channel_mentions;
    private String default_preference;
    private String direct_mentions;
    private String group_mentions;
    private String here_mentions;
    private String role_mentions;
    private String thread_replies;
}

Properties:

Property	Type	Required	Description
channel_mentions	String	No
default_preference	String	No
direct_mentions	String	No
group_mentions	String	No
here_mentions	String	No
role_mentions	String	No
thread_replies	String	No

CheckExternalStorageResponse

Basic response information

public class CheckExternalStorageResponse {
    private String duration;
    private String file_url;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
file_url	String	Yes

CheckPushResponse

public class CheckPushResponse {
    private Map<String, Object> device_errors;
    private String duration;
    private String event_type;
    private List<String> general_errors;
    private String rendered_apn_template;
    private String rendered_firebase_template;
    private Map<String, Object> rendered_message;
    private Boolean skip_devices;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
device_errors	Map<String, Object>	No	Object with device errors
event_type	String	No	The event type that was tested
general_errors	List<String>	No	List of general errors
rendered_apn_template	String	No
rendered_firebase_template	String	No
rendered_message	Map<String, Object>	No
skip_devices	Boolean	No	Don't require existing devices to render templates

CheckSNSResponse

public class CheckSNSResponse {
    private Map<String, Object> data;
    private String duration;
    private String error;
    private String status;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
status	String	Yes	Validation result. One of: ok, error
data	Map<String, Object>	No	Error data
error	String	No	Error text

CheckSQSResponse

public class CheckSQSResponse {
    private Map<String, Object> data;
    private String duration;
    private String error;
    private String status;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
status	String	Yes	Validation result. One of: ok, error
data	Map<String, Object>	No	Error data
error	String	No	Error text

CreateBlockListResponse

Basic response information

public class CreateBlockListResponse {
    private BlockListResponse blocklist;
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
blocklist	BlockListResponse	No

CreateExternalStorageResponse

Basic response information

public class CreateExternalStorageResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

CreateGuestResponse

public class CreateGuestResponse {
    private String access_token;
    private String duration;
    private UserResponse user;
}

Properties:

Property	Type	Required	Description
access_token	String	Yes	the access token to authenticate the user
duration	String	Yes	Duration of the request in milliseconds
user	UserResponse	Yes	User object which server acts upon

CreateImportResponse

Basic response information

public class CreateImportResponse {
    private String duration;
    private ImportTask import_task;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
import_task	ImportTask	No

CreateImportURLResponse

Basic response information

public class CreateImportURLResponse {
    private String duration;
    private String path;
    private String upload_url;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
path	String	Yes
upload_url	String	Yes

CreateImportV2TaskResponse

Basic response information

public class CreateImportV2TaskResponse {
    private Integer app_pk;
    private Double created_at;
    private String duration;
    private String id;
    private String product;
    private ImportV2TaskSettings settings;
    private Integer state;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
app_pk	Integer	Yes
created_at	Double	Yes
duration	String	Yes	Duration of the request in milliseconds
id	String	Yes
product	String	Yes
settings	ImportV2TaskSettings	Yes
state	Integer	Yes
updated_at	Double	Yes

CreateRoleResponse

Basic response information

public class CreateRoleResponse {
    private String duration;
    private Role role;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
role	Role	Yes

CreateUserGroupResponse

Response for creating a user group

public class CreateUserGroupResponse {
    private String duration;
    private UserGroupResponse user_group;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_group	UserGroupResponse	No	The created user group

Data

public class Data {
    private String id;
}

Properties:

Property	Type	Required	Description
id	String	Yes

DataDogInfo

public class DataDogInfo {
    private String api_key;
    private Boolean enabled;
    private String site;
}

Properties:

Property	Type	Required	Description
api_key	String	No
enabled	Boolean	No
site	String	No

DeactivateUserResponse

public class DeactivateUserResponse {
    private String duration;
    private UserResponse user;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
user	UserResponse	No	Deactivated user object

DeactivateUsersResponse

Basic response information

public class DeactivateUsersResponse {
    private String duration;
    private String task_id;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
task_id	String	Yes

DeleteExternalStorageResponse

Basic response information

public class DeleteExternalStorageResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

DeleteImportV2TaskResponse

Basic response information

public class DeleteImportV2TaskResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

DeleteUsersResponse

public class DeleteUsersResponse {
    private String duration;
    private String task_id;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
task_id	String	Yes	ID of the task to delete users

DeviceResponse

Response for Device

public class DeviceResponse {
    private Double created_at;
    private Boolean disabled;
    private String disabled_reason;
    private String id;
    private String push_provider;
    private String push_provider_name;
    private String user_id;
    private Boolean voip;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes	Date/time of creation
id	String	Yes	Device ID
push_provider	String	Yes	Push provider
user_id	String	Yes	User ID
disabled	Boolean	No	Whether device is disabled or not
disabled_reason	String	No	Reason explaining why device had been disabled
push_provider_name	String	No	Push provider name
voip	Boolean	No	When true the token is for Apple VoIP push notifications

ErrorResult

public class ErrorResult {
    private String stacktrace;
    private String type;
    private String version;
}

Properties:

Property	Type	Required	Description
type	String	Yes
stacktrace	String	No
version	String	No

EventHook

public class EventHook {
    private AsyncModerationCallbackConfig callback;
    private Double created_at;
    private Boolean enabled;
    private List<String> event_types;
    private String hook_type;
    private String id;
    private String product;
    private Boolean should_send_custom_events;
    private String sns_auth_type;
    private Boolean sns_event_based_message_group_id_enabled;
    private String sns_key;
    private String sns_region;
    private String sns_role_arn;
    private String sns_secret;
    private String sns_topic_arn;
    private String sqs_auth_type;
    private String sqs_key;
    private String sqs_queue_url;
    private String sqs_region;
    private String sqs_role_arn;
    private String sqs_secret;
    private Integer timeout_ms;
    private Double updated_at;
    private String webhook_url;
}

Properties:

Property	Type	Required	Description
callback	AsyncModerationCallbackConfig	No
created_at	Double	No
enabled	Boolean	No
event_types	List<String>	No
hook_type	String	No
id	String	No
product	String	No
should_send_custom_events	Boolean	No
sns_auth_type	String	No
sns_event_based_message_group_id_enabled	Boolean	No
sns_key	String	No
sns_region	String	No
sns_role_arn	String	No
sns_secret	String	No
sns_topic_arn	String	No
sqs_auth_type	String	No
sqs_key	String	No
sqs_queue_url	String	No
sqs_region	String	No
sqs_role_arn	String	No
sqs_secret	String	No
timeout_ms	Integer	No
updated_at	Double	No
webhook_url	String	No

ExportUserResponse

public class ExportUserResponse {
    private String duration;
    private List<MessageResponse> messages;
    private List<ReactionResponse> reactions;
    private UserResponse user;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
messages	List<MessageResponse>	No	List of exported messages
reactions	List<ReactionResponse>	No	List of exported reactions
user	UserResponse	No	Exported user object

ExportUsersResponse

Basic response information

public class ExportUsersResponse {
    private String duration;
    private String task_id;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
task_id	String	Yes

FeedsPreferences

public class FeedsPreferences {
    private String comment;
    private String comment_mention;
    private String comment_reaction;
    private String comment_reply;
    private Map<String, Object> custom_activity_types;
    private String follow;
    private String mention;
    private String reaction;
}

Properties:

Property	Type	Required	Description
comment	String	No	Push notification preference for comments on user's activities. One of: all, ...
comment_mention	String	No	Push notification preference for mentions in comments. One of: all, none
comment_reaction	String	No	Push notification preference for reactions on comments. One of: all, none
comment_reply	String	No	Push notification preference for replies to comments. One of: all, none
custom_activity_types	Map<String, Object>	No	Push notification preferences for custom activity types. Map of activity type...
follow	String	No	Push notification preference for new followers. One of: all, none
mention	String	No	Push notification preference for mentions in activities. One of: all, none
reaction	String	No	Push notification preference for reactions on user's activities or comments. ...

Field

public class Field {
    private Boolean short;
    private String title;
    private String value;
}

Properties:

Property	Type	Required	Description
short	Boolean	Yes
title	String	Yes
value	String	Yes

FileUploadConfig

public class FileUploadConfig {
    private List<String> allowed_file_extensions;
    private List<String> allowed_mime_types;
    private List<String> blocked_file_extensions;
    private List<String> blocked_mime_types;
    private Integer size_limit;
}

Properties:

Property	Type	Required	Description
size_limit	Integer	Yes
allowed_file_extensions	List<String>	No
allowed_mime_types	List<String>	No
blocked_file_extensions	List<String>	No
blocked_mime_types	List<String>	No

FileUploadResponse

public class FileUploadResponse {
    private String duration;
    private String file;
    private String thumb_url;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
file	String	No	URL to the uploaded asset. Should be used to put to asset_url attachment field
thumb_url	String	No	URL of the file thumbnail for supported file formats. Should be put to `thumb...

FirebaseConfig

public class FirebaseConfig {
    private Boolean Disabled;
    private String apn_template;
    private String credentials_json;
    private String data_template;
    private String notification_template;
    private String server_key;
}

Properties:

Property	Type	Required	Description
Disabled	Boolean	No
apn_template	String	No
credentials_json	String	No
data_template	String	No
notification_template	String	No
server_key	String	No

FullUserResponse

public class FullUserResponse {
    private Integer avg_response_time;
    private Double ban_expires;
    private Boolean banned;
    private List<String> blocked_user_ids;
    private Boolean bypass_moderation;
    private List<ChannelMute> channel_mutes;
    private Double created_at;
    private Map<String, Object> custom;
    private Double deactivated_at;
    private Double deleted_at;
    private List<DeviceResponse> devices;
    private String id;
    private String image;
    private Boolean invisible;
    private String language;
    private Double last_active;
    private List<String> latest_hidden_channels;
    private List<UserMuteResponse> mutes;
    private String name;
    private Boolean online;
    private PrivacySettingsResponse privacy_settings;
    private Double revoke_tokens_issued_before;
    private String role;
    private Boolean shadow_banned;
    private List<String> teams;
    private Map<String, Object> teams_role;
    private Integer total_unread_count;
    private Integer unread_channels;
    private Integer unread_count;
    private Integer unread_threads;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
banned	Boolean	Yes
blocked_user_ids	List<String>	Yes
channel_mutes	List<ChannelMute>	Yes
created_at	Double	Yes
custom	Map<String, Object>	Yes
devices	List<DeviceResponse>	Yes
id	String	Yes
invisible	Boolean	Yes
language	String	Yes
mutes	List<UserMuteResponse>	Yes
online	Boolean	Yes
role	String	Yes
shadow_banned	Boolean	Yes
teams	List<String>	Yes
total_unread_count	Integer	Yes
unread_channels	Integer	Yes
unread_count	Integer	Yes
unread_threads	Integer	Yes
updated_at	Double	Yes
avg_response_time	Integer	No
ban_expires	Double	No
bypass_moderation	Boolean	No
deactivated_at	Double	No
deleted_at	Double	No
image	String	No
last_active	Double	No
latest_hidden_channels	List<String>	No
name	String	No
privacy_settings	PrivacySettingsResponse	No
revoke_tokens_issued_before	Double	No
teams_role	Map<String, Object>	No

GetApplicationResponse

Basic response information

public class GetApplicationResponse {
    private AppResponseFields app;
    private String duration;
}

Properties:

Property	Type	Required	Description
app	AppResponseFields	Yes
duration	String	Yes	Duration of the request in milliseconds

GetBlockListResponse

Response for get block list

public class GetBlockListResponse {
    private BlockListResponse blocklist;
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
blocklist	BlockListResponse	No	Block list object

GetBlockedUsersResponse

public class GetBlockedUsersResponse {
    private List<BlockedUserResponse> blocks;
    private String duration;
}

Properties:

Property	Type	Required	Description
blocks	List<BlockedUserResponse>	Yes	Array of blocked user object
duration	String	Yes	Duration of the request in milliseconds

GetCustomPermissionResponse

Basic response information

public class GetCustomPermissionResponse {
    private String duration;
    private Permission permission;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
permission	Permission	Yes

GetExternalStorageAWSS3Response

public class GetExternalStorageAWSS3Response {
    private String bucket;
    private String path_prefix;
    private String region;
    private String role_arn;
}

Properties:

Property	Type	Required	Description
bucket	String	Yes
region	String	Yes
role_arn	String	Yes
path_prefix	String	No

GetExternalStorageResponse

Basic response information

public class GetExternalStorageResponse {
    private GetExternalStorageAWSS3Response aws_s3;
    private Double created_at;
    private String duration;
    private String type;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
duration	String	Yes	Duration of the request in milliseconds
type	String	Yes
updated_at	Double	Yes
aws_s3	GetExternalStorageAWSS3Response	No

GetImportResponse

Basic response information

public class GetImportResponse {
    private String duration;
    private ImportTask import_task;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
import_task	ImportTask	No

GetImportV2TaskResponse

Basic response information

public class GetImportV2TaskResponse {
    private Integer app_pk;
    private Double created_at;
    private String duration;
    private String id;
    private String product;
    private Map<String, Object> result;
    private ImportV2TaskSettings settings;
    private Integer state;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
app_pk	Integer	Yes
created_at	Double	Yes
duration	String	Yes	Duration of the request in milliseconds
id	String	Yes
product	String	Yes
settings	ImportV2TaskSettings	Yes
state	Integer	Yes
updated_at	Double	Yes
result	Map<String, Object>	No

GetOGResponse

public class GetOGResponse {
    private List<Action> actions;
    private String asset_url;
    private String author_icon;
    private String author_link;
    private String author_name;
    private String color;
    private Map<String, Object> custom;
    private String duration;
    private String fallback;
    private List<Field> fields;
    private String footer;
    private String footer_icon;
    private Images giphy;
    private String image_url;
    private String og_scrape_url;
    private Integer original_height;
    private Integer original_width;
    private String pretext;
    private String text;
    private String thumb_url;
    private String title;
    private String title_link;
    private String type;
}

Properties:

Property	Type	Required	Description
custom	Map<String, Object>	Yes
duration	String	Yes
actions	List<Action>	No
asset_url	String	No	URL of detected video or audio
author_icon	String	No
author_link	String	No	og:site
author_name	String	No	og:site_name
color	String	No
fallback	String	No
fields	List<Field>	No
footer	String	No
footer_icon	String	No
giphy	Images	No
image_url	String	No	URL of detected image
og_scrape_url	String	No	extracted url from the text
original_height	Integer	No
original_width	Integer	No
pretext	String	No
text	String	No	og:description
thumb_url	String	No	URL of detected thumb image
title	String	No	og:title
title_link	String	No	og:url
type	String	No	Attachment type, could be empty, image, audio or video

GetPushTemplatesResponse

Basic response information

public class GetPushTemplatesResponse {
    private String duration;
    private List<PushTemplateResponse> templates;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
templates	List<PushTemplateResponse>	Yes

GetRateLimitsResponse

public class GetRateLimitsResponse {
    private Map<String, Object> android;
    private String duration;
    private Map<String, Object> ios;
    private Map<String, Object> server_side;
    private Map<String, Object> web;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
android	Map<String, Object>	No	Map of endpoint rate limits for the Android platform
ios	Map<String, Object>	No	Map of endpoint rate limits for the iOS platform
server_side	Map<String, Object>	No	Map of endpoint rate limits for the server-side platform
web	Map<String, Object>	No	Map of endpoint rate limits for the web platform

GetTaskResponse

public class GetTaskResponse {
    private Double created_at;
    private String duration;
    private ErrorResult error;
    private Map<String, Object> result;
    private String status;
    private String task_id;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
duration	String	Yes
status	String	Yes	Current status of task
task_id	String	Yes	ID of task
updated_at	Double	Yes
error	ErrorResult	No	Error produced by task
result	Map<String, Object>	No	Result produced by task after completion

GetUserGroupResponse

Response for getting a user group

public class GetUserGroupResponse {
    private String duration;
    private UserGroupResponse user_group;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_group	UserGroupResponse	No	The user group

GoogleVisionConfig

public class GoogleVisionConfig {
    private Boolean enabled;
}

Properties:

Property	Type	Required	Description
enabled	Boolean	No

HuaweiConfig

public class HuaweiConfig {
    private Boolean Disabled;
    private String id;
    private String secret;
}

Properties:

Property	Type	Required	Description
Disabled	Boolean	No
id	String	No
secret	String	No

ImageSize

public class ImageSize {
    private String crop;
    private Integer height;
    private String resize;
    private Integer width;
}

Properties:

Property	Type	Required	Description
crop	String	No	Crop mode. One of: top, bottom, left, right, center
height	Integer	No	Target image height
resize	String	No	Resize method. One of: clip, crop, scale, fill
width	Integer	No	Target image width

ImageUploadResponse

public class ImageUploadResponse {
    private String duration;
    private String file;
    private String thumb_url;
    private List<ImageSize> upload_sizes;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
file	String	No
thumb_url	String	No
upload_sizes	List<ImageSize>	No	Array of image size configurations

Images

public class Images {
    private ImageData fixed_height;
    private ImageData fixed_height_downsampled;
    private ImageData fixed_height_still;
    private ImageData fixed_width;
    private ImageData fixed_width_downsampled;
    private ImageData fixed_width_still;
    private ImageData original;
}

Properties:

Property	Type	Required	Description
fixed_height	ImageData	Yes
fixed_height_downsampled	ImageData	Yes
fixed_height_still	ImageData	Yes
fixed_width	ImageData	Yes
fixed_width_downsampled	ImageData	Yes
fixed_width_still	ImageData	Yes
original	ImageData	Yes

ImportTask

public class ImportTask {
    private Double created_at;
    private List<ImportTaskHistory> history;
    private String id;
    private String mode;
    private String path;
    private Integer size;
    private String state;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
history	List<ImportTaskHistory>	Yes
id	String	Yes
mode	String	Yes
path	String	Yes
state	String	Yes
updated_at	Double	Yes
size	Integer	No

ImportV2TaskItem

public class ImportV2TaskItem {
    private Integer app_pk;
    private Double created_at;
    private String id;
    private String product;
    private Map<String, Object> result;
    private ImportV2TaskSettings settings;
    private Integer state;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
app_pk	Integer	Yes
created_at	Double	Yes
id	String	Yes
product	String	Yes
settings	ImportV2TaskSettings	Yes
state	Integer	Yes
updated_at	Double	Yes
result	Map<String, Object>	No

ImportV2TaskSettings

public class ImportV2TaskSettings {
    private Boolean merge_custom;
    private String mode;
    private String path;
    private ImportV2TaskSettingsS3 s3;
    private Boolean skip_references_check;
    private String source;
}

Properties:

Property	Type	Required	Description
merge_custom	Boolean	No
mode	String	No
path	String	No
s3	ImportV2TaskSettingsS3	No
skip_references_check	Boolean	No
source	String	No

ImportV2TaskSettingsS3

public class ImportV2TaskSettingsS3 {
    private String bucket;
    private String dir;
    private String region;
}

Properties:

Property	Type	Required	Description
bucket	String	No
dir	String	No
region	String	No

LLMConfig

public class LLMConfig {
    private String app_context;
    private Boolean async;
    private Boolean enabled;
    private List<LLMRule> rules;
    private Map<String, Object> severity_descriptions;
}

Properties:

Property	Type	Required	Description
app_context	String	No
async	Boolean	No
enabled	Boolean	No
rules	List<LLMRule>	No
severity_descriptions	Map<String, Object>	No

ListBlockListResponse

Basic response information

public class ListBlockListResponse {
    private List<BlockListResponse> blocklists;
    private String duration;
}

Properties:

Property	Type	Required	Description
blocklists	List<BlockListResponse>	Yes
duration	String	Yes	Duration of the request in milliseconds

ListDevicesResponse

List devices response

public class ListDevicesResponse {
    private List<DeviceResponse> devices;
    private String duration;
}

Properties:

Property	Type	Required	Description
devices	List<DeviceResponse>	Yes	List of devices
duration	String	Yes

ListExternalStorageResponse

Basic response information

public class ListExternalStorageResponse {
    private String duration;
    private Map<String, Object> external_storages;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
external_storages	Map<String, Object>	Yes

ListImportV2TasksResponse

Basic response information

public class ListImportV2TasksResponse {
    private String duration;
    private List<ImportV2TaskItem> import_tasks;
    private String next;
    private String prev;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
import_tasks	List<ImportV2TaskItem>	Yes
next	String	No
prev	String	No

ListImportsResponse

Basic response information

public class ListImportsResponse {
    private String duration;
    private List<ImportTask> import_tasks;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
import_tasks	List<ImportTask>	Yes

ListPermissionsResponse

Basic response information

public class ListPermissionsResponse {
    private String duration;
    private List<Permission> permissions;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
permissions	List<Permission>	Yes

ListPushProvidersResponse

Basic response information

public class ListPushProvidersResponse {
    private String duration;
    private List<PushProviderResponse> push_providers;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
push_providers	List<PushProviderResponse>	Yes

ListRolesResponse

Basic response information

public class ListRolesResponse {
    private String duration;
    private List<Role> roles;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
roles	List<Role>	Yes

ListUserGroupsResponse

Response for listing user groups

public class ListUserGroupsResponse {
    private String duration;
    private List<UserGroupResponse> user_groups;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_groups	List<UserGroupResponse>	Yes	List of user groups

MessageResponse

Represents any chat message

public class MessageResponse {
    private List<Attachment> attachments;
    private String cid;
    private String command;
    private Double created_at;
    private Map<String, Object> custom;
    private Double deleted_at;
    private Boolean deleted_for_me;
    private Integer deleted_reply_count;
    private DraftResponse draft;
    private String html;
    private Map<String, Object> i18n;
    private String id;
    private Map<String, Object> image_labels;
    private List<ReactionResponse> latest_reactions;
    private ChannelMemberResponse member;
    private Boolean mentioned_channel;
    private List<String> mentioned_group_ids;
    private Boolean mentioned_here;
    private List<String> mentioned_roles;
    private List<UserResponse> mentioned_users;
    private Double message_text_updated_at;
    private String mml;
    private ModerationV2Response moderation;
    private List<ReactionResponse> own_reactions;
    private String parent_id;
    private Double pin_expires;
    private Boolean pinned;
    private Double pinned_at;
    private UserResponse pinned_by;
    private PollResponseData poll;
    private String poll_id;
    private MessageResponse quoted_message;
    private String quoted_message_id;
    private Map<String, Object> reaction_counts;
    private Map<String, Object> reaction_groups;
    private Map<String, Object> reaction_scores;
    private ReminderResponseData reminder;
    private Integer reply_count;
    private List<String> restricted_visibility;
    private Boolean shadowed;
    private SharedLocationResponseData shared_location;
    private Boolean show_in_channel;
    private Boolean silent;
    private String text;
    private List<UserResponse> thread_participants;
    private String type;
    private Double updated_at;
    private UserResponse user;
}

Properties:

Property	Type	Required	Description
attachments	List<Attachment>	Yes	Array of message attachments
cid	String	Yes	Channel unique identifier in <type>:<id> format
created_at	Double	Yes	Date/time of creation
custom	Map<String, Object>	Yes
deleted_reply_count	Integer	Yes
html	String	Yes	Contains HTML markup of the message. Can only be set when using server-side API
id	String	Yes	Message ID is unique string identifier of the message
latest_reactions	List<ReactionResponse>	Yes	List of 10 latest reactions to this message
mentioned_channel	Boolean	Yes	Whether the message mentioned the channel tag
mentioned_here	Boolean	Yes	Whether the message mentioned online users with @here tag
mentioned_users	List<UserResponse>	Yes	List of mentioned users
own_reactions	List<ReactionResponse>	Yes	List of 10 latest reactions of authenticated user to this message
pinned	Boolean	Yes	Whether message is pinned or not
reaction_counts	Map<String, Object>	Yes	An object containing number of reactions of each type. Key: reaction type (st...
reaction_scores	Map<String, Object>	Yes	An object containing scores of reactions of each type. Key: reaction type (st...
reply_count	Integer	Yes	Number of replies to this message
restricted_visibility	List<String>	Yes	A list of user ids that have restricted visibility to the message, if the lis...
shadowed	Boolean	Yes	Whether the message was shadowed or not
silent	Boolean	Yes	Whether message is silent or not
text	String	Yes	Text of the message. Should be empty if mml is provided
type	String	Yes	Contains type of the message. One of: regular, ephemeral, error, reply, syste...
updated_at	Double	Yes	Date/time of the last update
user	UserResponse	Yes	Sender of the message. Required when using server-side API
command	String	No	Contains provided slash command
deleted_at	Double	No	Date/time of deletion
deleted_for_me	Boolean	No
draft	DraftResponse	No
i18n	Map<String, Object>	No	Object with translations. Key language contains the original language key. ...
image_labels	Map<String, Object>	No	Contains image moderation information
member	ChannelMemberResponse	No	Channel member data for the message sender including only the channel_role
mentioned_group_ids	List<String>	No	List of user group IDs mentioned in the message. Group members who are also c...
mentioned_roles	List<String>	No	List of roles mentioned in the message (e.g. admin, channel_moderator, custom...
message_text_updated_at	Double	No
mml	String	No	Should be empty if text is provided. Can only be set when using server-side...
moderation	ModerationV2Response	No
parent_id	String	No	ID of parent message (thread)
pin_expires	Double	No	Date when pinned message expires
pinned_at	Double	No	Date when message got pinned
pinned_by	UserResponse	No	Contains user who pinned the message
poll	PollResponseData	No
poll_id	String	No	Identifier of the poll to include in the message
quoted_message	MessageResponse	No	Contains quoted message
quoted_message_id	String	No
reaction_groups	Map<String, Object>	No
reminder	ReminderResponseData	No
shared_location	SharedLocationResponseData	No	Contains shared location data
show_in_channel	Boolean	No	Whether thread reply should be shown in the channel as well
thread_participants	List<UserResponse>	No	List of users who participate in thread

ModerationConfig

public class ModerationConfig {
    private AIImageConfig ai_image_config;
    private BodyguardImageAnalysisConfig ai_image_lite_config;
    private AITextConfig ai_text_config;
    private AIVideoConfig ai_video_config;
    private Boolean async;
    private AutomodPlatformCircumventionConfig automod_platform_circumvention_config;
    private AutomodSemanticFiltersConfig automod_semantic_filters_config;
    private AutomodToxicityConfig automod_toxicity_config;
    private BlockListConfig block_list_config;
    private Double created_at;
    private GoogleVisionConfig google_vision_config;
    private String key;
    private LLMConfig llm_config;
    private List<String> supported_video_call_harm_types;
    private String team;
    private Double updated_at;
    private VelocityFilterConfig velocity_filter_config;
    private VideoCallRuleConfig video_call_rule_config;
}

Properties:

Property	Type	Required	Description
ai_image_config	AIImageConfig	No
ai_image_lite_config	BodyguardImageAnalysisConfig	No
ai_text_config	AITextConfig	No
ai_video_config	AIVideoConfig	No
async	Boolean	No
automod_platform_circumvention_config	AutomodPlatformCircumventionConfig	No
automod_semantic_filters_config	AutomodSemanticFiltersConfig	No
automod_toxicity_config	AutomodToxicityConfig	No
block_list_config	BlockListConfig	No
created_at	Double	No
google_vision_config	GoogleVisionConfig	No
key	String	No
llm_config	LLMConfig	No
supported_video_call_harm_types	List<String>	No
team	String	No
updated_at	Double	No
velocity_filter_config	VelocityFilterConfig	No
video_call_rule_config	VideoCallRuleConfig	No

ModerationDashboardPreferences

public class ModerationDashboardPreferences {
    private List<String> allowed_moderation_action_reasons;
    private Boolean async_review_queue_upsert;
    private Boolean disable_audit_logs;
    private Boolean disable_flagging_reviewed_entity;
    private Boolean escalation_queue_enabled;
    private List<String> escalation_reasons;
    private Boolean flag_user_on_flagged_content;
    private Map<String, Object> keyframe_classifications_map;
    private Boolean media_queue_blur_enabled;
    private OverviewDashboardConfig overview_dashboard;
}

Properties:

Property	Type	Required	Description
allowed_moderation_action_reasons	List<String>	No
async_review_queue_upsert	Boolean	No
disable_audit_logs	Boolean	No
disable_flagging_reviewed_entity	Boolean	No
escalation_queue_enabled	Boolean	No
escalation_reasons	List<String>	No
flag_user_on_flagged_content	Boolean	No
keyframe_classifications_map	Map<String, Object>	No
media_queue_blur_enabled	Boolean	No
overview_dashboard	OverviewDashboardConfig	No

OnlyUserID

public class OnlyUserID {
    private String id;
}

Properties:

Property	Type	Required	Description
id	String	Yes

OverviewDashboardConfig

public class OverviewDashboardConfig {
    private Integer default_date_range_days;
    private List<String> visible_charts;
}

Properties:

Property	Type	Required	Description
default_date_range_days	Integer	No
visible_charts	List<String>	No

PagerRequest

public class PagerRequest {
    private Integer limit;
    private String next;
    private String prev;
}

Properties:

Property	Type	Required	Description
limit	Integer	No
next	String	No
prev	String	No

Permission

public class Permission {
    private String action;
    private Map<String, Object> condition;
    private Boolean custom;
    private String description;
    private String id;
    private String level;
    private String name;
    private Boolean owner;
    private Boolean same_team;
    private List<String> tags;
}

Properties:

Property	Type	Required	Description
action	String	Yes	Action name this permission is for (e.g. SendMessage)
custom	Boolean	Yes	Whether this is a custom permission or built-in
description	String	Yes	Description of the permission
id	String	Yes	Unique permission ID
level	String	Yes	Level at which permission could be applied (app or channel). One of: app, cha...
name	String	Yes	Name of the permission
owner	Boolean	Yes	Whether this permission applies to resource owner or not
same_team	Boolean	Yes	Whether this permission applies to teammates (multi-tenancy mode only)
tags	List<String>	Yes	List of tags of the permission
condition	Map<String, Object>	No	MongoDB style condition which decides whether or not the permission is granted

PollOptionInput

public class PollOptionInput {
    private Map<String, Object> custom;
    private String text;
}

Properties:

Property	Type	Required	Description
custom	Map<String, Object>	No
text	String	No

PollOptionRequest

public class PollOptionRequest {
    private Map<String, Object> custom;
    private String id;
    private String text;
}

Properties:

Property	Type	Required	Description
id	String	Yes
custom	Map<String, Object>	No
text	String	No

PollOptionResponse

public class PollOptionResponse {
    private String duration;
    private PollOptionResponseData poll_option;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
poll_option	PollOptionResponseData	Yes	Poll option

PollOptionResponseData

public class PollOptionResponseData {
    private Map<String, Object> custom;
    private String id;
    private String text;
}

Properties:

Property	Type	Required	Description
custom	Map<String, Object>	Yes
id	String	Yes
text	String	Yes

PollResponse

public class PollResponse {
    private String duration;
    private PollResponseData poll;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
poll	PollResponseData	Yes	Poll

PollResponseData

public class PollResponseData {
    private Boolean allow_answers;
    private Boolean allow_user_suggested_options;
    private Integer answers_count;
    private Double created_at;
    private UserResponse created_by;
    private String created_by_id;
    private Map<String, Object> custom;
    private String description;
    private Boolean enforce_unique_vote;
    private String id;
    private Boolean is_closed;
    private List<PollVoteResponseData> latest_answers;
    private Map<String, Object> latest_votes_by_option;
    private Integer max_votes_allowed;
    private String name;
    private List<PollOptionResponseData> options;
    private List<PollVoteResponseData> own_votes;
    private Double updated_at;
    private Integer vote_count;
    private Map<String, Object> vote_counts_by_option;
    private String voting_visibility;
}

Properties:

Property	Type	Required	Description
allow_answers	Boolean	Yes
allow_user_suggested_options	Boolean	Yes
answers_count	Integer	Yes
created_at	Double	Yes
created_by_id	String	Yes
custom	Map<String, Object>	Yes
description	String	Yes
enforce_unique_vote	Boolean	Yes
id	String	Yes
latest_answers	List<PollVoteResponseData>	Yes
latest_votes_by_option	Map<String, Object>	Yes
name	String	Yes
options	List<PollOptionResponseData>	Yes
own_votes	List<PollVoteResponseData>	Yes
updated_at	Double	Yes
vote_count	Integer	Yes
vote_counts_by_option	Map<String, Object>	Yes
voting_visibility	String	Yes
created_by	UserResponse	No
is_closed	Boolean	No
max_votes_allowed	Integer	No

PollVoteResponseData

public class PollVoteResponseData {
    private String answer_text;
    private Double created_at;
    private String id;
    private Boolean is_answer;
    private String option_id;
    private String poll_id;
    private Double updated_at;
    private UserResponse user;
    private String user_id;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
id	String	Yes
option_id	String	Yes
poll_id	String	Yes
updated_at	Double	Yes
answer_text	String	No
is_answer	Boolean	No
user	UserResponse	No
user_id	String	No

PollVotesResponse

public class PollVotesResponse {
    private String duration;
    private String next;
    private String prev;
    private List<PollVoteResponseData> votes;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
votes	List<PollVoteResponseData>	Yes	Poll votes
next	String	No
prev	String	No

PrivacySettingsResponse

public class PrivacySettingsResponse {
    private DeliveryReceiptsResponse delivery_receipts;
    private ReadReceiptsResponse read_receipts;
    private TypingIndicatorsResponse typing_indicators;
}

Properties:

Property	Type	Required	Description
delivery_receipts	DeliveryReceiptsResponse	No
read_receipts	ReadReceiptsResponse	No
typing_indicators	TypingIndicatorsResponse	No

PushConfig

public class PushConfig {
    private Boolean offline_only;
    private String version;
}

Properties:

Property	Type	Required	Description
version	String	Yes
offline_only	Boolean	No

PushPreferenceInput

public class PushPreferenceInput {
    private String call_level;
    private String channel_cid;
    private String chat_level;
    private ChatPreferencesInput chat_preferences;
    private Double disabled_until;
    private String feeds_level;
    private FeedsPreferences feeds_preferences;
    private Boolean remove_disable;
    private String user_id;
}

Properties:

Property	Type	Required	Description
call_level	String	No	Set the level of call push notifications for the user. One of: all, none, def...
channel_cid	String	No	Set the push preferences for a specific channel. If empty it sets the default...
chat_level	String	No	Set the level of chat push notifications for the user. Note: "mentions" is de...
chat_preferences	ChatPreferencesInput	No
disabled_until	Double	No	Disable push notifications till a certain time
feeds_level	String	No	Set the level of feeds push notifications for the user. One of: all, none, de...
feeds_preferences	FeedsPreferences	No	Set granular feeds preferences for reactions, comments, new followers, mentio...
remove_disable	Boolean	No	Remove the disabled until time. (IE stop snoozing notifications)
user_id	String	No	The user id for which to set the push preferences. Required when using server...

PushProvider

public class PushProvider {
    private String apn_auth_key;
    private String apn_auth_type;
    private Boolean apn_development;
    private String apn_host;
    private String apn_key_id;
    private String apn_notification_template;
    private String apn_p12_cert;
    private String apn_team_id;
    private String apn_topic;
    private Double created_at;
    private String description;
    private Double disabled_at;
    private String disabled_reason;
    private String firebase_apn_template;
    private String firebase_credentials;
    private String firebase_data_template;
    private String firebase_host;
    private String firebase_notification_template;
    private String firebase_server_key;
    private String huawei_app_id;
    private String huawei_app_secret;
    private String huawei_host;
    private String name;
    private List<PushTemplate> push_templates;
    private String type;
    private Double updated_at;
    private String xiaomi_app_secret;
    private String xiaomi_package_name;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
name	String	Yes
type	String	Yes
updated_at	Double	Yes
apn_auth_key	String	No
apn_auth_type	String	No
apn_development	Boolean	No
apn_host	String	No
apn_key_id	String	No
apn_notification_template	String	No
apn_p12_cert	String	No
apn_team_id	String	No
apn_topic	String	No
description	String	No
disabled_at	Double	No
disabled_reason	String	No
firebase_apn_template	String	No
firebase_credentials	String	No
firebase_data_template	String	No
firebase_host	String	No
firebase_notification_template	String	No
firebase_server_key	String	No
huawei_app_id	String	No
huawei_app_secret	String	No
huawei_host	String	No
push_templates	List<PushTemplate>	No
xiaomi_app_secret	String	No
xiaomi_package_name	String	No

PushProviderRequest

public class PushProviderRequest {
    private String apn_auth_key;
    private String apn_auth_type;
    private Boolean apn_development;
    private String apn_host;
    private String apn_key_id;
    private String apn_notification_template;
    private String apn_p12_cert;
    private String apn_team_id;
    private String apn_topic;
    private String description;
    private Double disabled_at;
    private String disabled_reason;
    private String firebase_apn_template;
    private String firebase_credentials;
    private String firebase_data_template;
    private String firebase_host;
    private String firebase_notification_template;
    private String firebase_server_key;
    private String huawei_app_id;
    private String huawei_app_secret;
    private String name;
    private String type;
    private String xiaomi_app_secret;
    private String xiaomi_package_name;
}

Properties:

Property	Type	Required	Description
name	String	Yes
apn_auth_key	String	No
apn_auth_type	String	No
apn_development	Boolean	No
apn_host	String	No
apn_key_id	String	No
apn_notification_template	String	No
apn_p12_cert	String	No
apn_team_id	String	No
apn_topic	String	No
description	String	No
disabled_at	Double	No
disabled_reason	String	No
firebase_apn_template	String	No
firebase_credentials	String	No
firebase_data_template	String	No
firebase_host	String	No
firebase_notification_template	String	No
firebase_server_key	String	No
huawei_app_id	String	No
huawei_app_secret	String	No
type	String	No
xiaomi_app_secret	String	No
xiaomi_package_name	String	No

PushProviderResponse

public class PushProviderResponse {
    private String apn_auth_key;
    private String apn_auth_type;
    private Boolean apn_development;
    private String apn_host;
    private String apn_key_id;
    private String apn_p12_cert;
    private Boolean apn_sandbox_certificate;
    private Boolean apn_supports_remote_notifications;
    private Boolean apn_supports_voip_notifications;
    private String apn_team_id;
    private String apn_topic;
    private Double created_at;
    private String description;
    private Double disabled_at;
    private String disabled_reason;
    private String firebase_apn_template;
    private String firebase_credentials;
    private String firebase_data_template;
    private String firebase_host;
    private String firebase_notification_template;
    private String firebase_server_key;
    private String huawei_app_id;
    private String huawei_app_secret;
    private String name;
    private String type;
    private Double updated_at;
    private String xiaomi_app_secret;
    private String xiaomi_package_name;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
name	String	Yes
type	String	Yes
updated_at	Double	Yes
apn_auth_key	String	No
apn_auth_type	String	No
apn_development	Boolean	No
apn_host	String	No
apn_key_id	String	No
apn_p12_cert	String	No
apn_sandbox_certificate	Boolean	No
apn_supports_remote_notifications	Boolean	No
apn_supports_voip_notifications	Boolean	No
apn_team_id	String	No
apn_topic	String	No
description	String	No
disabled_at	Double	No
disabled_reason	String	No
firebase_apn_template	String	No
firebase_credentials	String	No
firebase_data_template	String	No
firebase_host	String	No
firebase_notification_template	String	No
firebase_server_key	String	No
huawei_app_id	String	No
huawei_app_secret	String	No
xiaomi_app_secret	String	No
xiaomi_package_name	String	No

PushTemplate

public class PushTemplate {
    private Double created_at;
    private Boolean enable_push;
    private String event_type;
    private String template;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
enable_push	Boolean	Yes
event_type	String	Yes
updated_at	Double	Yes
template	String	No

PushTemplateResponse

public class PushTemplateResponse {
    private Double created_at;
    private Boolean enable_push;
    private String event_type;
    private String push_provider_internal_id;
    private String template;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes	Time when the template was created
enable_push	Boolean	Yes	Whether push notification is enabled for this event
event_type	String	Yes	Type of event this template applies to
push_provider_internal_id	String	Yes	Internal ID of the push provider
updated_at	Double	Yes	Time when the template was last updated
template	String	No	The push notification template

QueryPollsResponse

public class QueryPollsResponse {
    private String duration;
    private String next;
    private List<PollResponseData> polls;
    private String prev;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
polls	List<PollResponseData>	Yes	Polls data returned by the query
next	String	No
prev	String	No

QueryUsersResponse

public class QueryUsersResponse {
    private String duration;
    private List<FullUserResponse> users;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
users	List<FullUserResponse>	Yes	Array of users as result of filters applied.

ReactionResponse

public class ReactionResponse {
    private Double created_at;
    private Map<String, Object> custom;
    private String message_id;
    private Integer score;
    private String type;
    private Double updated_at;
    private UserResponse user;
    private String user_id;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes	Date/time of creation
custom	Map<String, Object>	Yes	Custom data for this object
message_id	String	Yes	Message ID
score	Integer	Yes	Score of the reaction
type	String	Yes	Type of reaction
updated_at	Double	Yes	Date/time of the last update
user	UserResponse	Yes	User
user_id	String	Yes	User ID

ReactivateUserResponse

public class ReactivateUserResponse {
    private String duration;
    private UserResponse user;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
user	UserResponse	No	Deactivated user object

ReactivateUsersResponse

Basic response information

public class ReactivateUsersResponse {
    private String duration;
    private String task_id;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
task_id	String	Yes

RemoveUserGroupMembersResponse

Response for removing members from a user group

public class RemoveUserGroupMembersResponse {
    private String duration;
    private UserGroupResponse user_group;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_group	UserGroupResponse	No	The updated user group

Response

Basic response information

public class Response {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

Role

public class Role {
    private Double created_at;
    private Boolean custom;
    private String name;
    private List<String> scopes;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes	Date/time of creation
custom	Boolean	Yes	Whether this is a custom role or built-in
name	String	Yes	Unique role name
scopes	List<String>	Yes	List of scopes where this role is currently present. .app means that role i...
updated_at	Double	Yes	Date/time of the last update

S3Request

Config for creating Amazon S3 storage.

public class S3Request {
    private String s3_api_key;
    private String s3_custom_endpoint_url;
    private String s3_region;
    private String s3_secret;
}

Properties:

Property	Type	Required	Description
s3_region	String	Yes	The AWS region where the bucket is hosted
s3_api_key	String	No	The AWS API key. To use Amazon S3 as your storage provider, you have two auth...
s3_custom_endpoint_url	String	No	The custom endpoint for S3. If you want to use a custom endpoint, you must al...
s3_secret	String	No	The AWS API Secret

SearchUserGroupsResponse

Response for searching user groups

public class SearchUserGroupsResponse {
    private String duration;
    private List<UserGroupResponse> user_groups;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_groups	List<UserGroupResponse>	Yes	List of matching user groups

SharedLocationResponse

public class SharedLocationResponse {
    private ChannelResponse channel;
    private String channel_cid;
    private Double created_at;
    private String created_by_device_id;
    private String duration;
    private Double end_at;
    private Double latitude;
    private Double longitude;
    private MessageResponse message;
    private String message_id;
    private Double updated_at;
    private String user_id;
}

Properties:

Property	Type	Required	Description
channel_cid	String	Yes	Channel CID
created_at	Double	Yes	Date/time of creation
created_by_device_id	String	Yes	Device ID that created the live location
duration	String	Yes
latitude	Double	Yes	Latitude coordinate
longitude	Double	Yes	Longitude coordinate
message_id	String	Yes	Message ID
updated_at	Double	Yes	Date/time of the last update
user_id	String	Yes	User ID
channel	ChannelResponse	No
end_at	Double	No	Time when the live location expires
message	MessageResponse	No

SharedLocationResponseData

public class SharedLocationResponseData {
    private ChannelResponse channel;
    private String channel_cid;
    private Double created_at;
    private String created_by_device_id;
    private Double end_at;
    private Double latitude;
    private Double longitude;
    private MessageResponse message;
    private String message_id;
    private Double updated_at;
    private String user_id;
}

Properties:

Property	Type	Required	Description
channel_cid	String	Yes
created_at	Double	Yes
created_by_device_id	String	Yes
latitude	Double	Yes
longitude	Double	Yes
message_id	String	Yes
updated_at	Double	Yes
user_id	String	Yes
channel	ChannelResponse	No
end_at	Double	No
message	MessageResponse	No

SharedLocationsResponse

public class SharedLocationsResponse {
    private List<SharedLocationResponseData> active_live_locations;
    private String duration;
}

Properties:

Property	Type	Required	Description
active_live_locations	List<SharedLocationResponseData>	Yes
duration	String	Yes

SortParamRequest

public class SortParamRequest {
    private Integer direction;
    private String field;
    private String type;
}

Properties:

Property	Type	Required	Description
direction	Integer	No	Direction of sorting, 1 for Ascending, -1 for Descending, default is 1. One o...
field	String	No	Name of field to sort by
type	String	No	Type of field to sort by. Empty string or omitted means string type (default)...

Time

public class Time {
}

UnblockUsersResponse

public class UnblockUsersResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

UpdateBlockListResponse

Basic response information

public class UpdateBlockListResponse {
    private BlockListResponse blocklist;
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
blocklist	BlockListResponse	No

UpdateExternalStorageResponse

Basic response information

public class UpdateExternalStorageResponse {
    private String bucket;
    private String duration;
    private String name;
    private String path;
    private String type;
}

Properties:

Property	Type	Required	Description
bucket	String	Yes
duration	String	Yes	Duration of the request in milliseconds
name	String	Yes
path	String	Yes
type	String	Yes

UpdateUserGroupResponse

Response for updating a user group

public class UpdateUserGroupResponse {
    private String duration;
    private UserGroupResponse user_group;
}

Properties:

Property	Type	Required	Description
duration	String	Yes
user_group	UserGroupResponse	No	The updated user group

UpdateUserPartialRequest

public class UpdateUserPartialRequest {
    private String id;
    private Map<String, Object> set;
    private List<String> unset;
}

Properties:

Property	Type	Required	Description
id	String	Yes	User ID to update
set	Map<String, Object>	No
unset	List<String>	No

UpdateUsersResponse

public class UpdateUsersResponse {
    private String duration;
    private String membership_deletion_task_id;
    private Map<String, Object> users;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
membership_deletion_task_id	String	Yes
users	Map<String, Object>	Yes	Object containing users

UpsertExternalStorageAWSS3Request

public class UpsertExternalStorageAWSS3Request {
    private String bucket;
    private String path_prefix;
    private String region;
    private String role_arn;
}

Properties:

Property	Type	Required	Description
bucket	String	Yes
region	String	Yes
role_arn	String	Yes
path_prefix	String	No

UpsertExternalStorageResponse

Basic response information

public class UpsertExternalStorageResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

UpsertPushPreferencesResponse

public class UpsertPushPreferencesResponse {
    private String duration;
    private Map<String, Object> user_channel_preferences;
    private Map<String, Object> user_preferences;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
user_channel_preferences	Map<String, Object>	Yes	The channel specific push notification preferences, only returned for channel...
user_preferences	Map<String, Object>	Yes	The user preferences, always returned regardless if you edited it

UpsertPushProviderResponse

Basic response information

public class UpsertPushProviderResponse {
    private String duration;
    private PushProviderResponse push_provider;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
push_provider	PushProviderResponse	Yes

UpsertPushTemplateResponse

Basic response information

public class UpsertPushTemplateResponse {
    private String duration;
    private PushTemplateResponse template;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds
template	PushTemplateResponse	No

User

public class User {
    private Map<String, Object> data;
    private String id;
}

Properties:

Property	Type	Required	Description
id	String	Yes
data	Map<String, Object>	No

UserGroupResponse

public class UserGroupResponse {
    private Double created_at;
    private String created_by;
    private String description;
    private String id;
    private List<UserGroupMember> members;
    private String name;
    private String team_id;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
created_at	Double	Yes
id	String	Yes
name	String	Yes
updated_at	Double	Yes
created_by	String	No
description	String	No
members	List<UserGroupMember>	No
team_id	String	No

UserRequest

User request object

public class UserRequest {
    private Map<String, Object> custom;
    private String id;
    private String image;
    private Boolean invisible;
    private String language;
    private String name;
    private PrivacySettingsResponse privacy_settings;
    private String role;
    private List<String> teams;
    private Map<String, Object> teams_role;
}

Properties:

Property	Type	Required	Description
id	String	Yes	User ID
custom	Map<String, Object>	No	Custom user data
image	String	No	User's profile image URL
invisible	Boolean	No
language	String	No
name	String	No	Optional name of user
privacy_settings	PrivacySettingsResponse	No
role	String	No	User's global role
teams	List<String>	No	List of teams the user belongs to
teams_role	Map<String, Object>	No	Map of team-specific roles for the user

UserResponse

User response object

public class UserResponse {
    private Integer avg_response_time;
    private Double ban_expires;
    private Boolean banned;
    private List<String> blocked_user_ids;
    private Boolean bypass_moderation;
    private Double created_at;
    private Map<String, Object> custom;
    private Double deactivated_at;
    private Double deleted_at;
    private List<DeviceResponse> devices;
    private String id;
    private String image;
    private Boolean invisible;
    private String language;
    private Double last_active;
    private String name;
    private Boolean online;
    private PrivacySettingsResponse privacy_settings;
    private PushNotificationSettingsResponse push_notifications;
    private Double revoke_tokens_issued_before;
    private String role;
    private Boolean shadow_banned;
    private List<String> teams;
    private Map<String, Object> teams_role;
    private Double updated_at;
}

Properties:

Property	Type	Required	Description
banned	Boolean	Yes	Whether a user is banned or not
blocked_user_ids	List<String>	Yes
created_at	Double	Yes	Date/time of creation
custom	Map<String, Object>	Yes	Custom data for this object
id	String	Yes	Unique user identifier
invisible	Boolean	Yes
language	String	Yes	Preferred language of a user
online	Boolean	Yes	Whether a user online or not
role	String	Yes	Determines the set of user permissions
shadow_banned	Boolean	Yes	Whether a user is shadow banned
teams	List<String>	Yes	List of teams user is a part of
updated_at	Double	Yes	Date/time of the last update
avg_response_time	Integer	No
ban_expires	Double	No	Date when ban expires
bypass_moderation	Boolean	No
deactivated_at	Double	No	Date of deactivation
deleted_at	Double	No	Date/time of deletion
devices	List<DeviceResponse>	No	List of devices user is using
image	String	No
last_active	Double	No	Date of last activity
name	String	No	Optional name of user
privacy_settings	PrivacySettingsResponse	No	User privacy settings
push_notifications	PushNotificationSettingsResponse	No	User push notification settings
revoke_tokens_issued_before	Double	No	Revocation date for tokens
teams_role	Map<String, Object>	No

ValidateExternalStorageResponse

Basic response information

public class ValidateExternalStorageResponse {
    private String duration;
}

Properties:

Property	Type	Required	Description
duration	String	Yes	Duration of the request in milliseconds

VelocityFilterConfig

public class VelocityFilterConfig {
    private Boolean advanced_filters;
    private Boolean async;
    private Boolean cascading_actions;
    private Integer cids_per_user;
    private Boolean enabled;
    private Boolean first_message_only;
    private List<VelocityFilterConfigRule> rules;
}

Properties:

Property	Type	Required	Description
advanced_filters	Boolean	No
async	Boolean	No
cascading_actions	Boolean	No
cids_per_user	Integer	No
enabled	Boolean	No
first_message_only	Boolean	No
rules	List<VelocityFilterConfigRule>	No

VideoCallRuleConfig

public class VideoCallRuleConfig {
    private Boolean flag_all_labels;
    private List<String> flagged_labels;
    private List<HarmConfig> rules;
}

Properties:

Property	Type	Required	Description
flag_all_labels	Boolean	No
flagged_labels	List<String>	No
rules	List<HarmConfig>	No

XiaomiConfig

public class XiaomiConfig {
    private Boolean Disabled;
    private String package_name;
    private String secret;
}

Properties:

Property	Type	Required	Description
Disabled	Boolean	No
package_name	String	No
secret	String	No

---

← Back to Index

Edit this page

Contributors: github-actions[bot]

Previous pageFeeds

Next pageModeration