video-serverside-api.yaml

components:
  schemas:
    APIError:
      nullable: true
      properties:
        StatusCode:
          description: Response HTTP status code
          format: int32
          title: Status code
          type: integer
          x-stream-index: "004"
        code:
          description: API error code
          format: int32
          title: Code
          type: integer
          x-stream-index: "001"
        details:
          description: Additional error-specific information
          items:
            type: integer
          title: Details
          type: array
          x-stream-index: "007"
        duration:
          description: Request duration
          title: Duration
          type: string
          x-stream-index: "005"
        exception_fields:
          additionalProperties:
            type: string
          description: Additional error info
          title: Exception fields
          type: object
          x-stream-index: "003"
        message:
          description: Message describing an error
          title: Message
          type: string
          x-stream-index: "002"
        more_info:
          description: URL with additional information
          title: More info
          type: string
          x-stream-index: "006"
        unrecoverable:
          description: Flag that indicates if the error is unrecoverable, requests
            that return unrecoverable errors should not be retried, this error only
            applies to the request that caused it
          title: Unrecoverable
          type: boolean
          x-stream-index: "008"
      required:
      - code
      - message
      - StatusCode
      - duration
      - more_info
      - details
      title: Error response
      type: object
    APNConfig:
      properties:
        Disabled:
          type: boolean
          writeOnly: true
          x-stream-index: "005"
        auth_key:
          type: string
          x-stream-index: "006.001"
        auth_type:
          enum:
          - certificate
          - token
          type: string
          x-stream-index: "001"
        bundle_id:
          type: string
          x-stream-index: "004"
        development:
          type: boolean
          x-stream-index: "002"
        host:
          type: string
          x-stream-index: "003"
        key_id:
          type: string
          x-stream-index: "006.002"
        notification_template:
          type: string
          x-stream-index: "008"
        p12_cert:
          type: string
          x-stream-index: "007.001"
        team_id:
          type: string
          x-stream-index: "006.003"
      type: object
    APNConfigFields:
      properties:
        auth_key:
          type: string
          x-stream-index: "009"
        auth_type:
          type: string
          x-stream-index: "003"
        bundle_id:
          type: string
          x-stream-index: "006"
        development:
          type: boolean
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        host:
          type: string
          x-stream-index: "005"
        key_id:
          type: string
          x-stream-index: "008"
        notification_template:
          type: string
          x-stream-index: "004"
        p12_cert:
          type: string
          x-stream-index: "010"
        team_id:
          type: string
          x-stream-index: "007"
      required:
      - enabled
      - development
      type: object
    APNS:
      properties:
        body:
          type: string
          x-stream-index: "002"
        content-available:
          format: int32
          type: integer
          x-stream-index: "004"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        mutable-content:
          format: int32
          type: integer
          x-stream-index: "005"
        sound:
          type: string
          x-stream-index: "003"
        title:
          type: string
          x-stream-index: "001"
      required:
      - title
      - body
      type: object
    Action:
      nullable: true
      properties:
        name:
          type: string
          x-stream-index: "001"
        style:
          type: string
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "004"
        value:
          type: string
          x-stream-index: "005"
      required:
      - name
      - text
      - type
      type: object
    ActiveCallsBitrateStats:
      properties:
        p10:
          format: float
          type: number
          x-stream-index: "001"
        p50:
          format: float
          type: number
          x-stream-index: "002"
      required:
      - p10
      - p50
      type: object
    ActiveCallsFPSStats:
      properties:
        p05:
          format: float
          type: number
          x-stream-index: "001"
        p10:
          format: float
          type: number
          x-stream-index: "002"
        p50:
          format: float
          type: number
          x-stream-index: "003"
        p90:
          format: float
          type: number
          x-stream-index: "004"
      required:
      - p05
      - p10
      - p50
      - p90
      type: object
    ActiveCallsLatencyStats:
      properties:
        p50:
          format: float
          type: number
          x-stream-index: "001"
        p90:
          format: float
          type: number
          x-stream-index: "002"
      required:
      - p50
      - p90
      type: object
    ActiveCallsMetrics:
      properties:
        join_call_api:
          $ref: '#/components/schemas/JoinCallAPIMetrics'
          x-stream-index: "001"
        publishers:
          $ref: '#/components/schemas/PublishersMetrics'
          x-stream-index: "002"
        subscribers:
          $ref: '#/components/schemas/SubscribersMetrics'
          x-stream-index: "003"
      type: object
    ActiveCallsResolutionStats:
      properties:
        p10:
          format: float
          type: number
          x-stream-index: "001"
        p50:
          format: float
          type: number
          x-stream-index: "002"
      required:
      - p10
      - p50
      type: object
    ActiveCallsSummary:
      properties:
        active_calls:
          format: int32
          type: integer
          x-stream-index: "001"
        active_publishers:
          format: int32
          type: integer
          x-stream-index: "002"
        active_subscribers:
          format: int32
          type: integer
          x-stream-index: "003"
        participants:
          format: int32
          type: integer
          x-stream-index: "004"
      required:
      - active_calls
      - active_publishers
      - active_subscribers
      - participants
      type: object
    AppResponseFields:
      properties:
        allow_multi_user_devices:
          type: boolean
          x-stream-index: "018"
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: "022"
        async_url_enrich_enabled:
          type: boolean
          x-stream-index: "020"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "023"
        before_message_send_hook_url:
          type: string
          x-stream-index: "024"
        call_types:
          additionalProperties:
            $ref: '#/components/schemas/CallType'
          type: object
          x-stream-index: "009"
        campaign_enabled:
          type: boolean
          x-stream-index: "037"
        cdn_expiration_seconds:
          format: int32
          type: integer
          x-stream-index: "040"
        channel_configs:
          additionalProperties:
            $ref: '#/components/schemas/ChannelConfig'
          type: object
          x-stream-index: "008"
        custom_action_handler_url:
          type: string
          x-stream-index: "025"
        datadog_info:
          $ref: '#/components/schemas/DataDogInfo'
          x-stream-index: "043"
        disable_auth_checks:
          type: boolean
          x-stream-index: "013"
        disable_permissions_checks:
          type: boolean
          x-stream-index: "014"
        enforce_unique_usernames:
          type: string
          x-stream-index: "026"
        event_hooks:
          items:
            $ref: '#/components/schemas/EventHook'
          type: array
          x-stream-index: "048"
        file_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "033"
        geofences:
          items:
            $ref: '#/components/schemas/GeofenceResponse'
          type: array
          x-stream-index: "042"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "036"
        guest_user_creation_disabled:
          type: boolean
          x-stream-index: "046"
        id:
          format: int32
          type: integer
          x-stream-index: "001"
        image_moderation_enabled:
          type: boolean
          x-stream-index: "019"
        image_moderation_labels:
          items:
            type: string
          type: array
          x-stream-index: "021"
        image_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "034"
        max_aggregated_activities_length:
          format: int32
          type: integer
          x-stream-index: "053"
        moderation_bulk_submit_action_enabled:
          type: boolean
          x-stream-index: "051"
        moderation_dashboard_preferences:
          $ref: '#/components/schemas/ModerationDashboardPreferences'
          x-stream-index: "047"
        moderation_enabled:
          type: boolean
          x-stream-index: "044"
        moderation_llm_configurability_enabled:
          type: boolean
          x-stream-index: "052"
        moderation_multitenant_blocklist_enabled:
          type: boolean
          x-stream-index: "045"
        moderation_webhook_url:
          type: string
          x-stream-index: "007"
        multi_tenant_enabled:
          type: boolean
          x-stream-index: "017"
        name:
          type: string
          x-stream-index: "002"
        organization:
          type: string
          x-stream-index: "003"
        permission_version:
          type: string
          x-stream-index: "015"
        placement:
          type: string
          x-stream-index: "004"
        policies:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Policy'
            type: array
          type: object
          x-stream-index: "010"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationFields'
          x-stream-index: "005"
        reminders_interval:
          format: int32
          type: integer
          x-stream-index: "039"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "035"
        sns_key:
          type: string
          x-stream-index: "031"
        sns_secret:
          type: string
          x-stream-index: "032"
        sns_topic_arn:
          type: string
          x-stream-index: "030"
        sqs_key:
          type: string
          x-stream-index: "028"
        sqs_secret:
          type: string
          x-stream-index: "029"
        sqs_url:
          type: string
          x-stream-index: "027"
        suspended:
          type: boolean
          x-stream-index: "011"
        suspended_explanation:
          type: string
          x-stream-index: "012"
        use_hook_v2:
          type: boolean
          x-stream-index: "049"
        user_response_time_enabled:
          type: boolean
          x-stream-index: "050"
        user_search_disallowed_roles:
          items:
            type: string
          type: array
          x-stream-index: "016"
        webhook_events:
          items:
            type: string
          type: array
          x-stream-index: "038"
        webhook_url:
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      - organization
      - placement
      - push_notifications
      - webhook_url
      - moderation_webhook_url
      - channel_configs
      - call_types
      - policies
      - suspended
      - suspended_explanation
      - disable_auth_checks
      - disable_permissions_checks
      - permission_version
      - user_search_disallowed_roles
      - multi_tenant_enabled
      - allow_multi_user_devices
      - image_moderation_enabled
      - async_url_enrich_enabled
      - auto_translation_enabled
      - custom_action_handler_url
      - enforce_unique_usernames
      - sqs_url
      - sqs_key
      - sqs_secret
      - sns_topic_arn
      - sns_key
      - sns_secret
      - file_upload_config
      - image_upload_config
      - grants
      - campaign_enabled
      - webhook_events
      - reminders_interval
      - cdn_expiration_seconds
      - video_provider
      - moderation_enabled
      - moderation_multitenant_blocklist_enabled
      - guest_user_creation_disabled
      - event_hooks
      - use_hook_v2
      - user_response_time_enabled
      - moderation_bulk_submit_action_enabled
      - moderation_llm_configurability_enabled
      - max_aggregated_activities_length
      type: object
    AsyncExportChannelsEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.channels.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportChannelsEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportErrorEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        error:
          type: string
          x-stream-index: "001"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.channels.error
          type: string
          x-stream-index: "003.002"
      required:
      - error
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportErrorEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportUsersEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.users.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportUsersEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncModerationCallbackConfig:
      properties:
        mode:
          enum:
          - CALLBACK_MODE_NONE
          - CALLBACK_MODE_REST
          - CALLBACK_MODE_TWIRP
          type: string
          x-stream-index: "002"
        server_url:
          type: string
          x-stream-index: "001"
      type: object
    AsyncModerationConfiguration:
      properties:
        callback:
          $ref: '#/components/schemas/AsyncModerationCallbackConfig'
          x-stream-index: "002"
        timeout_ms:
          format: int32
          type: integer
          x-stream-index: "001"
      type: object
    Attachment:
      description: An attachment is a message object that represents a file uploaded
        by a user.
      nullable: true
      properties:
        actions:
          items:
            $ref: '#/components/schemas/Action'
          type: array
          x-stream-index: "015"
        asset_url:
          type: string
          x-stream-index: "017"
        author_icon:
          type: string
          x-stream-index: "007"
        author_link:
          type: string
          x-stream-index: "006"
        author_name:
          type: string
          x-stream-index: "005"
        color:
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "018"
        fallback:
          type: string
          x-stream-index: "002"
        fields:
          items:
            $ref: '#/components/schemas/Field'
          type: array
          x-stream-index: "016"
        footer:
          type: string
          x-stream-index: "013"
        footer_icon:
          type: string
          x-stream-index: "014"
        giphy:
          $ref: '#/components/schemas/Images'
          x-stream-index: "019"
        image_url:
          type: string
          x-stream-index: "011"
        og_scrape_url:
          type: string
          x-stream-index: "020"
        original_height:
          format: int32
          type: integer
          x-stream-index: "022"
        original_width:
          format: int32
          type: integer
          x-stream-index: "021"
        pretext:
          type: string
          x-stream-index: "004"
        text:
          type: string
          x-stream-index: "010"
        thumb_url:
          type: string
          x-stream-index: "012"
        title:
          type: string
          x-stream-index: "008"
        title_link:
          type: string
          x-stream-index: "009"
        type:
          description: Attachment type (e.g. image, video, url)
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - custom
      title: Attachment
      type: object
      x-stream-docs-page-id: file_uploads
    AudioSettings:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        hifi_audio_enabled:
          type: boolean
          x-stream-index: "008"
        mic_default_on:
          type: boolean
          x-stream-index: "004"
        noise_cancellation:
          $ref: '#/components/schemas/NoiseCancellationSettings'
          x-stream-index: "007"
        opus_dtx_enabled:
          type: boolean
          x-stream-index: "002"
        redundant_coding_enabled:
          type: boolean
          x-stream-index: "003"
        speaker_default_on:
          type: boolean
          x-stream-index: "005"
      required:
      - access_request_enabled
      - opus_dtx_enabled
      - redundant_coding_enabled
      - mic_default_on
      - speaker_default_on
      - default_device
      - hifi_audio_enabled
      type: object
    AudioSettingsRequest:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        hifi_audio_enabled:
          type: boolean
          x-stream-index: "008"
        mic_default_on:
          type: boolean
          x-stream-index: "004"
        noise_cancellation:
          $ref: '#/components/schemas/NoiseCancellationSettings'
          x-stream-index: "007"
        opus_dtx_enabled:
          type: boolean
          x-stream-index: "002"
        redundant_coding_enabled:
          type: boolean
          x-stream-index: "003"
        speaker_default_on:
          type: boolean
          x-stream-index: "005"
      required:
      - default_device
      type: object
    AudioSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        hifi_audio_enabled:
          type: boolean
          x-stream-index: "008"
        mic_default_on:
          type: boolean
          x-stream-index: "004"
        noise_cancellation:
          $ref: '#/components/schemas/NoiseCancellationSettings'
          x-stream-index: "007"
        opus_dtx_enabled:
          type: boolean
          x-stream-index: "002"
        redundant_coding_enabled:
          type: boolean
          x-stream-index: "003"
        speaker_default_on:
          type: boolean
          x-stream-index: "005"
      required:
      - access_request_enabled
      - opus_dtx_enabled
      - redundant_coding_enabled
      - mic_default_on
      - speaker_default_on
      - default_device
      - hifi_audio_enabled
      type: object
    AzureRequest:
      description: Config for creating Azure Blob Storage storage
      properties:
        abs_account_name:
          description: The account name
          title: AccountName
          type: string
          x-stream-index: "001"
        abs_client_id:
          description: The client id
          title: ClientID
          type: string
          x-stream-index: "003"
        abs_client_secret:
          description: The client secret
          title: ClientSecret
          type: string
          x-stream-index: "004"
        abs_tenant_id:
          description: The tenant id
          title: TenantID
          type: string
          x-stream-index: "002"
      required:
      - abs_account_name
      - abs_tenant_id
      - abs_client_id
      - abs_client_secret
      title: AzureRequest
      type: object
    BackstageSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - enabled
      type: object
    BackstageSettingsRequest:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
      type: object
    BackstageSettingsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - enabled
      type: object
    BlockListOptions:
      properties:
        behavior:
          description: Blocklist behavior
          enum:
          - flag
          - block
          - shadow_block
          title: Behavior
          type: string
          x-stream-index: "002"
        blocklist:
          description: Blocklist name
          title: Blocklist
          type: string
          x-stream-index: "001"
      required:
      - blocklist
      - behavior
      type: object
    BlockListResponse:
      description: Block list contains restricted words
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001"
        id:
          type: string
          x-stream-index: "003"
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "008"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "009"
        name:
          description: Block list name
          title: Name
          type: string
          x-stream-index: "004"
        team:
          type: string
          x-stream-index: "007"
        type:
          description: Block list type.
          title: Type
          type: string
          x-stream-index: "005"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "002"
        words:
          description: List of words to block
          items:
            type: string
          title: Words
          type: array
          x-stream-index: "006"
      required:
      - name
      - type
      - words
      - is_leet_check_enabled
      - is_plural_check_enabled
      title: Block list
      type: object
      x-stream-docs-page-id: block_lists
    BlockUserRequest:
      description: BlockUserRequest is the payload for blocking a user.
      nullable: true
      properties:
        user_id:
          description: the user to block
          title: UserID
          type: string
          x-stream-index: "003"
      required:
      - user_id
      title: BlockUserRequest
      type: object
    BlockUserResponse:
      description: BlockUserResponse is the payload for blocking a user.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: BlockUserResponse
      type: object
    BlockUsersRequest:
      nullable: true
      properties:
        blocked_user_id:
          description: User id to block
          title: BlockedUserID
          type: string
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      required:
      - blocked_user_id
      type: object
    BlockUsersResponse:
      nullable: true
      properties:
        blocked_by_user_id:
          description: User id who blocked another user
          title: BlockedByUserID
          type: string
          x-stream-index: "002"
        blocked_user_id:
          description: User id who got blocked
          title: BlockedUserID
          type: string
          x-stream-index: "003"
        created_at:
          description: Timestamp when the user was blocked
          format: date-time
          title: CreatedAt
          type: number
          x-stream-index: "004"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      - blocked_by_user_id
      - blocked_user_id
      - created_at
      type: object
    BlockedUserEvent:
      description: |-
        This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.
        If the user is the current user, the client should leave the call screen as well
      properties:
        blocked_by_user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that blocked the user, null if the user was blocked
            by server-side
          title: Blocked by
          x-stream-index: "004"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.blocked_user
          description: 'The type of event: "call.blocked_user" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that was blocked
          title: User
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user
      title: BlockedUserEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    BlockedUserResponse:
      nullable: true
      properties:
        blocked_user:
          $ref: '#/components/schemas/UserResponse'
          description: User who got blocked
          title: User
          x-stream-index: "003"
        blocked_user_id:
          description: ID of the user who got blocked
          title: UserID
          type: string
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who blocked another user
          title: User
          x-stream-index: "001"
        user_id:
          description: ID of the user who blocked another user
          title: UserID
          type: string
          x-stream-index: "002"
      required:
      - user
      - user_id
      - blocked_user
      - blocked_user_id
      - created_at
      type: object
    Bound:
      properties:
        inclusive:
          type: boolean
          x-stream-index: "002"
        value:
          format: float
          type: number
          x-stream-index: "001"
      required:
      - value
      - inclusive
      type: object
    BroadcastSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        hls:
          $ref: '#/components/schemas/HLSSettings'
          x-stream-index: "002"
        rtmp:
          $ref: '#/components/schemas/RTMPSettings'
          x-stream-index: "003"
      required:
      - enabled
      type: object
    BroadcastSettingsRequest:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        hls:
          $ref: '#/components/schemas/HLSSettingsRequest'
          x-stream-index: "002"
        rtmp:
          $ref: '#/components/schemas/RTMPSettingsRequest'
          x-stream-index: "003"
      type: object
    BroadcastSettingsResponse:
      description: BroadcastSettingsResponse is the payload for broadcasting settings
      properties:
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "001"
        hls:
          $ref: '#/components/schemas/HLSSettingsResponse'
          title: HLS
          x-stream-index: "002"
        rtmp:
          $ref: '#/components/schemas/RTMPSettingsResponse'
          title: RTMP
          x-stream-index: "003"
      required:
      - enabled
      - hls
      - rtmp
      title: BroadcastSettingsResponse
      type: object
    BrowserDataResponse:
      properties:
        name:
          type: string
          x-stream-index: "001"
        version:
          type: string
          x-stream-index: "002"
      type: object
    CallAcceptedEvent:
      description: This event is sent when a user accepts a notification to join a
        call.
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.accepted
          description: 'The type of event: "call.accepted" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who accepted the call
          title: User
          x-stream-index: "004"
      required:
      - type
      - created_at
      - call_cid
      - call
      - user
      title: CallAcceptedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: ring
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallClosedCaption:
      description: CallClosedCaption represents a closed caption of a call.
      properties:
        end_time:
          format: date-time
          title: The end time of the closed caption.
          type: number
          x-stream-index: "004"
        id:
          title: The ID of the closed caption.
          type: string
          x-stream-index: "001"
        language:
          title: The language of the closed caption.
          type: string
          x-stream-index: "007"
        service:
          title: The service that generated the closed caption. By default stream
          type: string
          x-stream-index: "008"
        speaker_id:
          title: The speaker ID of the closed caption.
          type: string
          x-stream-index: "005"
        start_time:
          format: date-time
          title: The start time of the closed caption.
          type: number
          x-stream-index: "003"
        text:
          title: The text of the closed caption.
          type: string
          x-stream-index: "002"
        translated:
          title: Whether the closed caption is translated.
          type: boolean
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          title: The user who spoke the closed caption.
          x-stream-index: "006"
      required:
      - id
      - text
      - start_time
      - end_time
      - speaker_id
      - user
      - language
      - translated
      title: CallClosedCaption
      type: object
    CallClosedCaptionsFailedEvent:
      description: This event is sent when call closed captions has failed
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.closed_captions_failed
          description: 'The type of event: "call.closed_captions_failed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      title: CallClosedCaptionsFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallClosedCaptionsStartedEvent:
      description: This event is sent when call closed caption has started
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.closed_captions_started
          description: 'The type of event: "call.closed_captions_started" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      title: CallClosedCaptionsStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallClosedCaptionsStoppedEvent:
      description: This event is sent when call closed captions has stopped
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.closed_captions_stopped
          description: 'The type of event: "call.transcription_stopped" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      title: CallClosedCaptionsStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallCreatedEvent:
      description: |-
        This event is sent when a call is created. Clients receiving this event should check if the ringing
        field is set to true and if so, show the call screen
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: the members added to this call
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "004"
        type:
          default: call.created
          description: 'The type of event: "call.created" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - members
      title: CallCreatedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallDeletedEvent:
      description: This event is sent when a call is deleted. Clients receiving this
        event should leave the call screen
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.deleted
          description: 'The type of event: "call.deleted" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      title: CallDeletedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallDurationReport:
      properties:
        histogram:
          items:
            $ref: '#/components/schemas/ReportByHistogramBucket'
          type: array
          x-stream-index: "001"
      required:
      - histogram
      type: object
    CallDurationReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    CallEndedEvent:
      description: This event is sent when a call is mark as ended for all its participants.
        Clients receiving this event should leave the call screen
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        reason:
          description: The reason why the call ended, if available
          title: CallEndedReason
          type: string
          x-stream-index: "005"
        type:
          default: call.ended
          description: 'The type of event: "call.ended" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who ended the call, null if the call was ended by
            the server
          title: User
          x-stream-index: "004"
      required:
      - type
      - created_at
      - call_cid
      - call
      title: CallEndedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallFrameRecordingFailedEvent:
      description: This event is sent when frame recording has failed
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "004"
        type:
          default: call.frame_recording_failed
          description: 'The type of event: "call.frame_recording_failed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - egress_id
      title: CallFrameRecordingFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallFrameRecordingFrameReadyEvent:
      description: This event is sent when a frame is captured from a call
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        captured_at:
          description: The time the frame was captured
          format: date-time
          title: CapturedAt
          type: number
          x-stream-index: "006"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "008"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        track_type:
          description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)
          title: TrackType
          type: string
          x-stream-index: "004"
        type:
          default: call.frame_recording_ready
          description: 'The type of event: "call.frame_recording_ready" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        url:
          description: The URL of the frame
          title: URL
          type: string
          x-stream-index: "005"
        users:
          additionalProperties:
            $ref: '#/components/schemas/UserResponse'
          description: The users in the frame
          title: Users
          type: object
          x-stream-index: "007"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - track_type
      - url
      - captured_at
      - users
      - egress_id
      title: CallFrameRecordingFrameReadyEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallFrameRecordingStartedEvent:
      description: This event is sent when frame recording has started
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "004"
        type:
          default: call.frame_recording_started
          description: 'The type of event: "call.frame_recording_started" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - egress_id
      title: CallFrameRecordingStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallFrameRecordingStoppedEvent:
      description: This event is sent when frame recording has stopped
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "004"
        type:
          default: call.frame_recording_stopped
          description: 'The type of event: "call.frame_recording_stopped" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - egress_id
      title: CallFrameRecordingStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallHLSBroadcastingFailedEvent:
      description: This event is sent when HLS broadcasting has failed
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.hls_broadcasting_failed
          description: 'The type of event: "call.hls_broadcasting_failed" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      title: CallHLSBroadcastingFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallHLSBroadcastingStartedEvent:
      description: This event is sent when HLS broadcasting has started
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        hls_playlist_url:
          type: string
          x-stream-index: "004"
        type:
          default: call.hls_broadcasting_started
          description: 'The type of event: "call.hls_broadcasting_started" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - hls_playlist_url
      title: CallHLSBroadcastingStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallHLSBroadcastingStoppedEvent:
      description: This event is sent when HLS broadcasting has stopped
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.hls_broadcasting_stopped
          description: 'The type of event: "call.hls_broadcasting_stopped" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      title: CallHLSBroadcastingStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallIngressResponse:
      description: CallIngressResponse is the payload for ingress settings
      properties:
        rtmp:
          $ref: '#/components/schemas/RTMPIngress'
          title: RTMP
          x-stream-index: "001"
        srt:
          $ref: '#/components/schemas/SRTIngress'
          x-stream-index: "003"
        whip:
          $ref: '#/components/schemas/WHIPIngress'
          title: WHIP
          x-stream-index: "002"
      required:
      - rtmp
      - whip
      - srt
      title: CallIngressResponse
      type: object
    CallLiveStartedEvent:
      description: This event is sent when a call is started. Clients receiving this
        event should start the call.
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.live_started
          description: 'The type of event: "call.live_started" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      title: CallLiveStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallMemberAddedEvent:
      description: This event is sent when one or more members are added to a call
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: the members added to this call
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "004"
        type:
          default: call.member_added
          description: 'The type of event: "call.member_added" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - members
      title: CallMemberAddedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallMemberRemovedEvent:
      description: This event is sent when one or more members are removed from a
        call
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: the list of member IDs removed from the call
          items:
            type: string
          title: Members
          type: array
          x-stream-index: "004"
        type:
          default: call.member_removed
          description: 'The type of event: "call.member_removed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - members
      title: CallMemberRemovedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallMemberUpdatedEvent:
      description: This event is sent when one or more members are updated
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: The list of members that were updated
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "004"
        type:
          default: call.member_updated
          description: 'The type of event: "call.member_updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - members
      title: CallMemberUpdatedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallMemberUpdatedPermissionEvent:
      description: This event is sent when one or more members get its role updated
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        capabilities_by_role:
          additionalProperties:
            items:
              type: string
            type: array
          description: The capabilities by role for this call
          title: CapabilitiesByRole
          type: object
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: The list of members that were updated
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "005"
        type:
          default: call.member_updated_permission
          description: 'The type of event: "call.member_added" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - capabilities_by_role
      - members
      title: CallMemberUpdatedPermissionEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallMissedEvent:
      description: This event is sent to call members who did not accept/reject/join
        the call to notify they missed the call
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "004"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: List of members who missed the call
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "005"
        notify_user:
          type: boolean
          x-stream-index: "007"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.missed
          description: 'The type of event: "call.notification" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The caller from whom the call was missed
          title: User
          x-stream-index: "006"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - call
      - members
      - user
      - notify_user
      title: CallMissedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: ring
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallModerationBlurEvent:
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        type:
          default: call.moderation_blur
          type: string
          x-stream-index: "001.001"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user_id
      - custom
      title: CallModerationBlurEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallModerationWarningEvent:
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        message:
          type: string
          x-stream-index: "004"
        type:
          default: call.moderation_warning
          type: string
          x-stream-index: "001.001"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user_id
      - message
      - custom
      title: CallModerationWarningEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallNotificationEvent:
      description: This event is sent to all call members to notify they are getting
        called
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "004"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: Call members
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "005"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.notification
          description: 'The type of event: "call.notification" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that sent the call notification
          title: User
          x-stream-index: "006"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - call
      - members
      - user
      title: CallNotificationEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: ring
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallParticipantCountReport:
      properties:
        histogram:
          items:
            $ref: '#/components/schemas/ReportByHistogramBucket'
          type: array
          x-stream-index: "001"
      required:
      - histogram
      type: object
    CallParticipantCountReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    CallParticipantResponse:
      properties:
        joined_at:
          format: date-time
          type: number
          x-stream-index: "004"
        role:
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
        user_session_id:
          type: string
          x-stream-index: "002"
      required:
      - user
      - user_session_id
      - role
      - joined_at
      type: object
    CallParticipantTimeline:
      properties:
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        severity:
          type: string
          x-stream-index: "003"
        timestamp:
          format: date-time
          type: number
          x-stream-index: "001"
        type:
          type: string
          x-stream-index: "002"
      required:
      - timestamp
      - type
      - severity
      - data
      type: object
    CallReactionEvent:
      description: This event is sent when a reaction is sent in a call, clients should
        use this to show the reaction in the call screen
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        reaction:
          $ref: '#/components/schemas/ReactionResponse'
          description: the reaction object sent by the user on the call
          title: reaction
          x-stream-index: "003"
        type:
          default: call.reaction_new
          description: 'The type of event: "call.reaction_new" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - reaction
      title: CallReactionEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRecording:
      description: CallRecording represents a recording of a call.
      properties:
        end_time:
          format: date-time
          title: The end time of the recording.
          type: number
          x-stream-index: "004"
        filename:
          title: The filename of the recording.
          type: string
          x-stream-index: "001"
        session_id:
          title: The session ID of the recording.
          type: string
          x-stream-index: "005"
        start_time:
          format: date-time
          title: The start time of the recording.
          type: number
          x-stream-index: "003"
        url:
          title: The URL of the recording.
          type: string
          x-stream-index: "002"
      required:
      - filename
      - url
      - start_time
      - end_time
      - session_id
      title: CallRecording
      type: object
    CallRecordingFailedEvent:
      description: This event is sent when call recording has failed
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "003"
        type:
          default: call.recording_failed
          description: 'The type of event: "call.recording_failed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - egress_id
      title: CallRecordingFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRecordingReadyEvent:
      description: This event is sent when call recording is ready
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        call_recording:
          $ref: '#/components/schemas/CallRecording'
          description: The call recording object
          title: CallRecording
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "004"
        type:
          default: call.recording_ready
          description: 'The type of event: "call.recording_ready" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call_recording
      - egress_id
      title: CallRecordingReadyEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRecordingStartedEvent:
      description: This event is sent when call recording has started
      properties:
        call_cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        egress_id:
          type: string
          x-stream-index: "001"
        type:
          default: call.recording_started
          description: 'The type of event: "call.recording_started" in this case'
          title: Event Type
          type: string
          x-stream-index: "002.001"
      required:
      - egress_id
      - type
      - created_at
      - call_cid
      title: CallRecordingStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRecordingStoppedEvent:
      description: This event is sent when call recording has stopped
      properties:
        call_cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        egress_id:
          type: string
          x-stream-index: "001"
        type:
          default: call.recording_stopped
          description: 'The type of event: "call.recording_stopped" in this case'
          title: Event Type
          type: string
          x-stream-index: "002.001"
      required:
      - egress_id
      - type
      - created_at
      - call_cid
      title: CallRecordingStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: recording
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRejectedEvent:
      description: This event is sent when a user rejects a notification to join a
        call.
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        reason:
          description: 'Provides information about why the call was rejected. You
            can provide any value, but the Stream API and SDKs use these default values:
            rejected, cancel, timeout and busy'
          title: Reason
          type: string
          x-stream-index: "005"
        type:
          default: call.rejected
          description: 'The type of event: "call.rejected" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who rejected the call
          title: User
          x-stream-index: "004"
      required:
      - type
      - created_at
      - call_cid
      - call
      - user
      title: CallRejectedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: ring
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallReportResponse:
      properties:
        ended_at:
          format: date-time
          type: number
          x-stream-index: "003"
        score:
          format: float
          type: number
          x-stream-index: "001"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002"
      required:
      - score
      type: object
    CallRequest:
      description: CallRequest is the payload for creating a call.
      properties:
        channel_cid:
          type: string
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/UserRequest'
          title: The user that create this call
          x-stream-index: "002"
        created_by_id:
          title: The id of the user that create this call
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        members:
          items:
            $ref: '#/components/schemas/MemberRequest'
          maximum: 100
          type: array
          x-stream-index: "005"
        settings_override:
          $ref: '#/components/schemas/CallSettingsRequest'
          x-stream-index: "006"
        starts_at:
          format: date-time
          type: number
          x-stream-index: "007"
        team:
          type: string
          x-stream-index: "001"
        video:
          type: boolean
          x-stream-index: "008"
      title: CallRequest
      type: object
    CallResponse:
      description: Represents a call
      properties:
        backstage:
          type: boolean
          x-stream-index: "017"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "019"
        captioning:
          type: boolean
          x-stream-index: "013"
        channel_cid:
          type: string
          x-stream-index: "025"
        cid:
          description: The unique identifier for a call (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: The user that created the call
          title: Created By
          x-stream-index: "007"
        current_session_id:
          type: string
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        egress:
          $ref: '#/components/schemas/EgressResponse'
          x-stream-index: "022"
        ended_at:
          description: Date/time when the call ended
          format: date-time
          title: Ended At
          type: number
          x-stream-index: "015"
        id:
          description: Call ID
          title: ID
          type: string
          x-stream-index: "003"
        ingress:
          $ref: '#/components/schemas/CallIngressResponse'
          x-stream-index: "020"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "024"
        recording:
          type: boolean
          x-stream-index: "011"
        session:
          $ref: '#/components/schemas/CallSessionResponse'
          x-stream-index: "021"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          x-stream-index: "018"
        starts_at:
          description: Date/time when the call will start
          format: date-time
          title: Starts At
          type: number
          x-stream-index: "016"
        team:
          type: string
          x-stream-index: "006"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailResponse'
          x-stream-index: "023"
        transcribing:
          type: boolean
          x-stream-index: "012"
        translating:
          type: boolean
          x-stream-index: "014"
        type:
          description: The type of call
          title: Type
          type: string
          x-stream-index: "002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "010"
      required:
      - type
      - id
      - cid
      - current_session_id
      - created_by
      - custom
      - created_at
      - updated_at
      - recording
      - transcribing
      - captioning
      - translating
      - backstage
      - settings
      - blocked_user_ids
      - ingress
      - egress
      title: CallResponse
      type: object
    CallRingEvent:
      description: This event is sent to all call members to notify they are getting
        called
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "005"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        members:
          description: Call members
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "006"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.ring
          description: 'The type of event: "call.notification" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that sent the call notification
          title: User
          x-stream-index: "007"
        video:
          type: boolean
          x-stream-index: "008"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - call
      - members
      - user
      - video
      title: CallRingEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: ring
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRtmpBroadcastFailedEvent:
      description: This event is sent when a call RTMP broadcast has failed
      properties:
        call_cid:
          description: The unique identifier for a call (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "002.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.002"
        name:
          description: Name of the given RTMP broadcast
          title: Name
          type: string
          x-stream-index: "003"
        type:
          default: call.rtmp_broadcast_failed
          description: 'The type of event: "call.rtmp_broadcast_failed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - name
      title: CallRtmpBroadcastFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRtmpBroadcastStartedEvent:
      description: This event is sent when RTMP broadcast has started
      properties:
        call_cid:
          description: The unique identifier for a call (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "002.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.002"
        name:
          description: Name of the given RTMP broadcast
          title: Name
          type: string
          x-stream-index: "003"
        type:
          default: call.rtmp_broadcast_started
          description: 'The type of event: "call.rtmp_broadcast_started" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - name
      title: CallRtmpBroadcastStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallRtmpBroadcastStoppedEvent:
      description: This event is sent when RTMP broadcast has stopped
      properties:
        call_cid:
          description: The unique identifier for a call (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "002.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.002"
        name:
          description: Name of the given RTMP broadcast
          title: Name
          type: string
          x-stream-index: "003"
        type:
          default: call.rtmp_broadcast_stopped
          description: 'The type of event: "call.rtmp_broadcast_stopped" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - name
      title: CallRtmpBroadcastStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: streaming
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSessionEndedEvent:
      description: This event is sent when a call session ends
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "004"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.session_ended
          description: 'The type of event: "call.session_ended" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - call
      title: CallSessionEndedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: session
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSessionParticipantCountsUpdatedEvent:
      description: This event is sent when the participant counts in a call session
        are updated
      properties:
        anonymous_participant_count:
          format: int32
          type: integer
          x-stream-index: "005"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        participants_count_by_role:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "004"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.session_participant_count_updated
          description: 'The type of event: "call.session_participant_count_updated"
            in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - participants_count_by_role
      - anonymous_participant_count
      title: CallSessionParticipantCountsUpdatedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: session
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSessionParticipantJoinedEvent:
      description: This event is sent when a participant joins a call session
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        participant:
          $ref: '#/components/schemas/CallParticipantResponse'
          description: The participant that joined the session
          title: Participant
          x-stream-index: "004"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.session_participant_joined
          description: 'The type of event: "call.session_participant_joined" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - participant
      title: CallSessionParticipantJoinedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: session
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSessionParticipantLeftEvent:
      description: This event is sent when a participant leaves a call session
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        duration_seconds:
          description: The duration participant was in the session in seconds
          format: int32
          title: Duration
          type: integer
          x-stream-index: "005"
        participant:
          $ref: '#/components/schemas/CallParticipantResponse'
          description: The participant that left the session
          title: Participant
          x-stream-index: "004"
        reason:
          description: The reason why the participant left the session
          title: Reason
          type: string
          x-stream-index: "006"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.session_participant_left
          description: 'The type of event: "call.session_participant_left" in this
            case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - participant
      - duration_seconds
      title: CallSessionParticipantLeftEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: session
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSessionResponse:
      properties:
        accepted_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "008"
        anonymous_participant_count:
          format: int32
          type: integer
          x-stream-index: "006"
        ended_at:
          format: date-time
          type: number
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        live_ended_at:
          format: date-time
          type: number
          x-stream-index: "011"
        live_started_at:
          format: date-time
          type: number
          x-stream-index: "010"
        missed_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "009"
        participants:
          items:
            $ref: '#/components/schemas/CallParticipantResponse'
          type: array
          x-stream-index: "004"
        participants_count_by_role:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "005"
        rejected_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "007"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002"
        timer_ends_at:
          format: date-time
          type: number
          x-stream-index: "012"
      required:
      - id
      - participants
      - participants_count_by_role
      - anonymous_participant_count
      - rejected_by
      - accepted_by
      - missed_by
      type: object
    CallSessionStartedEvent:
      description: This event is sent when a call session starts
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "004"
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.session_started
          description: 'The type of event: "call.session_started" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - call
      title: CallSessionStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: session
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallSettings:
      properties:
        audio:
          $ref: '#/components/schemas/AudioSettings'
          x-stream-index: "001"
        backstage:
          $ref: '#/components/schemas/BackstageSettings'
          x-stream-index: "002"
        broadcasting:
          $ref: '#/components/schemas/BroadcastSettings'
          x-stream-index: "007"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordSettings'
          x-stream-index: "006"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettings'
          x-stream-index: "008"
        ingress:
          $ref: '#/components/schemas/IngressSettings'
          x-stream-index: "014"
        limits:
          $ref: '#/components/schemas/LimitsSettings'
          x-stream-index: "012"
        recording:
          $ref: '#/components/schemas/RecordSettings'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettings'
          x-stream-index: "010"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettings'
          x-stream-index: "004"
        session:
          $ref: '#/components/schemas/SessionSettings'
          x-stream-index: "013"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettings'
          x-stream-index: "011"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettings'
          x-stream-index: "009"
        video:
          $ref: '#/components/schemas/VideoSettings'
          x-stream-index: "003"
      type: object
    CallSettingsRequest:
      properties:
        audio:
          $ref: '#/components/schemas/AudioSettingsRequest'
          x-stream-index: "001"
        backstage:
          $ref: '#/components/schemas/BackstageSettingsRequest'
          x-stream-index: "002"
        broadcasting:
          $ref: '#/components/schemas/BroadcastSettingsRequest'
          x-stream-index: "010"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingSettingsRequest'
          x-stream-index: "006"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettingsRequest'
          x-stream-index: "003"
        ingress:
          $ref: '#/components/schemas/IngressSettingsRequest'
          x-stream-index: "014"
        limits:
          $ref: '#/components/schemas/LimitsSettingsRequest'
          x-stream-index: "012"
        recording:
          $ref: '#/components/schemas/RecordSettingsRequest'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettingsRequest'
          x-stream-index: "007"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettingsRequest'
          x-stream-index: "008"
        session:
          $ref: '#/components/schemas/SessionSettingsRequest'
          x-stream-index: "013"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettingsRequest'
          x-stream-index: "011"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettingsRequest'
          x-stream-index: "009"
        video:
          $ref: '#/components/schemas/VideoSettingsRequest'
          x-stream-index: "004"
      type: object
    CallSettingsResponse:
      properties:
        audio:
          $ref: '#/components/schemas/AudioSettingsResponse'
          x-stream-index: "001"
        backstage:
          $ref: '#/components/schemas/BackstageSettingsResponse'
          x-stream-index: "002"
        broadcasting:
          $ref: '#/components/schemas/BroadcastSettingsResponse'
          x-stream-index: "003"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingSettingsResponse'
          x-stream-index: "006"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettingsResponse'
          x-stream-index: "004"
        ingress:
          $ref: '#/components/schemas/IngressSettingsResponse'
          x-stream-index: "014"
        limits:
          $ref: '#/components/schemas/LimitsSettingsResponse'
          x-stream-index: "012"
        recording:
          $ref: '#/components/schemas/RecordSettingsResponse'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettingsResponse'
          x-stream-index: "007"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettingsResponse'
          x-stream-index: "008"
        session:
          $ref: '#/components/schemas/SessionSettingsResponse'
          x-stream-index: "013"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettingsResponse'
          x-stream-index: "011"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettingsResponse'
          x-stream-index: "009"
        video:
          $ref: '#/components/schemas/VideoSettingsResponse'
          x-stream-index: "010"
      required:
      - audio
      - backstage
      - broadcasting
      - geofencing
      - recording
      - frame_recording
      - ring
      - screensharing
      - transcription
      - video
      - thumbnails
      - limits
      - session
      type: object
    CallStateResponseFields:
      description: CallStateResponseFields is the payload for call state response
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001"
        members:
          description: List of call members
          items:
            $ref: '#/components/schemas/MemberResponse'
          title: Members
          type: array
          x-stream-index: "002"
        own_capabilities:
          items:
            $ref: '#/components/schemas/OwnCapability'
          type: array
          x-stream-index: "004"
      required:
      - call
      - members
      - own_capabilities
      - blocked_users
      title: CallStateResponseFields
      type: object
    CallStatsParticipant:
      properties:
        latest_activity_at:
          format: date-time
          type: number
          x-stream-index: "005"
        name:
          type: string
          x-stream-index: "002"
        roles:
          items:
            type: string
          type: array
          x-stream-index: "003"
        sessions:
          items:
            $ref: '#/components/schemas/CallStatsParticipantSession'
          type: array
          x-stream-index: "004"
        user_id:
          type: string
          x-stream-index: "001"
      required:
      - user_id
      - sessions
      type: object
    CallStatsParticipantCounts:
      properties:
        live_sessions:
          format: int32
          type: integer
          x-stream-index: "003"
        participants:
          format: int32
          type: integer
          x-stream-index: "001"
        publishers:
          format: int32
          type: integer
          x-stream-index: "004"
        sessions:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - participants
      - sessions
      - live_sessions
      - publishers
      type: object
    CallStatsParticipantSession:
      properties:
        cq_score:
          format: int32
          type: integer
          x-stream-index: "008"
        ended_at:
          format: date-time
          type: number
          x-stream-index: "004"
        is_live:
          type: boolean
          x-stream-index: "005"
        published_tracks:
          $ref: '#/components/schemas/PublishedTrackFlags'
          x-stream-index: "007"
        publisher_type:
          type: string
          x-stream-index: "006"
        started_at:
          format: date-time
          type: number
          x-stream-index: "003"
        unified_session_id:
          type: string
          x-stream-index: "002"
        user_session_id:
          type: string
          x-stream-index: "001"
      required:
      - user_session_id
      - is_live
      - published_tracks
      type: object
    CallStatsReportReadyEvent:
      description: This event is sent when the insights report is ready
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.stats_report_ready
          description: The type of event, "call.report_ready" in this case
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      title: CallStatsReportReadyEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallStatsReportSummaryResponse:
      properties:
        call_cid:
          type: string
          x-stream-index: "001"
        call_duration_seconds:
          format: int32
          type: integer
          x-stream-index: "008"
        call_session_id:
          type: string
          x-stream-index: "002"
        call_status:
          type: string
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "007"
        first_stats_time:
          format: date-time
          type: number
          x-stream-index: "003"
        min_user_rating:
          format: int32
          type: integer
          x-stream-index: "006"
        quality_score:
          format: int32
          type: integer
          x-stream-index: "005"
      required:
      - call_cid
      - call_session_id
      - first_stats_time
      - call_status
      - call_duration_seconds
      type: object
    CallTranscription:
      description: CallTranscription represents a transcription of a call.
      properties:
        end_time:
          format: date-time
          title: The end time of the transcription.
          type: number
          x-stream-index: "004"
        filename:
          title: The filename of the transcription.
          type: string
          x-stream-index: "001"
        session_id:
          title: The session ID of the transcription.
          type: string
          x-stream-index: "005"
        start_time:
          format: date-time
          title: The start time of the transcription.
          type: number
          x-stream-index: "003"
        url:
          title: The URL of the transcription.
          type: string
          x-stream-index: "002"
      required:
      - filename
      - url
      - start_time
      - end_time
      - session_id
      title: CallTranscription
      type: object
    CallTranscriptionFailedEvent:
      description: This event is sent when call transcription has failed
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "003"
        error:
          description: The error message detailing why transcription failed.
          title: string
          type: string
          x-stream-index: "004"
        type:
          default: call.transcription_failed
          description: 'The type of event: "call.transcription_failed" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - egress_id
      title: CallTranscriptionFailedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallTranscriptionReadyEvent:
      description: This event is sent when call transcription is ready
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        call_transcription:
          $ref: '#/components/schemas/CallTranscription'
          description: The call transcription object
          title: CallTranscription
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "004"
        type:
          default: call.transcription_ready
          description: 'The type of event: "call.transcription_ready" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call_transcription
      - egress_id
      title: CallTranscriptionReadyEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallTranscriptionStartedEvent:
      description: This event is sent when call transcription has started
      properties:
        call_cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        egress_id:
          type: string
          x-stream-index: "001"
        type:
          default: call.transcription_started
          description: 'The type of event: "call.transcription_started" in this case'
          title: Event Type
          type: string
          x-stream-index: "002.001"
      required:
      - egress_id
      - type
      - created_at
      - call_cid
      title: CallTranscriptionStartedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallTranscriptionStoppedEvent:
      description: This event is sent when call transcription has stopped
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        egress_id:
          type: string
          x-stream-index: "003"
        type:
          default: call.transcription_stopped
          description: 'The type of event: "call.transcription_stopped" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - egress_id
      title: CallTranscriptionStoppedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallType:
      nullable: true
      properties:
        AppPK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "003"
        CreatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "005"
        ExternalStorage:
          type: string
          writeOnly: true
          x-stream-index: "009"
        Name:
          type: string
          writeOnly: true
          x-stream-index: "004"
        NotificationSettings:
          $ref: '#/components/schemas/NotificationSettings'
          x-stream-index: "008"
        PK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "002"
        Settings:
          $ref: '#/components/schemas/CallSettings'
          x-stream-index: "007"
        UpdatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "006"
      required:
      - PK
      - AppPK
      - Name
      - CreatedAt
      - UpdatedAt
      - ExternalStorage
      type: object
    CallTypeResponse:
      description: CallTypeResponse is the payload for a call type.
      properties:
        created_at:
          description: the time the call type was created
          format: date-time
          title: CreatedAt
          type: number
          x-stream-index: "005"
        external_storage:
          description: the external storage for the call type
          title: ExternalStorage
          type: string
          x-stream-index: "007"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          description: the permissions granted to each role
          title: Grants
          type: object
          x-stream-index: "002"
        name:
          description: the name of the call type
          title: Name
          type: string
          x-stream-index: "001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          description: the notification settings for the call type
          title: NotificationSettings
          x-stream-index: "004"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          description: the settings for the call type
          title: Settings
          x-stream-index: "003"
        updated_at:
          description: the time the call type was last updated
          format: date-time
          title: UpdatedAt
          type: number
          x-stream-index: "006"
      required:
      - name
      - grants
      - settings
      - notification_settings
      - created_at
      - updated_at
      title: CallTypeResponse
      type: object
    CallUpdatedEvent:
      description: |-
        This event is sent when a call is updated, clients should use this update the local state of the call.
        This event also contains the capabilities by role for the call, clients should update the own_capability for the current.
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: Call object
          title: Call
          x-stream-index: "003"
        call_cid:
          type: string
          x-stream-index: "002.001"
        capabilities_by_role:
          additionalProperties:
            items:
              type: string
            type: array
          description: The capabilities by role for this call
          title: CapabilitiesByRole
          type: object
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.updated
          description: 'The type of event: "call.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - call
      - capabilities_by_role
      title: CallUpdatedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallUserFeedbackSubmittedEvent:
      description: This event is sent when a user submits feedback for a call.
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        custom:
          additionalProperties: {}
          description: Custom data provided by the user
          title: Custom
          type: object
          x-stream-index: "007"
        rating:
          description: The rating given by the user (1-5)
          format: int32
          title: Rating
          type: integer
          x-stream-index: "005"
        reason:
          description: The reason provided by the user for the rating
          title: Reason
          type: string
          x-stream-index: "006"
        sdk:
          type: string
          x-stream-index: "008"
        sdk_version:
          type: string
          x-stream-index: "009"
        session_id:
          description: Call session ID
          title: Session ID
          type: string
          x-stream-index: "003.001"
        type:
          default: call.user_feedback_submitted
          description: The type of event, "call.user_feedback" in this case
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who submitted the feedback
          title: User
          x-stream-index: "004"
      required:
      - type
      - created_at
      - call_cid
      - session_id
      - user
      - rating
      title: CallUserFeedbackSubmittedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallUserMutedEvent:
      description: This event is sent when a call member is muted
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        from_user_id:
          type: string
          x-stream-index: "003"
        muted_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "004"
        reason:
          type: string
          x-stream-index: "005"
        type:
          default: call.user_muted
          description: 'The type of event: "call.user_muted" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - from_user_id
      - muted_user_ids
      - reason
      title: CallUserMutedEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CallsPerDayReport:
      properties:
        count:
          format: int64
          type: integer
          x-stream-index: "001"
      required:
      - count
      type: object
    CallsPerDayReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    Channel:
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocation'
          type: array
          x-stream-index: "035"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "030"
        auto_translation_language:
          type: string
          x-stream-index: "031"
        cid:
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/ChannelConfig'
          x-stream-index: "027"
        config_overrides:
          $ref: '#/components/schemas/ConfigOverrides'
          x-stream-index: "028"
        cooldown:
          format: int32
          type: integer
          x-stream-index: "032"
        created_at:
          format: date-time
          type: number
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "019"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "011"
        disabled:
          type: boolean
          x-stream-index: "017"
        frozen:
          type: boolean
          x-stream-index: "016"
        id:
          type: string
          x-stream-index: "004"
        invites:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "023"
        last_campaigns:
          type: string
          x-stream-index: "033"
        last_message_at:
          format: date-time
          type: number
          x-stream-index: "006"
        member_count:
          format: int32
          type: integer
          x-stream-index: "021"
        members:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "020"
        members_lookup:
          additionalProperties:
            $ref: '#/components/schemas/ChannelMemberLookup'
          type: object
          x-stream-index: "022"
        message_count:
          format: int64
          type: integer
          x-stream-index: "036"
        message_count_updated_at:
          format: date-time
          type: number
          x-stream-index: "037"
        team:
          type: string
          x-stream-index: "029"
        truncated_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "015"
        type:
          type: string
          x-stream-index: "005"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "010"
      required:
      - cid
      - id
      - type
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      - auto_translation_language
      type: object
    ChannelConfig:
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: "001.027"
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: "001.022"
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: "001.023"
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: "001.028"
        blocklist:
          type: string
          x-stream-index: "001.024"
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: "001.025"
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: "001.026"
        commands:
          items:
            type: string
          type: array
          x-stream-index: "003"
        connect_events:
          type: boolean
          x-stream-index: "001.004"
        count_messages:
          type: boolean
          x-stream-index: "001.019"
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        custom_events:
          type: boolean
          x-stream-index: "001.012"
        mark_messages_pending:
          type: boolean
          x-stream-index: "001.015"
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: "001.021"
        mutes:
          type: boolean
          x-stream-index: "001.009"
        name:
          type: string
          x-stream-index: "001.001"
        partition_size:
          format: int32
          type: integer
          x-stream-index: "001.029"
        partition_ttl:
          type: integer
          x-stream-index: "001.030"
        polls:
          type: boolean
          x-stream-index: "001.016"
        push_notifications:
          type: boolean
          x-stream-index: "001.013"
        quotes:
          type: boolean
          x-stream-index: "001.008"
        reactions:
          type: boolean
          x-stream-index: "001.006"
        read_events:
          type: boolean
          x-stream-index: "001.003"
        reminders:
          type: boolean
          x-stream-index: "001.014"
        replies:
          type: boolean
          x-stream-index: "001.007"
        search:
          type: boolean
          x-stream-index: "001.005"
        shared_locations:
          type: boolean
          x-stream-index: "001.018"
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: "001.031"
        typing_events:
          type: boolean
          x-stream-index: "001.002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "002.004"
        uploads:
          type: boolean
          x-stream-index: "001.010"
        url_enrichment:
          type: boolean
          x-stream-index: "001.011"
        user_message_reminders:
          type: boolean
          x-stream-index: "001.017"
      required:
      - name
      - typing_events
      - read_events
      - connect_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - count_messages
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - created_at
      - updated_at
      - commands
      type: object
    ChannelConfigWithInfo:
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: 001.002.027
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: 001.002.022
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.023
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: 001.002.028
        blocklist:
          type: string
          x-stream-index: 001.002.024
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.025
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: 001.002.026
        commands:
          items:
            $ref: '#/components/schemas/Command'
          type: array
          x-stream-index: "001.003"
        connect_events:
          type: boolean
          x-stream-index: 001.002.004
        count_messages:
          type: boolean
          x-stream-index: 001.002.019
        created_at:
          format: date-time
          type: number
          x-stream-index: 001.001.003
        custom_events:
          type: boolean
          x-stream-index: 001.002.012
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "002"
        mark_messages_pending:
          type: boolean
          x-stream-index: 001.002.015
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: 001.002.021
        mutes:
          type: boolean
          x-stream-index: 001.002.009
        name:
          type: string
          x-stream-index: 001.002.001
        partition_size:
          format: int32
          type: integer
          x-stream-index: 001.002.029
        partition_ttl:
          example: 24h
          format: duration
          nullable: true
          type: string
          x-stream-index: 001.002.030
        polls:
          type: boolean
          x-stream-index: 001.002.016
        push_notifications:
          type: boolean
          x-stream-index: 001.002.013
        quotes:
          type: boolean
          x-stream-index: 001.002.008
        reactions:
          type: boolean
          x-stream-index: 001.002.006
        read_events:
          type: boolean
          x-stream-index: 001.002.003
        reminders:
          type: boolean
          x-stream-index: 001.002.014
        replies:
          type: boolean
          x-stream-index: 001.002.007
        search:
          type: boolean
          x-stream-index: 001.002.005
        shared_locations:
          type: boolean
          x-stream-index: 001.002.018
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: 001.002.031
        typing_events:
          type: boolean
          x-stream-index: 001.002.002
        updated_at:
          format: date-time
          type: number
          x-stream-index: 001.001.004
        uploads:
          type: boolean
          x-stream-index: 001.002.010
        url_enrichment:
          type: boolean
          x-stream-index: 001.002.011
        user_message_reminders:
          type: boolean
          x-stream-index: 001.002.017
      required:
      - created_at
      - updated_at
      - name
      - typing_events
      - read_events
      - connect_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - count_messages
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - commands
      type: object
    ChannelMember:
      nullable: true
      properties:
        archived_at:
          format: date-time
          type: number
          x-stream-index: "015"
        ban_expires:
          description: Expiration date of the ban
          format: date-time
          title: Ban expires
          type: number
          x-stream-index: "013"
        banned:
          description: Whether member is banned this channel or not
          title: Banned
          type: boolean
          x-stream-index: "012"
        channel_role:
          description: Role of the member in the channel
          title: Channel Role
          type: string
          x-stream-index: "018"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "011"
        deleted_messages:
          items:
            type: string
          type: array
          x-stream-index: "020"
        invite_accepted_at:
          description: Date when invite was accepted
          format: date-time
          title: Invited accepted at
          type: number
          x-stream-index: "006"
        invite_rejected_at:
          description: Date when invite was rejected
          format: date-time
          title: Invited rejected at
          type: number
          x-stream-index: "007"
        invited:
          description: Whether member was invited or not
          title: Invited
          type: boolean
          x-stream-index: "005"
        is_moderator:
          description: Whether member is channel moderator or not
          title: Is moderator
          type: boolean
          x-stream-index: "003"
        notifications_muted:
          type: boolean
          x-stream-index: "019"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "016"
        role:
          description: 'Permission level of the member in the channel (DEPRECATED:
            use channel_role instead)'
          enum:
          - member
          - moderator
          - admin
          - owner
          title: Role
          type: string
          x-stream-index: "017"
        shadow_banned:
          description: Whether member is shadow banned in this channel or not
          title: Shadow banned
          type: boolean
          x-stream-index: "014"
        status:
          type: string
          x-stream-index: "008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        user_id:
          title: User ID
          type: string
          x-stream-index: "001"
      required:
      - custom
      - created_at
      - updated_at
      - banned
      - shadow_banned
      - channel_role
      - notifications_muted
      title: Channel member
      type: object
    ChannelMemberLookup:
      nullable: true
      properties:
        archived:
          type: boolean
          x-stream-index: "003"
        archived_at:
          format: date-time
          type: number
          x-stream-index: "007"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "008"
        banned:
          type: boolean
          x-stream-index: "004"
        blocked:
          type: boolean
          x-stream-index: "005"
        hidden:
          type: boolean
          x-stream-index: "001"
        pinned:
          type: boolean
          x-stream-index: "002"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "006"
      required:
      - hidden
      - pinned
      - archived
      - banned
      - blocked
      type: object
    ChannelMemberResponse:
      properties:
        channel_role:
          type: string
          x-stream-index: "001"
      required:
      - channel_role
      type: object
    ChannelMute:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel that is muted
          title: Channel
          x-stream-index: "002"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "004"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: number
          x-stream-index: "003"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Owner of channel mute
          title: User
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    ChannelOwnCapability:
      description: All possibility of string to use
      enum:
      - ban-channel-members
      - cast-poll-vote
      - connect-events
      - create-attachment
      - delete-any-message
      - delete-channel
      - delete-own-message
      - flag-message
      - freeze-channel
      - join-channel
      - leave-channel
      - mute-channel
      - pin-message
      - query-poll-votes
      - quote-message
      - read-events
      - search-messages
      - send-custom-events
      - send-links
      - send-message
      - send-poll
      - send-reaction
      - send-reply
      - send-restricted-visibility-message
      - send-typing-events
      - set-channel-cooldown
      - share-location
      - skip-slow-mode
      - slow-mode
      - typing-events
      - update-any-message
      - update-channel
      - update-channel-members
      - update-own-message
      - update-thread
      - upload-file
      title: ChannelOwnCapability
      type: string
    ChannelPushPreferences:
      nullable: true
      properties:
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: number
          x-stream-index: "002"
      type: object
    ChannelResponse:
      description: Represents channel in chat
      properties:
        auto_translation_enabled:
          description: Whether auto translation is enabled or not
          title: Auto translation
          type: boolean
          x-stream-index: "017"
        auto_translation_language:
          description: Language to translate to when auto translation is active
          title: Auto translation language
          type: string
          x-stream-index: "018"
        blocked:
          description: Whether this channel is blocked by current user or not
          title: Blocked
          type: boolean
          x-stream-index: "023"
        cid:
          description: Channel CID (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/ChannelConfigWithInfo'
          description: Channel configuration
          title: ChannelConfigWithInfo
          x-stream-index: "013"
        cooldown:
          description: Cooldown period after sending each message
          format: int32
          title: Cooldown
          type: integer
          x-stream-index: "020"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "005"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: Creator of the channel
          title: UserResponse
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "026"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "007"
        disabled:
          type: boolean
          x-stream-index: "010"
        frozen:
          description: Whether channel is frozen or not
          title: Frozen
          type: boolean
          x-stream-index: "009"
        hidden:
          description: Whether this channel is hidden by current user or not
          title: Hidden
          type: boolean
          x-stream-index: "022"
        hide_messages_before:
          description: Date since when the message history is accessible
          format: date-time
          title: Hide messages before
          type: number
          x-stream-index: "019"
        id:
          description: Channel unique ID
          title: ID
          type: string
          x-stream-index: "001"
        last_message_at:
          description: Date of the last message sent
          format: date-time
          title: Last message at
          type: number
          x-stream-index: "004"
        member_count:
          description: Number of members in the channel
          format: int32
          title: Member count
          type: integer
          x-stream-index: "012"
        members:
          description: List of channel members (max 100)
          items:
            $ref: '#/components/schemas/ChannelMember'
          title: ChannelMembers
          type: array
          x-stream-index: "011"
        message_count:
          description: Number of messages in the channel
          format: int64
          title: Message count
          type: integer
          x-stream-index: "027"
        mute_expires_at:
          description: Date of mute expiration
          format: date-time
          title: Mute expires at
          type: number
          x-stream-index: "015"
        muted:
          description: Whether this channel is muted or not
          title: Muted
          type: boolean
          x-stream-index: "014"
        own_capabilities:
          description: List of channel capabilities of authenticated user
          items:
            $ref: '#/components/schemas/ChannelOwnCapability'
          title: ChannelOwnCapability
          type: array
          x-stream-index: "021"
        team:
          description: Team the channel belongs to (multi-tenant only)
          title: Team
          type: string
          x-stream-index: "016"
        truncated_at:
          description: Date of the latest truncation of the channel
          format: date-time
          title: UserResponse
          type: number
          x-stream-index: "024"
        truncated_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "025"
        type:
          description: Type of the channel
          title: Type
          type: string
          x-stream-docs-page-id: channel_features
          x-stream-index: "002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "006"
      required:
      - id
      - type
      - cid
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      title: Channel
      type: object
    ChatActivityStatsResponse:
      properties:
        Messages:
          $ref: '#/components/schemas/MessageStatsResponse'
          x-stream-index: "001"
      type: object
    CheckExternalStorageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        file_url:
          type: string
          x-stream-index: "002"
      required:
      - duration
      - file_url
      title: Response
      type: object
    CheckPushRequest:
      description: Check push request
      nullable: true
      properties:
        apn_template:
          description: Push message template for APN
          title: APN template
          type: string
          x-stream-docs-page-id: push_template
          x-stream-index: "002"
        event_type:
          description: 'Type of event for push templates (default: message.new)'
          enum:
          - message.new
          - message.updated
          - reaction.new
          - reaction.updated
          - notification.reminder_due
          title: Event type
          type: string
          x-stream-index: "008"
        firebase_data_template:
          description: Push message data template for Firebase
          title: Firebase data template
          type: string
          x-stream-docs-page-id: push_template
          x-stream-index: "004"
        firebase_template:
          description: Push message template for Firebase
          title: Firebase template
          type: string
          x-stream-docs-page-id: push_template
          x-stream-index: "003"
        message_id:
          description: Message ID to send push notification for
          title: Message ID
          type: string
          x-stream-index: "001"
        push_provider_name:
          description: Name of push provider
          title: Name of push provider
          type: string
          x-stream-index: "007"
        push_provider_type:
          description: Push provider type
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          title: Type of push provider
          type: string
          x-stream-index: "006"
        skip_devices:
          description: Don't require existing devices to render templates
          title: Skip devices
          type: boolean
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "009.002"
        user_id:
          type: string
          x-stream-index: "009.001"
      title: CheckPushRequest
      type: object
    CheckPushResponse:
      nullable: true
      properties:
        device_errors:
          additionalProperties:
            $ref: '#/components/schemas/DeviceErrorInfo'
          description: Object with device errors
          title: Device errors
          type: object
          x-stream-index: "001"
          x-stream-map:
            key: device_id
        duration:
          type: string
          x-stream-index: "008.001"
        event_type:
          description: The event type that was tested
          title: Event type
          type: string
          x-stream-index: "004"
        general_errors:
          description: List of general errors
          items:
            type: string
          title: General errors
          type: array
          x-stream-index: "002"
        rendered_apn_template:
          title: Rendered APN template
          type: string
          x-stream-index: "005"
        rendered_firebase_template:
          title: Rendered Firebase template
          type: string
          x-stream-index: "006"
        rendered_message:
          additionalProperties:
            type: string
          title: Rendered message
          type: object
          x-stream-index: "007"
        skip_devices:
          description: Don't require existing devices to render templates
          title: Skip devices
          type: boolean
          x-stream-index: "003"
      required:
      - duration
      type: object
    CheckSNSRequest:
      nullable: true
      properties:
        sns_key:
          description: AWS SNS access key
          title: SNS key
          type: string
          x-stream-index: "002"
        sns_secret:
          description: AWS SNS key secret
          title: SNS secret
          type: string
          x-stream-index: "003"
        sns_topic_arn:
          description: AWS SNS topic ARN
          title: SNS Topic ARN
          type: string
          x-stream-index: "001"
      type: object
    CheckSNSResponse:
      nullable: true
      properties:
        data:
          additionalProperties: {}
          description: Error data
          title: ReadOnlyData
          type: object
          x-stream-index: "003"
        duration:
          type: string
          x-stream-index: "004.001"
        error:
          description: Error text
          title: Error
          type: string
          x-stream-index: "002"
        status:
          description: Validation result
          enum:
          - ok
          - error
          title: Status
          type: string
          x-stream-index: "001"
      required:
      - status
      - duration
      type: object
    CheckSQSRequest:
      nullable: true
      properties:
        sqs_key:
          description: AWS SQS access key
          title: SQS key
          type: string
          x-stream-index: "002"
        sqs_secret:
          description: AWS SQS key secret
          title: SQS secret
          type: string
          x-stream-index: "003"
        sqs_url:
          description: AWS SQS endpoint URL
          title: SQS URL
          type: string
          x-stream-index: "001"
      type: object
    CheckSQSResponse:
      nullable: true
      properties:
        data:
          additionalProperties: {}
          description: Error data
          title: ReadOnlyData
          type: object
          x-stream-index: "003"
        duration:
          type: string
          x-stream-index: "004.001"
        error:
          description: Error text
          title: Error
          type: string
          x-stream-index: "002"
        status:
          description: Validation result
          enum:
          - ok
          - error
          title: Status
          type: string
          x-stream-index: "001"
      required:
      - status
      - duration
      type: object
    ClientOSDataResponse:
      properties:
        architecture:
          type: string
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        version:
          type: string
          x-stream-index: "002"
      type: object
    ClosedCaptionEvent:
      description: This event is sent when closed captions are being sent in a call,
        clients should use this to show the closed captions in the call screen
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        closed_caption:
          $ref: '#/components/schemas/CallClosedCaption'
          description: The closed caption object
          title: CallClosedCaption
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.closed_caption
          description: 'The type of event: "call.closed_caption" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - call_cid
      - closed_caption
      title: ClosedCaptionEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: transcription
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    CollectUserFeedbackRequest:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "009"
        rating:
          format: int32
          maximum: 5
          minimum: 1
          type: integer
          x-stream-index: "007"
        reason:
          maxLength: 1000
          type: string
          x-stream-index: "008"
        sdk:
          maxLength: 50
          type: string
          x-stream-index: "005"
        sdk_version:
          maxLength: 50
          type: string
          x-stream-index: "006"
        user_session_id:
          maxLength: 50
          type: string
          x-stream-index: "004"
      required:
      - sdk
      - sdk_version
      - rating
      type: object
    CollectUserFeedbackResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    Command:
      description: Represents custom chat command
      nullable: true
      properties:
        args:
          description: Arguments help text, shown in commands auto-completion
          title: Arguments
          type: string
          x-stream-index: "006"
        created_at:
          description: Date/time of creation
          format: date-time
          readOnly: true
          title: Created at
          type: number
          x-stream-index: "001"
        description:
          description: Description, shown in commands auto-completion
          title: Description
          type: string
          x-stream-index: "005"
        name:
          description: Unique command name
          title: Name
          type: string
          x-stream-index: "004"
        set:
          description: Set name used for grouping commands
          title: Set
          type: string
          x-stream-index: "007"
        updated_at:
          description: Date/time of the last update
          format: date-time
          readOnly: true
          title: Updated at
          type: number
          x-stream-index: "002"
      required:
      - name
      - description
      - args
      - set
      title: Command
      type: object
    ConfigOverrides:
      properties:
        blocklist:
          type: string
          x-stream-index: "008"
        blocklist_behavior:
          enum:
          - flag
          - block
          type: string
          x-stream-index: "009"
        commands:
          items:
            type: string
          type: array
          x-stream-index: "011"
        count_messages:
          type: boolean
          x-stream-index: "014"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "010"
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: "007"
        quotes:
          type: boolean
          x-stream-index: "004"
        reactions:
          type: boolean
          x-stream-index: "002"
        replies:
          type: boolean
          x-stream-index: "003"
        shared_locations:
          type: boolean
          x-stream-index: "013"
        typing_events:
          type: boolean
          x-stream-index: "001"
        uploads:
          type: boolean
          x-stream-index: "005"
        url_enrichment:
          type: boolean
          x-stream-index: "006"
        user_message_reminders:
          type: boolean
          x-stream-index: "012"
      required:
      - grants
      - commands
      type: object
    CountByMinuteResponse:
      nullable: true
      properties:
        count:
          format: int32
          type: integer
          x-stream-index: "002"
        start_ts:
          format: date-time
          type: number
          x-stream-index: "001"
      required:
      - start_ts
      - count
      type: object
    CreateBlockListRequest:
      description: Block list contains restricted words
      nullable: true
      properties:
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "001"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "002"
        name:
          description: Block list name
          maxLength: 255
          title: Name
          type: string
          x-stream-index: "003"
        team:
          type: string
          x-stream-index: "006"
        type:
          description: Block list type.
          enum:
          - regex
          - domain
          - domain_allowlist
          - email
          - word
          title: Type
          type: string
          x-stream-index: "005"
        words:
          description: List of words to block
          items:
            type: string
          minimum: 1
          title: Words
          type: array
          x-stream-index: "004"
      required:
      - name
      - words
      title: Block list
      type: object
      x-stream-docs-page-id: block_lists
    CreateBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklist:
          $ref: '#/components/schemas/BlockListResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      title: Response
      type: object
    CreateCallTypeRequest:
      description: Request for creating a call type
      nullable: true
      properties:
        external_storage:
          description: the external storage for the call type
          title: ExternalStorage
          type: string
          x-stream-index: "002.004"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          description: the permissions granted to each role
          title: Grants
          type: object
          x-stream-index: "002.001"
        name:
          type: string
          x-stream-index: "001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          description: the notification settings for the call type
          title: NotificationSettings
          x-stream-index: "002.002"
        settings:
          $ref: '#/components/schemas/CallSettingsRequest'
          description: the settings for the call type
          title: Settings
          x-stream-index: "002.003"
      required:
      - name
      title: CreateCallTypeRequest
      type: object
    CreateCallTypeResponse:
      description: Response for creating a call type
      nullable: true
      properties:
        created_at:
          description: the time the call type was created
          format: date-time
          title: CreatedAt
          type: number
          x-stream-index: "001.005"
        duration:
          type: string
          x-stream-index: "002.001"
        external_storage:
          description: the external storage for the call type
          title: ExternalStorage
          type: string
          x-stream-index: "001.007"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          description: the permissions granted to each role
          title: Grants
          type: object
          x-stream-index: "001.002"
        name:
          description: the name of the call type
          title: Name
          type: string
          x-stream-index: "001.001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          description: the notification settings for the call type
          title: NotificationSettings
          x-stream-index: "001.004"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          description: the settings for the call type
          title: Settings
          x-stream-index: "001.003"
        updated_at:
          description: the time the call type was last updated
          format: date-time
          title: UpdatedAt
          type: number
          x-stream-index: "001.006"
      required:
      - name
      - grants
      - settings
      - notification_settings
      - created_at
      - updated_at
      - duration
      title: CreateCallTypeResponse
      type: object
    CreateDeviceRequest:
      description: Create device request
      nullable: true
      properties:
        id:
          description: Device ID
          maxLength: 255
          minLength: 1
          title: ID
          type: string
          x-stream-index: "001"
        push_provider:
          description: Push provider
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          title: PushProvider
          type: string
          x-stream-index: "002"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "005.002"
        user_id:
          description: '**Server-side only**. User ID which server acts upon'
          title: User ID
          type: string
          x-stream-index: "005.001"
        voip_token:
          description: When true the token is for Apple VoIP push notifications
          title: VoipToken
          type: boolean
          x-stream-index: "004"
      required:
      - id
      - push_provider
      title: CreateDeviceRequest
      type: object
    CreateExternalStorageRequest:
      description: Create external storage
      nullable: true
      properties:
        aws_s3:
          $ref: '#/components/schemas/S3Request'
          description: Only required if you want to create an Amazon S3 storage
          title: AwsS3
          x-stream-index: "003.004"
        azure_blob:
          $ref: '#/components/schemas/AzureRequest'
          description: Only required if you want to create an Azure Blob Storage
          title: AzureBlob
          x-stream-index: "003.006"
        bucket:
          description: The name of the bucket on the service provider
          title: Bucket
          type: string
          x-stream-index: "003.002"
        gcs_credentials:
          type: string
          x-stream-index: "003.005"
        name:
          description: The name of the provider, this must be unique
          title: Name
          type: string
          x-stream-index: "001"
        path:
          description: The path prefix to use for storing files
          title: Path
          type: string
          x-stream-index: "003.003"
        storage_type:
          description: The type of storage to use
          enum:
          - s3
          - gcs
          - abs
          title: StorageType
          type: string
          x-stream-index: "003.001"
      required:
      - name
      - storage_type
      - bucket
      title: CreateExternalStorageRequest
      type: object
    CreateExternalStorageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    CreateGuestRequest:
      nullable: true
      properties:
        user:
          $ref: '#/components/schemas/UserRequest'
          description: User object which server acts upon
          title: User
          x-stream-index: "001"
      required:
      - user
      type: object
    CreateGuestResponse:
      nullable: true
      properties:
        access_token:
          description: the access token to authenticate the user
          title: Access token
          type: string
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User object which server acts upon
          title: User
          x-stream-index: "001"
      required:
      - user
      - access_token
      - duration
      type: object
    CreateImportRequest:
      nullable: true
      properties:
        mode:
          enum:
          - insert
          - upsert
          type: string
          x-stream-index: "002"
        path:
          type: string
          x-stream-index: "001"
      required:
      - path
      - mode
      type: object
    CreateImportResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        import_task:
          $ref: '#/components/schemas/ImportTask'
          x-stream-index: "001"
      required:
      - duration
      title: Response
      type: object
    CreateImportURLRequest:
      nullable: true
      properties:
        filename:
          type: string
          x-stream-index: "001"
      type: object
    CreateImportURLResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        path:
          type: string
          x-stream-index: "001"
        upload_url:
          type: string
          x-stream-index: "002"
      required:
      - path
      - upload_url
      - duration
      title: Response
      type: object
    CreatePollOptionRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "003"
        text:
          description: Option text
          title: string
          type: string
          x-stream-index: "002"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "004.002"
        user_id:
          type: string
          x-stream-index: "004.001"
      required:
      - text
      type: object
    CreatePollRequest:
      description: Contains all information needed to create a new poll
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "011"
        allow_answers:
          description: Indicates whether users can suggest user defined answers
          title: Allow answers
          type: boolean
          x-stream-index: "009"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "008"
        description:
          description: A description of the poll
          title: Description
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          description: Indicates whether users can cast multiple votes
          title: Multiple choice
          type: boolean
          x-stream-index: "006"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        is_closed:
          description: Indicates whether the poll is open for voting
          title: Is closed
          type: boolean
          x-stream-index: "010"
        max_votes_allowed:
          description: Indicates the maximum amount of votes a user can cast
          format: int32
          maximum: 10
          title: Maximum votes allowed
          type: integer
          x-stream-index: "007"
        name:
          description: The name of the poll
          title: Name
          type: string
          x-stream-index: "002"
        options:
          items:
            $ref: '#/components/schemas/PollOptionInput'
          maximum: 100
          type: array
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "012.002"
        user_id:
          type: string
          x-stream-index: "012.001"
        voting_visibility:
          enum:
          - anonymous
          - public
          type: string
          x-stream-index: "005"
      required:
      - name
      title: Create Poll Request
      type: object
    CreateRoleRequest:
      nullable: true
      properties:
        name:
          description: Role name
          maxLength: 64
          title: Name
          type: string
          x-stream-index: "001"
      required:
      - name
      type: object
    CreateRoleResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        role:
          $ref: '#/components/schemas/Role'
          x-stream-index: "002"
      required:
      - duration
      - role
      title: Response
      type: object
    CustomVideoEvent:
      description: A custom event, this event is used to send custom events to other
        participants in the call.
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "003"
        type:
          default: custom
          description: The type of event, "custom" in this case
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "004"
      required:
      - type
      - created_at
      - call_cid
      - custom
      - user
      title: CustomVideoEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    DailyAggregateCallDurationReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/CallDurationReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DailyAggregateCallParticipantCountReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/CallParticipantCountReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DailyAggregateCallsPerDayReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/CallsPerDayReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DailyAggregateQualityScoreReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/QualityScoreReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DailyAggregateSDKUsageReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/SDKUsageReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DailyAggregateUserFeedbackReportResponse:
      properties:
        date:
          type: string
          x-stream-index: "001"
        report:
          $ref: '#/components/schemas/UserFeedbackReport'
          x-stream-index: "002"
      required:
      - date
      - report
      type: object
    DataDogInfo:
      properties:
        api_key:
          type: string
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "003"
        site:
          type: string
          x-stream-index: "002"
      type: object
    DeactivateUserRequest:
      nullable: true
      properties:
        created_by_id:
          description: ID of the user who deactivated the user
          title: Created by ID
          type: string
          x-stream-index: "003"
        mark_messages_deleted:
          description: Makes messages appear to be deleted
          title: Mark messages deleted
          type: boolean
          x-stream-index: "002"
      type: object
    DeactivateUserResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Deactivated user object
          title: User
          x-stream-index: "001"
      required:
      - duration
      type: object
    DeactivateUsersRequest:
      description: Deactivate users request
      nullable: true
      properties:
        created_by_id:
          description: ID of the user who deactivated the users
          title: Created by ID
          type: string
          x-stream-index: "003"
        mark_channels_deleted:
          type: boolean
          x-stream-index: "004"
        mark_messages_deleted:
          description: Makes messages appear to be deleted
          title: Mark messages deleted
          type: boolean
          x-stream-index: "002"
        user_ids:
          description: User IDs to deactivate
          items:
            type: string
          maximum: 100
          minimum: 1
          title: User IDs
          type: array
          x-stream-index: "001"
      required:
      - user_ids
      title: DeactivateUsersRequest
      type: object
    DeactivateUsersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        task_id:
          type: string
          x-stream-index: "001"
      required:
      - task_id
      - duration
      title: Response
      type: object
    DeleteCallRequest:
      description: DeleteCallRequest is the payload for deleting a call.
      nullable: true
      properties:
        hard:
          description: if true the call will be hard deleted along with all related
            data
          title: Hard
          type: boolean
          x-stream-index: "001"
      title: DeleteCallRequest
      type: object
    DeleteCallResponse:
      description: DeleteCallResponse is the payload for deleting a call.
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          title: Call
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "003.001"
        task_id:
          title: TaskID
          type: string
          x-stream-index: "002"
      required:
      - call
      - duration
      title: DeleteCallResponse
      type: object
    DeleteExternalStorageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    DeleteRecordingResponse:
      description: Response for DeleteRecording
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: DeleteRecordingResponse
      type: object
    DeleteTranscriptionResponse:
      description: DeleteTranscriptionResponse is the payload for deleting a transcription.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: DeleteTranscriptionResponse
      type: object
    DeleteUsersRequest:
      nullable: true
      properties:
        calls:
          description: |
            Calls delete mode.
            Affected calls are those that include exactly two members, one of whom is the user being deleted.

            * null or empty string - doesn't delete any calls
            * soft - marks user's calls and their related data as deleted (soft-delete)
            * hard - deletes user's calls and their data completely (hard-delete)
          enum:
          - soft
          - hard
          title: Delete User's calls
          type: string
          x-stream-index: 001.002.004
        conversations:
          description: |
            Conversation channels delete mode.
            Conversation channel is any channel which only has two members one of which is the user being deleted.

            * null or empty string - doesn't delete any conversation channels
            * soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)
            * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)
          enum:
          - soft
          - hard
          title: Delete Conversations
          type: string
          x-stream-index: 001.002.003
        files:
          description: |
            Delete user files.
            * false or empty string - doesn't delete any files
            * true - deletes all files uploaded by the user, including images and attachments.
          title: Delete User's files
          type: boolean
          x-stream-index: 001.002.005
        messages:
          description: |
            Message delete mode.

            * null or empty string - doesn't delete user messages
            * soft - marks all user messages as deleted without removing any related message data
            * pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags
            * hard - deletes messages completely with all related information
          enum:
          - soft
          - pruning
          - hard
          title: Delete Messages
          type: string
          x-stream-index: 001.002.002
        new_call_owner_id:
          type: string
          x-stream-index: 001.002.007
        new_channel_owner_id:
          type: string
          x-stream-index: 001.002.006
        user:
          description: |
            User delete mode.

            * soft - marks user as deleted and retains all user data
            * pruning - marks user as deleted and nullifies user information
            * hard - deletes user completely. Requires 'hard' option for messages and conversations as well
          enum:
          - soft
          - pruning
          - hard
          title: Delete User
          type: string
          x-stream-index: 001.002.001
        user_ids:
          description: IDs of users to delete
          items:
            type: string
          maximum: 100
          minimum: 1
          title: User IDs
          type: array
          x-stream-index: "001.001"
      required:
      - user_ids
      type: object
    DeleteUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        task_id:
          description: ID of the task to delete users
          title: Task ID
          type: string
          x-stream-index: "001"
      required:
      - task_id
      - duration
      type: object
    DeliveryReceipts:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    DeliveryReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    DeviceDataResponse:
      properties:
        name:
          type: string
          x-stream-index: "001"
        version:
          type: string
          x-stream-index: "002"
      type: object
    DeviceErrorInfo:
      properties:
        error_message:
          type: string
          x-stream-index: "003"
        provider:
          type: string
          x-stream-index: "001"
        provider_name:
          type: string
          x-stream-index: "002"
      required:
      - provider
      - provider_name
      - error_message
      type: object
    DeviceResponse:
      description: Response for Device
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "004"
        disabled:
          description: Whether device is disabled or not
          title: Disabled
          type: boolean
          x-stream-index: "005"
        disabled_reason:
          description: Reason explaining why device had been disabled
          title: Reason
          type: string
          x-stream-index: "006"
        id:
          description: Device ID
          title: ID
          type: string
          x-stream-index: "003"
        push_provider:
          description: Push provider
          title: PushProvider
          type: string
          x-stream-index: "001"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "002"
        user_id:
          description: User ID
          title: UserID
          type: string
          x-stream-index: "008"
        voip:
          description: When true the token is for Apple VoIP push notifications
          title: Voip
          type: boolean
          x-stream-index: "007"
      required:
      - push_provider
      - id
      - created_at
      - user_id
      title: DeviceResponse
      type: object
    DraftPayloadResponse:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        html:
          type: string
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "001"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "008"
        mml:
          type: string
          x-stream-index: "003"
        parent_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "013"
        quoted_message_id:
          type: string
          x-stream-index: "009"
        show_in_channel:
          type: boolean
          x-stream-index: "006"
        silent:
          type: boolean
          x-stream-index: "012"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "011"
      required:
      - id
      - text
      - custom
      type: object
    DraftResponse:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: number
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/DraftPayloadResponse'
          x-stream-index: "001"
        parent_id:
          type: string
          x-stream-index: "004"
        parent_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "005"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "006"
      required:
      - message
      - channel_cid
      - created_at
      type: object
    EdgeResponse:
      properties:
        continent_code:
          type: string
          x-stream-index: "007.003"
        country_iso_code:
          type: string
          x-stream-index: "007.002"
        green:
          format: int32
          type: integer
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        latency_test_url:
          type: string
          x-stream-index: "002"
        latitude:
          format: float
          type: number
          x-stream-index: "006.001"
        longitude:
          format: float
          type: number
          x-stream-index: "006.002"
        red:
          format: int32
          type: integer
          x-stream-index: "005"
        subdivision_iso_code:
          type: string
          x-stream-index: "007.001"
        yellow:
          format: int32
          type: integer
          x-stream-index: "004"
      required:
      - id
      - latency_test_url
      - green
      - yellow
      - red
      - latitude
      - longitude
      - subdivision_iso_code
      - country_iso_code
      - continent_code
      type: object
    EgressHLSResponse:
      properties:
        playlist_url:
          type: string
          x-stream-index: "001"
        status:
          type: string
          x-stream-index: "002"
      required:
      - playlist_url
      - status
      type: object
    EgressRTMPResponse:
      properties:
        name:
          type: string
          x-stream-index: "001"
        started_at:
          format: date-time
          type: number
          x-stream-index: "004"
        stream_key:
          type: string
          x-stream-index: "003"
        stream_url:
          type: string
          x-stream-index: "002"
      required:
      - name
      - started_at
      type: object
    EgressResponse:
      properties:
        broadcasting:
          type: boolean
          x-stream-index: "001"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingResponse'
          x-stream-index: "004"
        hls:
          $ref: '#/components/schemas/EgressHLSResponse'
          x-stream-index: "002"
        rtmps:
          items:
            $ref: '#/components/schemas/EgressRTMPResponse'
          type: array
          x-stream-index: "003"
      required:
      - broadcasting
      - rtmps
      type: object
    EndCallRequest:
      description: Request for ending a call
      nullable: true
      title: EndCallRequest
      type: object
    EndCallResponse:
      description: Response for ending a call
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: EndCallResponse
      type: object
    ErrorResult:
      properties:
        stacktrace:
          type: string
          x-stream-index: "003"
        type:
          type: string
          x-stream-index: "001"
        version:
          type: string
          x-stream-index: "004"
      required:
      - type
      - description
      type: object
    EventHook:
      nullable: true
      properties:
        callback:
          $ref: '#/components/schemas/AsyncModerationCallbackConfig'
          x-stream-index: 019.001.002
        created_at:
          format: date-time
          type: number
          x-stream-index: "020"
        enabled:
          type: boolean
          x-stream-index: "003"
        event_types:
          items:
            type: string
          type: array
          x-stream-index: "004"
        hook_type:
          type: string
          x-stream-index: "002"
        id:
          type: string
          x-stream-index: "001"
        product:
          type: string
          x-stream-index: "018"
        sns_auth_type:
          type: string
          x-stream-index: "014"
        sns_key:
          type: string
          x-stream-index: "015"
        sns_region:
          type: string
          x-stream-index: "013"
        sns_role_arn:
          type: string
          x-stream-index: "017"
        sns_secret:
          type: string
          x-stream-index: "016"
        sns_topic_arn:
          type: string
          x-stream-index: "012"
        sqs_auth_type:
          type: string
          x-stream-index: "008"
        sqs_key:
          type: string
          x-stream-index: "009"
        sqs_queue_url:
          type: string
          x-stream-index: "006"
        sqs_region:
          type: string
          x-stream-index: "007"
        sqs_role_arn:
          type: string
          x-stream-index: "011"
        sqs_secret:
          type: string
          x-stream-index: "010"
        timeout_ms:
          format: int32
          type: integer
          x-stream-index: 019.001.001
        updated_at:
          format: date-time
          type: number
          x-stream-index: "021"
        webhook_url:
          type: string
          x-stream-index: "005"
      type: object
    EventNotificationSettings:
      properties:
        apns:
          $ref: '#/components/schemas/APNS'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        fcm:
          $ref: '#/components/schemas/FCM'
          x-stream-index: "003"
      required:
      - enabled
      - apns
      - fcm
      type: object
    ExportUserResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "004.001"
        messages:
          description: List of exported messages
          items:
            $ref: '#/components/schemas/MessageResponse'
          title: Messages
          type: array
          x-stream-index: "002"
        reactions:
          description: List of exported reactions
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Reactions
          type: array
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Exported user object
          title: User
          x-stream-index: "001"
      required:
      - duration
      type: object
    ExportUsersRequest:
      nullable: true
      properties:
        user_ids:
          items:
            type: string
          maximum: 25
          minimum: 1
          type: array
          x-stream-index: "001"
      required:
      - user_ids
      type: object
    ExportUsersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        task_id:
          type: string
          x-stream-index: "001"
      required:
      - task_id
      - duration
      title: Response
      type: object
    ExternalStorageResponse:
      properties:
        bucket:
          type: string
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        path:
          type: string
          x-stream-index: "004"
        type:
          enum:
          - s3
          - gcs
          - abs
          type: string
          x-stream-index: "002"
      required:
      - name
      - type
      - bucket
      - path
      type: object
    FCM:
      properties:
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
      type: object
    FeedsPreferences:
      properties:
        comment:
          description: Push notification preference for comments on user's activities
          enum:
          - all
          - none
          title: Comment
          type: string
          x-stream-index: "002"
        comment_reaction:
          description: Push notification preference for reactions on comments
          enum:
          - all
          - none
          title: Comment Reaction
          type: string
          x-stream-index: "004"
        custom_activity_types:
          additionalProperties:
            type: string
          description: Push notification preferences for custom activity types. Map
            of activity type to preference (all or none)
          title: Custom Activity Types
          type: object
          x-stream-index: "006"
        follow:
          description: Push notification preference for new followers
          enum:
          - all
          - none
          title: Follow
          type: string
          x-stream-index: "001"
        mention:
          description: Push notification preference for mentions in activities or
            comments
          enum:
          - all
          - none
          title: Mention
          type: string
          x-stream-index: "005"
        reaction:
          description: Push notification preference for reactions on user's activities
            or comments
          enum:
          - all
          - none
          title: Reaction
          type: string
          x-stream-index: "003"
      title: Feeds Preferences
      type: object
    Field:
      nullable: true
      properties:
        short:
          type: boolean
          x-stream-index: "003"
        title:
          type: string
          x-stream-index: "001"
        value:
          type: string
          x-stream-index: "002"
      required:
      - title
      - value
      - short
      type: object
    FileUploadConfig:
      properties:
        allowed_file_extensions:
          items:
            type: string
          type: array
          x-stream-index: "001"
        allowed_mime_types:
          items:
            type: string
          type: array
          x-stream-index: "003"
        blocked_file_extensions:
          items:
            type: string
          type: array
          x-stream-index: "002"
        blocked_mime_types:
          items:
            type: string
          type: array
          x-stream-index: "004"
        size_limit:
          format: int32
          maximum: 104857600
          minimum: 0
          type: integer
          x-stream-index: "005"
      required:
      - size_limit
      type: object
    FileUploadRequest:
      nullable: true
      properties:
        file:
          description: file field
          title: File
          type: string
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/OnlyUserID'
          description: user for the request **server side only**
          title: User
          x-stream-index: "002"
      type: object
    FileUploadResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        file:
          description: URL to the uploaded asset. Should be used to put to `asset_url`
            attachment field
          title: File
          type: string
          x-stream-index: "001"
        thumb_url:
          description: URL of the file thumbnail for supported file formats. Should
            be put to `thumb_url` attachment field
          title: Thumbnail URL
          type: string
          x-stream-index: "002"
      required:
      - duration
      type: object
    FirebaseConfig:
      properties:
        Disabled:
          type: boolean
          writeOnly: true
          x-stream-index: "001"
        apn_template:
          type: string
          x-stream-index: "005"
        credentials_json:
          type: string
          x-stream-index: "006"
        data_template:
          type: string
          x-stream-index: "004"
        notification_template:
          type: string
          x-stream-index: "003"
        server_key:
          type: string
          x-stream-index: "002"
      type: object
    FirebaseConfigFields:
      properties:
        apn_template:
          type: string
          x-stream-index: "004"
        credentials_json:
          type: string
          x-stream-index: "006"
        data_template:
          type: string
          x-stream-index: "003"
        enabled:
          type: boolean
          x-stream-index: "001"
        notification_template:
          type: string
          x-stream-index: "002"
        server_key:
          type: string
          x-stream-index: "005"
      required:
      - enabled
      type: object
    FrameRecordSettings:
      properties:
        capture_interval_in_seconds:
          format: int32
          maximum: 60
          minimum: 2
          type: integer
          x-stream-index: "003"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        quality:
          type: string
          x-stream-index: "002"
      required:
      - mode
      - capture_interval_in_seconds
      type: object
    FrameRecordingResponse:
      properties:
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    FrameRecordingSettingsRequest:
      properties:
        capture_interval_in_seconds:
          format: int32
          maximum: 60
          minimum: 2
          type: integer
          x-stream-index: "003"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        quality:
          enum:
          - 360p
          - 480p
          - 720p
          - 1080p
          - 1440p
          type: string
          x-stream-index: "002"
      required:
      - mode
      - capture_interval_in_seconds
      type: object
    FrameRecordingSettingsResponse:
      properties:
        capture_interval_in_seconds:
          format: int32
          maximum: 60
          minimum: 2
          type: integer
          x-stream-index: "003"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        quality:
          type: string
          x-stream-index: "002"
      required:
      - mode
      - capture_interval_in_seconds
      type: object
    FullUserResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "015"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "014"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "007"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: number
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "001.011"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          type: array
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "005"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: number
          x-stream-index: "001.014"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "012"
        mutes:
          items:
            $ref: '#/components/schemas/UserMuteResponse'
          type: array
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "003"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        shadow_banned:
          type: boolean
          x-stream-index: "013"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "009"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "010"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "008"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "011"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - invisible
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      - shadow_banned
      - blocked_user_ids
      type: object
    GeofenceResponse:
      nullable: true
      properties:
        country_codes:
          items:
            type: string
          type: array
          x-stream-index: "004"
        description:
          type: string
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        type:
          type: string
          x-stream-index: "002"
      required:
      - name
      type: object
    GeofenceSettings:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - names
      type: object
    GeofenceSettingsRequest:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      type: object
    GeofenceSettingsResponse:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - names
      type: object
    GetActiveCallsStatusResponse:
      description: Response containing active calls status information
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
        end_time:
          description: End time of the status period
          format: date-time
          title: time.Time
          type: number
          x-stream-index: "003"
        metrics:
          $ref: '#/components/schemas/ActiveCallsMetrics'
          description: Detailed metrics
          title: '*ActiveCallsMetrics'
          x-stream-index: "005"
        start_time:
          description: Start time of the status period
          format: date-time
          title: time.Time
          type: number
          x-stream-index: "002"
        summary:
          $ref: '#/components/schemas/ActiveCallsSummary'
          description: Summary of active calls
          title: '*ActiveCallsSummary'
          x-stream-index: "004"
      required:
      - duration
      - start_time
      - end_time
      title: GetActiveCallsStatusResponse
      type: object
    GetApplicationResponse:
      description: Basic response information
      nullable: true
      properties:
        app:
          $ref: '#/components/schemas/AppResponseFields'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - app
      - duration
      title: Response
      type: object
    GetBlockListResponse:
      description: Response for get block list
      nullable: true
      properties:
        blocklist:
          $ref: '#/components/schemas/BlockListResponse'
          description: Block list object
          title: BlockListResponse
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      title: GetBlockListResponse
      type: object
      x-stream-docs-page-id: get_block_list
    GetBlockedUsersResponse:
      nullable: true
      properties:
        blocks:
          description: Array of blocked user object
          items:
            $ref: '#/components/schemas/BlockedUserResponse'
          title: Blocks
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - blocks
      - duration
      type: object
    GetCallReportResponse:
      description: Basic response information
      nullable: true
      properties:
        chat_activity:
          $ref: '#/components/schemas/ChatActivityStatsResponse'
          x-stream-index: "005"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        report:
          $ref: '#/components/schemas/ReportResponse'
          x-stream-index: "004"
        session:
          $ref: '#/components/schemas/CallSessionResponse'
          x-stream-index: "003"
        session_id:
          type: string
          x-stream-index: "002"
        video_reactions:
          items:
            $ref: '#/components/schemas/VideoReactionsResponse'
          type: array
          x-stream-index: "006"
      required:
      - duration
      - session_id
      - report
      title: Response
      type: object
    GetCallResponse:
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001.001"
        duration:
          type: string
          x-stream-index: "002.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "001.002"
        own_capabilities:
          items:
            $ref: '#/components/schemas/OwnCapability'
          type: array
          x-stream-index: "001.004"
      required:
      - call
      - members
      - own_capabilities
      - blocked_users
      - duration
      title: GetCallResponse
      type: object
    GetCallSessionParticipantStatsDetailsResponse:
      description: Basic response information
      nullable: true
      properties:
        call_id:
          type: string
          x-stream-index: "003"
        call_session_id:
          type: string
          x-stream-index: "004"
        call_type:
          type: string
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        publisher:
          $ref: '#/components/schemas/ParticipantSeriesPublisherStats'
          x-stream-index: "009"
        subscriber:
          $ref: '#/components/schemas/ParticipantSeriesSubscriberStats'
          x-stream-index: "010"
        timeframe:
          $ref: '#/components/schemas/ParticipantSeriesTimeframe'
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/ParticipantSeriesUserStats'
          x-stream-index: "008"
        user_id:
          type: string
          x-stream-index: "005"
        user_session_id:
          type: string
          x-stream-index: "006"
      required:
      - duration
      - call_type
      - call_id
      - call_session_id
      - user_id
      - user_session_id
      title: Response
      type: object
    GetCallTypeResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.005"
        duration:
          type: string
          x-stream-index: "002.001"
        external_storage:
          type: string
          x-stream-index: "001.007"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "001.002"
        name:
          type: string
          x-stream-index: "001.001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          x-stream-index: "001.004"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          x-stream-index: "001.003"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "001.006"
      required:
      - name
      - grants
      - settings
      - notification_settings
      - created_at
      - updated_at
      - duration
      title: GetCallTypeResponse
      type: object
    GetCustomPermissionResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        permission:
          $ref: '#/components/schemas/Permission'
          x-stream-index: "001"
      required:
      - permission
      - duration
      title: Response
      type: object
    GetEdgesResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        edges:
          items:
            $ref: '#/components/schemas/EdgeResponse'
          type: array
          x-stream-index: "001"
      required:
      - edges
      - duration
      title: Response
      type: object
    GetImportResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        import_task:
          $ref: '#/components/schemas/ImportTask'
          x-stream-index: "001"
      required:
      - duration
      title: Response
      type: object
    GetOGResponse:
      nullable: true
      properties:
        actions:
          items:
            $ref: '#/components/schemas/Action'
          type: array
          x-stream-index: "001.015"
        asset_url:
          description: URL of detected video or audio
          title: Image URL
          type: string
          x-stream-index: "001.017"
        author_icon:
          type: string
          x-stream-index: "001.007"
        author_link:
          description: og:site
          title: Author Link
          type: string
          x-stream-index: "001.006"
        author_name:
          description: og:site_name
          title: Author Name
          type: string
          x-stream-index: "001.005"
        color:
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.018"
        duration:
          type: string
          x-stream-index: "002.001"
        fallback:
          type: string
          x-stream-index: "001.002"
        fields:
          items:
            $ref: '#/components/schemas/Field'
          type: array
          x-stream-index: "001.016"
        footer:
          type: string
          x-stream-index: "001.013"
        footer_icon:
          type: string
          x-stream-index: "001.014"
        giphy:
          $ref: '#/components/schemas/Images'
          x-stream-index: "001.019"
        image_url:
          description: URL of detected image
          title: Image URL
          type: string
          x-stream-index: "001.011"
        og_scrape_url:
          description: extracted url from the text
          title: OG Scrape URL
          type: string
          x-stream-index: "001.020"
        original_height:
          format: int32
          type: integer
          x-stream-index: "001.022"
        original_width:
          format: int32
          type: integer
          x-stream-index: "001.021"
        pretext:
          type: string
          x-stream-index: "001.004"
        text:
          description: og:description
          title: Text
          type: string
          x-stream-index: "001.010"
        thumb_url:
          description: URL of detected thumb image
          title: Image URL
          type: string
          x-stream-index: "001.012"
        title:
          description: og:title
          title: Title
          type: string
          x-stream-index: "001.008"
        title_link:
          description: og:url
          title: Title Link
          type: string
          x-stream-index: "001.009"
        type:
          description: Attachment type, could be empty, image, audio or video
          title: Type
          type: string
          x-stream-index: "001.001"
      required:
      - custom
      - duration
      title: Get OG Attachment
      type: object
      x-stream-docs-page-id: og
    GetOrCreateCallRequest:
      nullable: true
      properties:
        data:
          $ref: '#/components/schemas/CallRequest'
          title: ReadOnlyData
          x-stream-index: "003"
        members_limit:
          format: int32
          maximum: 100
          type: integer
          x-stream-index: "007"
        notify:
          description: if provided it sends a notification event to the members for
            this call
          title: Notify
          type: boolean
          x-stream-index: "005"
        ring:
          description: if provided it sends a ring event to the members for this call
          title: Ring
          type: boolean
          x-stream-index: "004"
        video:
          type: boolean
          x-stream-index: "006"
      title: GetOrCreateCallRequest
      type: object
    GetOrCreateCallResponse:
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001.001"
        created:
          type: boolean
          x-stream-index: "002"
        duration:
          type: string
          x-stream-index: "003.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "001.002"
        own_capabilities:
          items:
            $ref: '#/components/schemas/OwnCapability'
          type: array
          x-stream-index: "001.004"
      required:
      - call
      - members
      - own_capabilities
      - blocked_users
      - created
      - duration
      title: GetOrCreateCallResponse
      type: object
    GetPushTemplatesResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        templates:
          items:
            $ref: '#/components/schemas/PushTemplate'
          type: array
          x-stream-index: "002"
      required:
      - duration
      - templates
      title: Response
      type: object
    GetRateLimitsResponse:
      nullable: true
      properties:
        android:
          additionalProperties:
            $ref: '#/components/schemas/LimitInfo'
          description: Map of endpoint rate limits for the Android platform
          title: Android
          type: object
          x-stream-index: "002"
          x-stream-map:
            description: The name of the endpoint for which the limits apply
            key: endpoint
            title: Endpoint name
        duration:
          type: string
          x-stream-index: "005.001"
        ios:
          additionalProperties:
            $ref: '#/components/schemas/LimitInfo'
          description: Map of endpoint rate limits for the iOS platform
          title: iOS
          type: object
          x-stream-index: "003"
          x-stream-map:
            description: The name of the endpoint for which the limits apply
            key: endpoint
            title: Endpoint name
        server_side:
          additionalProperties:
            $ref: '#/components/schemas/LimitInfo'
          description: Map of endpoint rate limits for the server-side platform
          title: Server-side
          type: object
          x-stream-index: "001"
          x-stream-map:
            description: The name of the endpoint for which the limits apply
            key: endpoint
            title: Endpoint name
        web:
          additionalProperties:
            $ref: '#/components/schemas/LimitInfo'
          description: Map of endpoint rate limits for the web platform
          title: Web
          type: object
          x-stream-index: "004"
          x-stream-map:
            description: The name of the endpoint for which the limits apply
            key: endpoint
            title: Endpoint name
      required:
      - duration
      title: Get Rate Limits Response
      type: object
      x-stream-docs-page-id: rate_limits
    GetTaskResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        duration:
          type: string
          x-stream-index: "004.001"
        error:
          $ref: '#/components/schemas/ErrorResult'
          description: Error produced by task
          title: Error
          x-stream-index: "003"
        result:
          additionalProperties: {}
          description: Result produced by task after completion
          title: Result
          type: object
          x-stream-index: "002"
        status:
          description: Current status of task
          title: Status
          type: string
          x-stream-index: "001.002"
        task_id:
          description: ID of task
          title: Task ID
          type: string
          x-stream-index: "001.001"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
      required:
      - task_id
      - status
      - created_at
      - updated_at
      - duration
      title: Get Task Response
      type: object
      x-stream-docs-page-id: tasks
    GoLiveRequest:
      nullable: true
      properties:
        recording_storage_name:
          type: string
          x-stream-index: "005"
        start_closed_caption:
          type: boolean
          x-stream-index: "008"
        start_hls:
          type: boolean
          x-stream-index: "003"
        start_recording:
          type: boolean
          x-stream-index: "004"
        start_transcription:
          type: boolean
          x-stream-index: "007"
        transcription_storage_name:
          type: string
          x-stream-index: "006"
      title: GoLiveRequest
      type: object
    GoLiveResponse:
      description: Basic response information
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - call
      - duration
      title: Response
      type: object
    GroupedStatsResponse:
      nullable: true
      properties:
        name:
          type: string
          x-stream-index: "001"
        unique:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - name
      - unique
      type: object
    HLSSettings:
      properties:
        auto_on:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "004"
        quality_tracks:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - auto_on
      - enabled
      - quality_tracks
      type: object
    HLSSettingsRequest:
      properties:
        auto_on:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        layout:
          $ref: '#/components/schemas/LayoutSettingsRequest'
          title: LayoutSettings
          x-stream-index: "004"
        quality_tracks:
          items:
            type: string
          maximum: 3
          minimum: 1
          type: array
          x-stream-index: "003"
      required:
      - quality_tracks
      title: HLSSettingsRequest
      type: object
    HLSSettingsResponse:
      description: HLSSettings is the payload for HLS settings
      properties:
        auto_on:
          title: Auto On
          type: boolean
          x-stream-index: "001"
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "002"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "004"
        quality_tracks:
          items:
            type: string
          title: Quality Tracks
          type: array
          x-stream-index: "003"
      required:
      - auto_on
      - enabled
      - quality_tracks
      - layout
      title: HLSSettingsResponse
      type: object
    HuaweiConfig:
      properties:
        Disabled:
          type: boolean
          writeOnly: true
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        secret:
          type: string
          x-stream-index: "002"
      type: object
    HuaweiConfigFields:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        id:
          type: string
          x-stream-index: "002"
        secret:
          type: string
          x-stream-index: "003"
      required:
      - enabled
      type: object
    ImageData:
      properties:
        frames:
          type: string
          x-stream-index: "005"
        height:
          type: string
          x-stream-index: "003"
        size:
          type: string
          x-stream-index: "004"
        url:
          type: string
          x-stream-index: "001"
        width:
          type: string
          x-stream-index: "002"
      required:
      - url
      - width
      - height
      - size
      - frames
      type: object
    ImageSize:
      properties:
        crop:
          description: Crop mode
          enum:
          - top
          - bottom
          - left
          - right
          - center
          title: Crop
          type: string
          x-stream-index: "001"
        height:
          description: Target image height
          format: int32
          title: Height
          type: integer
          x-stream-index: "003"
        resize:
          description: Resize method
          enum:
          - clip
          - crop
          - scale
          - fill
          title: Resize
          type: string
          x-stream-index: "002"
        width:
          description: Target image width
          format: int32
          title: Width
          type: integer
          x-stream-index: "004"
      title: Image size configuration
      type: object
    ImageUploadRequest:
      nullable: true
      properties:
        file:
          type: string
          x-stream-index: "001.001"
        upload_sizes:
          description: field with JSON-encoded array of image size configurations
          items:
            $ref: '#/components/schemas/ImageSize'
          title: Upload sizes
          type: array
          x-stream-index: "002"
        user:
          $ref: '#/components/schemas/OnlyUserID'
          x-stream-index: "001.002"
      type: object
    ImageUploadResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: 001.003.001
        file:
          type: string
          x-stream-index: "001.001"
        thumb_url:
          type: string
          x-stream-index: "001.002"
        upload_sizes:
          description: Array of image size configurations
          items:
            $ref: '#/components/schemas/ImageSize'
          title: Upload sizes
          type: array
          x-stream-index: "002"
      required:
      - duration
      type: object
    Images:
      properties:
        fixed_height:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "002"
        fixed_height_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "004"
        fixed_height_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "003"
        fixed_width:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "005"
        fixed_width_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "007"
        fixed_width_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "006"
        original:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "001"
      required:
      - original
      - fixed_height
      - fixed_height_still
      - fixed_height_downsampled
      - fixed_width
      - fixed_width_still
      - fixed_width_downsampled
      type: object
    ImportTask:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "011"
        history:
          items:
            $ref: '#/components/schemas/ImportTaskHistory'
          type: array
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "003"
        mode:
          type: string
          x-stream-index: "006"
        path:
          type: string
          x-stream-index: "005"
        size:
          format: int64
          type: integer
          x-stream-index: "007"
        state:
          type: string
          x-stream-index: "008"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "012"
      required:
      - id
      - path
      - mode
      - state
      - history
      - created_at
      - updated_at
      type: object
    ImportTaskHistory:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "005"
        next_state:
          type: string
          x-stream-index: "007"
        prev_state:
          type: string
          x-stream-index: "006"
      required:
      - created_at
      - prev_state
      - next_state
      type: object
    IngressAudioEncodingOptions:
      properties:
        bitrate:
          maximum: 128000
          minimum: 16000
          type: integer
          x-stream-index: "003"
        channels:
          enum:
          - "1"
          - "2"
          format: int32
          type: integer
          x-stream-index: "001"
        enable_dtx:
          type: boolean
          x-stream-index: "002"
      required:
      - channels
      - enable_dtx
      - bitrate
      type: object
    IngressAudioEncodingOptionsRequest:
      properties:
        bitrate:
          maximum: 128000
          minimum: 16000
          type: integer
          x-stream-index: "003"
        channels:
          enum:
          - "1"
          - "2"
          format: int32
          type: integer
          x-stream-index: "001"
        enable_dtx:
          type: boolean
          x-stream-index: "002"
      required:
      - channels
      - bitrate
      type: object
    IngressAudioEncodingResponse:
      properties:
        bitrate:
          format: int32
          type: integer
          x-stream-index: "003"
        channels:
          format: int32
          type: integer
          x-stream-index: "001"
        enable_dtx:
          type: boolean
          x-stream-index: "002"
      required:
      - channels
      - enable_dtx
      - bitrate
      type: object
    IngressSettings:
      properties:
        audio_encoding_options:
          $ref: '#/components/schemas/IngressAudioEncodingOptions'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        video_encoding_options:
          additionalProperties:
            $ref: '#/components/schemas/IngressVideoEncodingOptions'
          type: object
          x-stream-index: "003"
      required:
      - enabled
      type: object
    IngressSettingsRequest:
      properties:
        audio_encoding_options:
          $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        video_encoding_options:
          additionalProperties:
            $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest'
          type: object
          x-stream-index: "003"
      type: object
    IngressSettingsResponse:
      properties:
        audio_encoding_options:
          $ref: '#/components/schemas/IngressAudioEncodingResponse'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        video_encoding_options:
          additionalProperties:
            $ref: '#/components/schemas/IngressVideoEncodingResponse'
          type: object
          x-stream-index: "003"
      required:
      - enabled
      type: object
    IngressSource:
      properties:
        fps:
          maximum: 60
          minimum: 1
          type: integer
          x-stream-index: "003"
        height:
          minimum: 2
          type: integer
          x-stream-index: "002"
        width:
          minimum: 2
          type: integer
          x-stream-index: "001"
      required:
      - width
      - height
      - fps
      type: object
    IngressSourceRequest:
      properties:
        fps:
          enum:
          - "30"
          - "60"
          type: integer
          x-stream-index: "003"
        height:
          minimum: 2
          type: integer
          x-stream-index: "001"
        width:
          minimum: 2
          type: integer
          x-stream-index: "002"
      required:
      - height
      - width
      - fps
      type: object
    IngressSourceResponse:
      properties:
        fps:
          type: integer
          x-stream-index: "003"
        height:
          type: integer
          x-stream-index: "002"
        width:
          type: integer
          x-stream-index: "001"
      required:
      - width
      - height
      - fps
      type: object
    IngressVideoEncodingOptions:
      properties:
        layers:
          items:
            $ref: '#/components/schemas/IngressVideoLayer'
          minimum: 1
          type: array
          x-stream-index: "002"
        source:
          $ref: '#/components/schemas/IngressSource'
          x-stream-index: "001"
      required:
      - layers
      type: object
    IngressVideoEncodingOptionsRequest:
      properties:
        layers:
          items:
            $ref: '#/components/schemas/IngressVideoLayerRequest'
          minimum: 1
          type: array
          x-stream-index: "002"
        source:
          $ref: '#/components/schemas/IngressSourceRequest'
          x-stream-index: "001"
      required:
      - source
      - layers
      type: object
    IngressVideoEncodingResponse:
      properties:
        layers:
          items:
            $ref: '#/components/schemas/IngressVideoLayerResponse'
          type: array
          x-stream-index: "002"
        source:
          $ref: '#/components/schemas/IngressSourceResponse'
          x-stream-index: "001"
      required:
      - source
      - layers
      type: object
    IngressVideoLayer:
      nullable: true
      properties:
        bitrate:
          minimum: 1000
          type: integer
          x-stream-index: "002"
        codec:
          enum:
          - h264
          - vp8
          type: string
          x-stream-index: "001"
        frame_rate:
          maximum: 60
          minimum: 1
          type: integer
          x-stream-index: "003"
        max_dimension:
          minimum: 240
          type: integer
          x-stream-index: "005"
        min_dimension:
          minimum: 240
          type: integer
          x-stream-index: "004"
      required:
      - codec
      - bitrate
      - frame_rate
      - min_dimension
      - max_dimension
      type: object
    IngressVideoLayerRequest:
      nullable: true
      properties:
        bitrate:
          format: int32
          minimum: 1000
          type: integer
          x-stream-index: "002"
        codec:
          enum:
          - h264
          - vp8
          type: string
          x-stream-index: "001"
        frame_rate_limit:
          maximum: 60
          minimum: 1
          type: integer
          x-stream-index: "005"
        max_dimension:
          minimum: 240
          type: integer
          x-stream-index: "004"
        min_dimension:
          minimum: 240
          type: integer
          x-stream-index: "003"
      required:
      - codec
      - bitrate
      - min_dimension
      - max_dimension
      - frame_rate_limit
      type: object
    IngressVideoLayerResponse:
      nullable: true
      properties:
        bitrate:
          type: integer
          x-stream-index: "002"
        codec:
          type: string
          x-stream-index: "001"
        frame_rate_limit:
          type: integer
          x-stream-index: "005"
        max_dimension:
          type: integer
          x-stream-index: "004"
        min_dimension:
          type: integer
          x-stream-index: "003"
      required:
      - codec
      - bitrate
      - min_dimension
      - max_dimension
      - frame_rate_limit
      type: object
    JoinCallAPIMetrics:
      properties:
        failures:
          format: float
          type: number
          x-stream-index: "002"
        latency:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
        total:
          format: float
          type: number
          x-stream-index: "001"
      required:
      - total
      - failures
      type: object
    KickUserRequest:
      description: KickUserRequest is the payload for kicking a user from a call.
        Optionally block the user as well.
      nullable: true
      properties:
        block:
          description: If true, also block the user from rejoining the call
          title: Block
          type: boolean
          x-stream-index: "004"
        kicked_by:
          $ref: '#/components/schemas/UserRequest'
          description: 'Server-side: user performing the action'
          title: KickedBy
          x-stream-index: "006"
        kicked_by_id:
          description: 'Server-side: ID of the user performing the action'
          title: KickedByID
          type: string
          x-stream-index: "005"
        user_id:
          description: The user to kick
          title: UserID
          type: string
          x-stream-index: "003"
      required:
      - user_id
      title: KickUserRequest
      type: object
    KickUserResponse:
      description: KickUserResponse is the payload for kicking a user from a call.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: KickUserResponse
      type: object
    KickedUserEvent:
      description: This event is sent to call participants to notify when a user is
        kicked from a call. Clients should make the kicked user leave the call UI.
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        kicked_by_user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that kicked the participant, null if server-side
          title: Kicked by
          x-stream-index: "004"
        type:
          default: call.kicked_user
          description: 'The type of event: "call.kicked_user" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that was kicked
          title: User
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user
      title: KickedUserEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    LabelThresholds:
      properties:
        block:
          description: Threshold for automatic message block
          format: float
          maximum: 1
          minimum: 0
          title: Block
          type: number
          x-stream-index: "002"
        flag:
          description: Threshold for automatic message flag
          format: float
          maximum: 1
          minimum: 0
          title: Flag
          type: number
          x-stream-index: "001"
      type: object
    LayoutSettings:
      properties:
        detect_orientation:
          type: boolean
          x-stream-index: "005"
        external_app_url:
          type: string
          x-stream-index: "003"
        external_css_url:
          type: string
          x-stream-index: "004"
        name:
          enum:
          - spotlight
          - grid
          - single-participant
          - mobile
          - custom
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      required:
      - name
      - external_app_url
      - external_css_url
      type: object
    LayoutSettingsRequest:
      properties:
        detect_orientation:
          type: boolean
          x-stream-index: "005"
        external_app_url:
          type: string
          x-stream-index: "003"
        external_css_url:
          type: string
          x-stream-index: "004"
        name:
          enum:
          - spotlight
          - grid
          - single-participant
          - mobile
          - custom
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      required:
      - name
      type: object
    LayoutSettingsResponse:
      properties:
        detect_orientation:
          type: boolean
          x-stream-index: "005"
        external_app_url:
          type: string
          x-stream-index: "003"
        external_css_url:
          type: string
          x-stream-index: "004"
        name:
          enum:
          - spotlight
          - grid
          - single-participant
          - mobile
          - custom
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      required:
      - name
      - external_app_url
      - external_css_url
      type: object
    LimitInfo:
      properties:
        limit:
          description: The maximum number of calls allowed for the time window
          format: int32
          title: Limit
          type: integer
          x-stream-index: "001"
        remaining:
          description: The number of remaining calls in the current window
          format: int64
          title: Remaining
          type: integer
          x-stream-index: "002"
        reset:
          description: The Unix timestamp of the next window
          format: int64
          title: Reset
          type: integer
          x-stream-index: "003"
      required:
      - limit
      - remaining
      - reset
      title: Rate Limit info
      type: object
      x-stream-docs-page-id: rate_limits
    LimitsSettings:
      properties:
        max_duration_seconds:
          format: int32
          type: integer
          x-stream-index: "004"
        max_participants:
          format: int32
          type: integer
          x-stream-index: "001"
        max_participants_exclude_owner:
          type: boolean
          x-stream-index: "003"
        max_participants_exclude_roles:
          items:
            type: string
          type: array
          x-stream-index: "002"
      required:
      - max_participants_exclude_roles
      type: object
    LimitsSettingsRequest:
      properties:
        max_duration_seconds:
          format: int32
          minimum: 0
          type: integer
          x-stream-index: "004"
        max_participants:
          format: int32
          type: integer
          x-stream-index: "001"
        max_participants_exclude_owner:
          type: boolean
          x-stream-index: "003"
        max_participants_exclude_roles:
          items:
            type: string
          type: array
          x-stream-index: "002"
      type: object
    LimitsSettingsResponse:
      properties:
        max_duration_seconds:
          format: int32
          type: integer
          x-stream-index: "004"
        max_participants:
          format: int32
          type: integer
          x-stream-index: "001"
        max_participants_exclude_owner:
          type: boolean
          x-stream-index: "003"
        max_participants_exclude_roles:
          items:
            type: string
          type: array
          x-stream-index: "002"
      required:
      - max_participants_exclude_roles
      type: object
    ListBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListResponse'
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - blocklists
      - duration
      title: Response
      type: object
    ListCallTypeResponse:
      description: Response for ListCallType
      nullable: true
      properties:
        call_types:
          additionalProperties:
            $ref: '#/components/schemas/CallTypeResponse'
          type: object
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - call_types
      - duration
      title: ListCallTypeResponse
      type: object
    ListDevicesResponse:
      description: List devices response
      nullable: true
      properties:
        devices:
          description: List of devices
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - devices
      - duration
      title: ListDevicesResponse
      type: object
    ListExternalStorageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        external_storages:
          additionalProperties:
            $ref: '#/components/schemas/ExternalStorageResponse'
          type: object
          x-stream-index: "002"
      required:
      - duration
      - external_storages
      title: Response
      type: object
    ListImportsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        import_tasks:
          items:
            $ref: '#/components/schemas/ImportTask'
          type: array
          x-stream-index: "001"
      required:
      - import_tasks
      - duration
      title: Response
      type: object
    ListPermissionsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        permissions:
          items:
            $ref: '#/components/schemas/Permission'
          type: array
          x-stream-index: "001"
      required:
      - permissions
      - duration
      title: Response
      type: object
    ListPushProvidersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        push_providers:
          items:
            $ref: '#/components/schemas/PushProviderResponse'
          type: array
          x-stream-index: "001"
      required:
      - push_providers
      - duration
      title: Response
      type: object
    ListRecordingsResponse:
      description: Response for listing recordings
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
        recordings:
          items:
            $ref: '#/components/schemas/CallRecording'
          title: The list of recordings.
          type: array
          x-stream-index: "002"
      required:
      - duration
      - recordings
      title: ListRecordingsResponse
      type: object
    ListRolesResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        roles:
          items:
            $ref: '#/components/schemas/Role'
          type: array
          x-stream-index: "001"
      required:
      - roles
      - duration
      title: Response
      type: object
    ListTranscriptionsResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
        transcriptions:
          description: List of transcriptions for the call
          items:
            $ref: '#/components/schemas/CallTranscription'
          title: Transcriptions
          type: array
          x-stream-index: "002"
      required:
      - duration
      - transcriptions
      title: ListTranscriptionsResponse
      type: object
    MemberRequest:
      description: MemberRequest is the payload for adding a member to a call.
      properties:
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "003"
        role:
          title: Role
          type: string
          x-stream-index: "002"
        user_id:
          minLength: 1
          title: User ID
          type: string
          x-stream-index: "001"
      required:
      - user_id
      title: MemberRequest
      type: object
    MemberResponse:
      description: MemberResponse is the payload for a member of a call.
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          description: Custom member response data
          title: Custom
          type: object
          x-stream-index: "004"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "007"
        role:
          title: Role
          type: string
          x-stream-index: "003"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "006"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - user
      - user_id
      - custom
      - created_at
      - updated_at
      title: MemberResponse
      type: object
    Message:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "012"
        before_message_send_failed:
          type: boolean
          x-stream-index: "046"
        cid:
          type: string
          x-stream-index: "028"
        command:
          type: string
          x-stream-index: "006"
        created_at:
          format: date-time
          type: number
          x-stream-index: "030"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "034"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "033"
        deleted_for_me:
          type: boolean
          x-stream-index: "060"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "023"
        html:
          type: string
          x-stream-index: "007"
        i18n:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "044"
        id:
          type: string
          x-stream-index: "002"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "040"
        latest_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "013"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "059"
        mentioned_users:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "043"
        message_text_updated_at:
          format: date-time
          type: number
          x-stream-index: "052"
        mml:
          type: string
          x-stream-index: "005"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "056"
        own_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "014"
        parent_id:
          type: string
          x-stream-index: "019"
        pin_expires:
          format: date-time
          type: number
          x-stream-index: "051"
        pinned:
          type: boolean
          x-stream-index: "047"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "048"
        pinned_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "050"
        poll:
          $ref: '#/components/schemas/Poll'
          x-stream-index: "054"
        poll_id:
          type: string
          x-stream-index: "053"
        quoted_message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "025"
        quoted_message_id:
          type: string
          x-stream-index: "024"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "015"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "017"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "016"
        reminder:
          $ref: '#/components/schemas/MessageReminder'
          x-stream-index: "058"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "022"
        restricted_visibility:
          items:
            type: string
          type: array
          x-stream-index: "011"
        shadowed:
          type: boolean
          x-stream-index: "036"
        shared_location:
          $ref: '#/components/schemas/SharedLocation'
          x-stream-index: "055"
        show_in_channel:
          type: boolean
          x-stream-index: "021"
        silent:
          type: boolean
          x-stream-index: "045"
        text:
          type: string
          x-stream-index: "004"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "027"
        type:
          type: string
          x-stream-index: "008"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "031"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "010"
      required:
      - id
      - text
      - html
      - type
      - restricted_visibility
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reaction_groups
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      type: object
    MessageReminder:
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "004"
        channel_cid:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "011"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "006"
        message_id:
          type: string
          x-stream-index: "005"
        remind_at:
          format: date-time
          type: number
          x-stream-index: "009"
        task_id:
          type: string
          x-stream-index: "010"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "012"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        user_id:
          type: string
          x-stream-index: "007"
      required:
      - channel_cid
      - message_id
      - user_id
      - task_id
      - created_at
      - updated_at
      type: object
    MessageResponse:
      description: Represents any chat message
      properties:
        attachments:
          description: Array of message attachments
          items:
            $ref: '#/components/schemas/Attachment'
          title: Message attachments
          type: array
          x-stream-docs-page-id: message_format#attachment-format
          x-stream-index: "009"
        cid:
          description: Channel unique identifier in <type>:<id> format
          title: Channel CID
          type: string
          x-stream-index: "023"
        command:
          description: Contains provided slash command
          title: Command
          type: string
          x-stream-docs-page-id: custom_commands_webhook
          x-stream-index: "004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "024"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "027"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "026"
        deleted_for_me:
          type: boolean
          x-stream-index: "045"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "019"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "042"
        html:
          description: Contains HTML markup of the message. Can only be set when using
            server-side API
          title: HTML content
          type: string
          x-stream-index: "005"
        i18n:
          additionalProperties:
            type: string
          description: Object with translations. Key `language` contains the original
            language key. Other keys contain translations
          title: Internationalization info
          type: object
          x-stream-docs-page-id: translation
          x-stream-index: "031"
        id:
          description: Message ID is unique string identifier of the message
          title: ID
          type: string
          x-stream-index: "001"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          description: Contains image moderation information
          title: Image moderation labels
          type: object
          x-stream-index: "029"
        latest_reactions:
          description: List of 10 latest reactions to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Latest reactions
          type: array
          x-stream-index: "010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Channel member data for the message sender including only the
            `channel_role`
          title: Member object
          x-stream-index: "008"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "030"
        message_text_updated_at:
          format: date-time
          type: number
          x-stream-index: "037"
        mml:
          description: Should be empty if `text` is provided. Can only be set when
            using server-side API
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "003"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "040"
        own_reactions:
          description: List of 10 latest reactions of authenticated user to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Own reactions
          type: array
          x-stream-index: "011"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "016"
        pin_expires:
          description: Date when pinned message expires
          format: date-time
          title: Pin expiration date
          type: number
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "036"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "033"
        pinned_at:
          description: Date when message got pinned
          format: date-time
          title: Pinned at
          type: number
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "034"
        pinned_by:
          $ref: '#/components/schemas/UserResponse'
          description: Contains user who pinned the message
          title: Pinned by
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "035"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "039"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "038"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Contains quoted message
          title: Quoted message
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "021"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "020"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          description: 'An object containing number of reactions of each type. Key:
            reaction type (string), value: number of reactions (int)'
          title: Reaction counts
          type: object
          x-stream-index: "012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "015"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          description: 'An object containing scores of reactions of each type. Key:
            reaction type (string), value: total score of reactions (int)'
          title: Reaction scores
          type: object
          x-stream-index: "013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "043"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "018"
        restricted_visibility:
          description: A list of user ids that have restricted visibility to the message,
            if the list is not empty, the message is only visible to the users in
            the list
          items:
            type: string
          title: Restricted visibility
          type: array
          x-stream-index: "041"
        shadowed:
          description: Whether the message was shadowed or not
          title: Shadowed
          type: boolean
          x-stream-docs-page-id: moderation#shadow-ban
          x-stream-index: "028"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "044"
        show_in_channel:
          description: Whether thread reply should be shown in the channel as well
          title: Show in channel
          type: boolean
          x-stream-docs-page-id: threads
          x-stream-index: "017"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "032"
        text:
          description: Text of the message. Should be empty if `mml` is provided
          title: Text
          type: string
          x-stream-index: "002"
        thread_participants:
          description: List of users who participate in thread
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Thread participants
          type: array
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "022"
        type:
          description: Contains type of the message
          enum:
          - regular
          - ephemeral
          - error
          - reply
          - system
          - deleted
          title: Message Type
          type: string
          x-stream-docs-page-id: message_format#message-types
          x-stream-index: "006"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "025"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Sender of the message. Required when using server-side API
          title: User object
          x-stream-index: "007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      - restricted_visibility
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    MessageStatsResponse:
      properties:
        count_over_time:
          items:
            $ref: '#/components/schemas/CountByMinuteResponse'
          type: array
          x-stream-index: "001"
      type: object
    MetricThreshold:
      properties:
        level:
          type: string
          x-stream-index: "001"
        operator:
          type: string
          x-stream-index: "002"
        value:
          format: float
          type: number
          x-stream-index: "003"
        value_unit:
          type: string
          x-stream-index: "004"
        window_seconds:
          format: int32
          type: integer
          x-stream-index: "005"
      required:
      - level
      - operator
      - value
      type: object
    ModerationDashboardPreferences:
      properties:
        disable_flagging_reviewed_entity:
          type: boolean
          x-stream-index: "003"
        flag_user_on_flagged_content:
          type: boolean
          x-stream-index: "002"
        media_queue_blur_enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    ModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        image_harms:
          items:
            type: string
          type: array
          x-stream-index: "004"
        original_text:
          type: string
          x-stream-index: "002"
        platform_circumvented:
          type: boolean
          x-stream-index: "007"
        semantic_filter_matched:
          type: string
          x-stream-index: "006"
        text_harms:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - action
      - original_text
      type: object
    MuteUsersRequest:
      nullable: true
      properties:
        audio:
          title: Audio
          type: boolean
          x-stream-index: "005"
        mute_all_users:
          type: boolean
          x-stream-index: "003"
        muted_by:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "010"
        muted_by_id:
          type: string
          x-stream-index: "009"
        screenshare:
          title: Screenshare
          type: boolean
          x-stream-index: "007"
        screenshare_audio:
          title: ScreenshareAudio
          type: boolean
          x-stream-index: "008"
        user_ids:
          items:
            type: string
          title: UserIDs
          type: array
          x-stream-index: "004"
        video:
          title: Video
          type: boolean
          x-stream-index: "006"
      title: MuteUsersRequest
      type: object
    MuteUsersResponse:
      description: MuteUsersResponse is the response payload for the mute users endpoint.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: MuteUsersResponse
      type: object
    NetworkMetricsReportResponse:
      properties:
        average_connection_time:
          format: float
          type: number
          x-stream-index: "003"
        average_jitter:
          format: float
          type: number
          x-stream-index: "002"
        average_latency:
          format: float
          type: number
          x-stream-index: "001"
        average_time_to_reconnect:
          format: float
          type: number
          x-stream-index: "004"
      type: object
    NoiseCancellationSettings:
      properties:
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
      required:
      - mode
      type: object
    NotificationSettings:
      properties:
        call_live_started:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "002"
        call_missed:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "006"
        call_notification:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "004"
        call_ring:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        session_started:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "003"
      required:
      - enabled
      - call_live_started
      - session_started
      - call_notification
      - call_ring
      - call_missed
      type: object
    OnlyUserID:
      properties:
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    OwnCapability:
      description: All possibility of string to use
      enum:
      - block-users
      - change-max-duration
      - create-call
      - create-reaction
      - enable-noise-cancellation
      - end-call
      - join-backstage
      - join-call
      - join-ended-call
      - kick-user
      - mute-users
      - pin-for-everyone
      - read-call
      - remove-call-member
      - screenshare
      - send-audio
      - send-closed-captions-call
      - send-video
      - start-broadcast-call
      - start-closed-captions-call
      - start-frame-record-call
      - start-record-call
      - start-transcription-call
      - stop-broadcast-call
      - stop-closed-captions-call
      - stop-frame-record-call
      - stop-record-call
      - stop-transcription-call
      - update-call
      - update-call-member
      - update-call-permissions
      - update-call-settings
      title: OwnCapability
      type: string
    ParticipantCountByMinuteResponse:
      nullable: true
      properties:
        first:
          format: int32
          type: integer
          x-stream-index: "002"
        last:
          format: int32
          type: integer
          x-stream-index: "003"
        max:
          format: int32
          type: integer
          x-stream-index: "004"
        min:
          format: int32
          type: integer
          x-stream-index: "005"
        start_ts:
          format: date-time
          type: number
          x-stream-index: "001"
      required:
      - start_ts
      - first
      - last
      - max
      - min
      type: object
    ParticipantCountOverTimeResponse:
      properties:
        by_minute:
          items:
            $ref: '#/components/schemas/ParticipantCountByMinuteResponse'
          type: array
          x-stream-index: "001"
      type: object
    ParticipantReportResponse:
      properties:
        by_browser:
          items:
            $ref: '#/components/schemas/GroupedStatsResponse'
          type: array
          x-stream-index: "008"
        by_country:
          items:
            $ref: '#/components/schemas/GroupedStatsResponse'
          type: array
          x-stream-index: "005"
        by_device:
          items:
            $ref: '#/components/schemas/GroupedStatsResponse'
          type: array
          x-stream-index: "006"
        by_operating_system:
          items:
            $ref: '#/components/schemas/GroupedStatsResponse'
          type: array
          x-stream-index: "007"
        count_over_time:
          $ref: '#/components/schemas/ParticipantCountOverTimeResponse'
          x-stream-index: "004"
        max_concurrent:
          format: int32
          type: integer
          x-stream-index: "003"
        publishers:
          $ref: '#/components/schemas/PublisherStatsResponse'
          x-stream-index: "009"
        subscribers:
          $ref: '#/components/schemas/SubscriberStatsResponse'
          x-stream-index: "010"
        sum:
          format: int32
          type: integer
          x-stream-index: "001"
        unique:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - sum
      - unique
      type: object
    ParticipantSeriesPublisherStats:
      properties:
        global:
          additionalProperties:
            items:
              items:
                format: float
                type: number
              type: array
            type: array
          type: object
          x-stream-index: "001"
        global_thresholds:
          additionalProperties:
            items:
              $ref: '#/components/schemas/MetricThreshold'
            type: array
          type: object
          x-stream-index: "002"
        tracks:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ParticipantSeriesTrackMetrics'
            type: array
          type: object
          x-stream-index: "003"
      type: object
    ParticipantSeriesSubscriberStats:
      properties:
        global:
          additionalProperties:
            items:
              items:
                format: float
                type: number
              type: array
            type: array
          type: object
          x-stream-index: "001"
        global_thresholds:
          additionalProperties:
            items:
              $ref: '#/components/schemas/MetricThreshold'
            type: array
          type: object
          x-stream-index: "002"
        subscriptions:
          items:
            $ref: '#/components/schemas/ParticipantSeriesSubscriptionTrackMetrics'
          type: array
          x-stream-index: "003"
      type: object
    ParticipantSeriesSubscriptionTrackMetrics:
      properties:
        publisher_name:
          type: string
          x-stream-index: "003"
        publisher_user_id:
          type: string
          x-stream-index: "001"
        publisher_user_session_id:
          type: string
          x-stream-index: "002"
        tracks:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ParticipantSeriesTrackMetrics'
            type: array
          type: object
          x-stream-index: "004"
      required:
      - publisher_user_id
      type: object
    ParticipantSeriesTimeframe:
      properties:
        max_points:
          format: int32
          type: integer
          x-stream-index: "004"
        since:
          format: date-time
          type: number
          x-stream-index: "001"
        step_seconds:
          format: int32
          type: integer
          x-stream-index: "003"
        until:
          format: date-time
          type: number
          x-stream-index: "002"
      required:
      - since
      - until
      - step_seconds
      - max_points
      type: object
    ParticipantSeriesTrackMetrics:
      properties:
        codec:
          type: string
          x-stream-index: "004"
        label:
          type: string
          x-stream-index: "002"
        metrics:
          additionalProperties:
            items:
              items:
                format: float
                type: number
              type: array
            type: array
          type: object
          x-stream-index: "006"
        rid:
          type: string
          x-stream-index: "005"
        thresholds:
          additionalProperties:
            items:
              $ref: '#/components/schemas/MetricThreshold'
            type: array
          type: object
          x-stream-index: "007"
        track_id:
          type: string
          x-stream-index: "001"
        track_type:
          type: string
          x-stream-index: "003"
      required:
      - track_id
      type: object
    ParticipantSeriesUserStats:
      properties:
        metrics:
          additionalProperties:
            items:
              items:
                format: float
                type: number
              type: array
            type: array
          type: object
          x-stream-index: "001"
        thresholds:
          additionalProperties:
            items:
              $ref: '#/components/schemas/MetricThreshold'
            type: array
          type: object
          x-stream-index: "002"
      type: object
    PerSDKUsageReport:
      nullable: true
      properties:
        by_version:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "002"
        total:
          format: int32
          type: integer
          x-stream-index: "001"
      required:
      - total
      - by_version
      type: object
    Permission:
      properties:
        action:
          description: Action name this permission is for (e.g. SendMessage)
          title: Action
          type: string
          x-stream-index: "004"
        condition:
          additionalProperties: {}
          description: MongoDB style condition which decides whether or not the permission
            is granted
          title: Condition
          type: object
          x-stream-index: "007"
        custom:
          description: Whether this is a custom permission or built-in
          title: Custom
          type: boolean
          x-stream-index: "009"
        description:
          description: Description of the permission
          title: Description
          type: string
          x-stream-index: "003"
        id:
          description: Unique permission ID
          title: ID
          type: string
          x-stream-index: "001"
        level:
          description: Level at which permission could be applied (app or channel)
          enum:
          - app
          - channel
          title: Level
          type: string
          x-stream-index: "010"
        name:
          description: Name of the permission
          title: Name
          type: string
          x-stream-index: "002"
        owner:
          description: Whether this permission applies to resource owner or not
          title: Owner
          type: boolean
          x-stream-index: "005"
        same_team:
          description: Whether this permission applies to teammates (multi-tenancy
            mode only)
          title: Same team
          type: boolean
          x-stream-index: "006"
        tags:
          description: List of tags of the permission
          items:
            type: string
          title: Tags
          type: array
          x-stream-index: "011"
      required:
      - id
      - name
      - description
      - action
      - owner
      - same_team
      - custom
      - level
      - tags
      type: object
    PermissionRequestEvent:
      description: |-
        This event is sent when a user requests access to a feature on a call,
        clients receiving this event should display a permission request to the user
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        permissions:
          description: The list of permissions requested by the user
          items:
            type: string
          title: Permissions
          type: array
          x-stream-index: "004"
        type:
          default: call.permission_request
          description: 'The type of event: "call.permission_request" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who sent the permission request
          title: User
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user
      - permissions
      title: PermissionRequestEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PinRequest:
      description: PinRequest is the payload for pinning a message.
      nullable: true
      properties:
        session_id:
          description: the session ID of the user who pinned the message
          title: SessionID
          type: string
          x-stream-index: "003"
        user_id:
          description: the user ID of the user who pinned the message
          title: UserID
          type: string
          x-stream-index: "002"
      required:
      - user_id
      - session_id
      title: PinRequest
      type: object
    PinResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    PlatformDataResponse:
      properties:
        browser:
          $ref: '#/components/schemas/BrowserDataResponse'
          x-stream-index: "003"
        device:
          $ref: '#/components/schemas/DeviceDataResponse'
          x-stream-index: "002"
        os:
          $ref: '#/components/schemas/ClientOSDataResponse'
          x-stream-index: "001"
      required:
      - os
      - device
      - browser
      type: object
    Policy:
      properties:
        action:
          type: integer
          x-stream-index: "007"
        created_at:
          format: date-time
          type: number
          x-stream-index: "010"
        name:
          type: string
          x-stream-index: "004"
        owner:
          type: boolean
          x-stream-index: "008"
        priority:
          format: int32
          type: integer
          x-stream-index: "009"
        resources:
          items:
            type: string
          type: array
          x-stream-index: "005"
        roles:
          items:
            type: string
          type: array
          x-stream-index: "006"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "011"
      required:
      - name
      - resources
      - roles
      - action
      - owner
      - priority
      - created_at
      - updated_at
      type: object
    Poll:
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "023"
        allow_answers:
          type: boolean
          x-stream-index: "010"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "009"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "015"
        created_at:
          format: date-time
          type: number
          x-stream-index: "021"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "020"
        created_by_id:
          type: string
          x-stream-index: "019"
        description:
          type: string
          x-stream-index: "005"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "007"
        id:
          type: string
          x-stream-index: "003"
        is_closed:
          type: boolean
          x-stream-index: "011"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "017"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVote'
            type: array
          type: object
          x-stream-index: "016"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "008"
        name:
          type: string
          x-stream-index: "004"
        options:
          items:
            $ref: '#/components/schemas/PollOption'
          type: array
          x-stream-index: "013"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "018"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "022"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "012"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "014"
        voting_visibility:
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      - description
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - vote_counts_by_option
      - answers_count
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - Custom
      type: object
    PollOption:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollOptionInput:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
      type: object
    PollOptionRequest:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      type: object
    PollOptionResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        poll_option:
          $ref: '#/components/schemas/PollOptionResponseData'
          description: Poll option
          title: PollOptionResponseData
          x-stream-index: "001"
      required:
      - poll_option
      - duration
      type: object
    PollOptionResponseData:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: Poll
          title: PollResponseData
          x-stream-index: "001"
      required:
      - poll
      - duration
      type: object
    PollResponseData:
      properties:
        allow_answers:
          type: boolean
          x-stream-index: "008"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "007"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "012"
        created_at:
          format: date-time
          type: number
          x-stream-index: "019"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "018"
        created_by_id:
          type: string
          x-stream-index: "017"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "021"
        description:
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        is_closed:
          type: boolean
          x-stream-index: "009"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "015"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVoteResponseData'
            type: array
          type: object
          x-stream-index: "014"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "002"
        options:
          items:
            $ref: '#/components/schemas/PollOptionResponseData'
          type: array
          x-stream-index: "011"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "016"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "020"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "010"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "013"
        voting_visibility:
          type: string
          x-stream-index: "004"
      required:
      - id
      - name
      - description
      - voting_visibility
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - answers_count
      - vote_counts_by_option
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - custom
      type: object
    PollVote:
      nullable: true
      properties:
        answer_text:
          type: string
          x-stream-index: "007"
        created_at:
          format: date-time
          type: number
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "004"
        is_answer:
          type: boolean
          x-stream-index: "006"
        option_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "003"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "008"
      required:
      - poll_id
      - id
      - option_id
      - created_at
      - updated_at
      type: object
    PollVoteResponseData:
      nullable: true
      properties:
        answer_text:
          type: string
          x-stream-index: "005"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        id:
          type: string
          x-stream-index: "002"
        is_answer:
          type: boolean
          x-stream-index: "004"
        option_id:
          type: string
          x-stream-index: "003"
        poll_id:
          type: string
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "006"
      required:
      - poll_id
      - id
      - option_id
      - created_at
      - updated_at
      type: object
    PollVotesResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
        votes:
          description: Poll votes
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          title: PollVoteResponseList
          type: array
          x-stream-index: "001"
      required:
      - votes
      - duration
      type: object
    PrivacySettings:
      properties:
        delivery_receipts:
          $ref: '#/components/schemas/DeliveryReceipts'
          x-stream-index: "003"
        read_receipts:
          $ref: '#/components/schemas/ReadReceipts'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicators'
          x-stream-index: "001"
      type: object
    PrivacySettingsResponse:
      properties:
        delivery_receipts:
          $ref: '#/components/schemas/DeliveryReceiptsResponse'
          x-stream-index: "003"
        read_receipts:
          $ref: '#/components/schemas/ReadReceiptsResponse'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicatorsResponse'
          x-stream-index: "001"
      type: object
    PublishedTrackFlags:
      properties:
        audio:
          type: boolean
          x-stream-index: "002"
        screenshare:
          type: boolean
          x-stream-index: "003"
        screenshare_audio:
          type: boolean
          x-stream-index: "004"
        video:
          type: boolean
          x-stream-index: "001"
      required:
      - video
      - audio
      - screenshare
      - screenshare_audio
      type: object
    PublisherAllMetrics:
      properties:
        audio:
          $ref: '#/components/schemas/PublisherAudioMetrics'
          x-stream-index: "001"
        rtt_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
        video:
          $ref: '#/components/schemas/PublisherVideoMetrics'
          x-stream-index: "002"
      type: object
    PublisherAudioMetrics:
      properties:
        jitter_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "001"
      type: object
    PublisherStatsResponse:
      properties:
        by_track:
          items:
            $ref: '#/components/schemas/TrackStatsResponse'
          type: array
          x-stream-index: "003"
        total:
          format: int32
          type: integer
          x-stream-index: "001"
        unique:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - total
      - unique
      type: object
    PublisherVideoMetrics:
      properties:
        bitrate:
          $ref: '#/components/schemas/ActiveCallsBitrateStats'
          x-stream-index: "005"
        fps_30:
          $ref: '#/components/schemas/ActiveCallsFPSStats'
          x-stream-index: "002"
        frame_encoding_time_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
        jitter_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "001"
        resolution:
          $ref: '#/components/schemas/ActiveCallsResolutionStats'
          x-stream-index: "004"
      type: object
    PublishersMetrics:
      properties:
        all:
          $ref: '#/components/schemas/PublisherAllMetrics'
          x-stream-index: "001"
      type: object
    PushConfig:
      properties:
        offline_only:
          type: boolean
          x-stream-index: "002"
        version:
          enum:
          - v1
          - v2
          - v3
          type: string
          x-stream-index: "001"
      required:
      - version
      type: object
    PushNotificationFields:
      properties:
        apn:
          $ref: '#/components/schemas/APNConfigFields'
          x-stream-index: "002"
        firebase:
          $ref: '#/components/schemas/FirebaseConfigFields'
          x-stream-index: "003"
        huawei:
          $ref: '#/components/schemas/HuaweiConfigFields'
          x-stream-index: "004"
        offline_only:
          type: boolean
          x-stream-index: "001.002"
        providers:
          items:
            $ref: '#/components/schemas/PushProvider'
          type: array
          x-stream-index: "006"
        version:
          type: string
          x-stream-index: "001.001"
        xiaomi:
          $ref: '#/components/schemas/XiaomiConfigFields'
          x-stream-index: "005"
      required:
      - version
      - offline_only
      - apn
      - firebase
      - huawei
      - xiaomi
      type: object
    PushNotificationSettingsResponse:
      properties:
        disabled:
          type: boolean
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: number
          x-stream-index: "002"
      type: object
    PushPreferenceInput:
      nullable: true
      properties:
        call_level:
          description: Set the level of call push notifications for the user. One
            of all, none, default
          enum:
          - all
          - none
          - default
          type: string
          x-stream-index: "004"
        channel_cid:
          description: Set the push preferences for a specific channel. If empty it
            sets the default for the user
          type: string
          x-stream-index: "002"
        chat_level:
          description: Set the level of chat push notifications for the user. One
            of all, mentions, none, default
          enum:
          - all
          - mentions
          - none
          - default
          type: string
          x-stream-index: "003"
        disabled_until:
          description: Disable push notifications till a certain time
          format: date-time
          type: number
          x-stream-index: "007"
        feeds_level:
          description: Set the level of feeds push notifications for the user. One
            of all, none, default
          enum:
          - all
          - none
          - default
          type: string
          x-stream-index: "005"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferences'
          description: Set granular feeds preferences for reactions, comments, new
            followers, mentions, and custom activity types
          x-stream-index: "006"
        remove_disable:
          description: Remove the disabled until time. (IE stop snoozing notifications)
          type: boolean
          x-stream-index: "008"
        user_id:
          description: The user id for which to set the push preferences. Required
            when using server side auths, defaults to current user with client side
            auth.
          type: string
          x-stream-index: "001"
      type: object
    PushPreferences:
      nullable: true
      properties:
        call_level:
          type: string
          x-stream-index: "002"
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: number
          x-stream-index: "005"
        feeds_level:
          type: string
          x-stream-index: "003"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferences'
          x-stream-index: "004"
      type: object
    PushProvider:
      nullable: true
      properties:
        apn_auth_key:
          type: string
          x-stream-index: "012"
        apn_auth_type:
          type: string
          x-stream-index: "017"
        apn_development:
          type: boolean
          x-stream-index: "018"
        apn_host:
          type: string
          x-stream-index: "019"
        apn_key_id:
          type: string
          x-stream-index: "013"
        apn_notification_template:
          type: string
          x-stream-index: "020"
        apn_p12_cert:
          type: string
          x-stream-index: "014"
        apn_team_id:
          type: string
          x-stream-index: "015"
        apn_topic:
          type: string
          x-stream-index: "016"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        description:
          maxLength: 128
          type: string
          x-stream-index: "007"
        disabled_at:
          format: date-time
          type: number
          x-stream-index: "010"
        disabled_reason:
          maxLength: 255
          type: string
          x-stream-index: "011"
        firebase_apn_template:
          type: string
          x-stream-index: "025"
        firebase_credentials:
          type: string
          x-stream-index: "022"
        firebase_data_template:
          type: string
          x-stream-index: "023"
        firebase_host:
          type: string
          x-stream-index: "026"
        firebase_notification_template:
          type: string
          x-stream-index: "024"
        firebase_server_key:
          type: string
          x-stream-index: "021"
        huawei_app_id:
          type: string
          x-stream-index: "027"
        huawei_app_secret:
          type: string
          x-stream-index: "028"
        name:
          maxLength: 36
          minLength: 1
          type: string
          x-stream-index: "005"
        push_templates:
          items:
            $ref: '#/components/schemas/PushTemplate'
          type: array
          x-stream-index: "031"
        type:
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        xiaomi_app_secret:
          type: string
          x-stream-index: "030"
        xiaomi_package_name:
          type: string
          x-stream-index: "029"
      required:
      - name
      - type
      - created_at
      - updated_at
      type: object
    PushProviderResponse:
      properties:
        apn_auth_key:
          type: string
          x-stream-index: "008"
        apn_auth_type:
          type: string
          x-stream-index: "013"
        apn_development:
          type: boolean
          x-stream-index: "014"
        apn_host:
          type: string
          x-stream-index: "015"
        apn_key_id:
          type: string
          x-stream-index: "009"
        apn_p12_cert:
          type: string
          x-stream-index: "010"
        apn_sandbox_certificate:
          type: boolean
          x-stream-index: "016"
        apn_supports_remote_notifications:
          type: boolean
          x-stream-index: "018"
        apn_supports_voip_notifications:
          type: boolean
          x-stream-index: "017"
        apn_team_id:
          type: string
          x-stream-index: "011"
        apn_topic:
          type: string
          x-stream-index: "012"
        created_at:
          format: date-time
          type: number
          x-stream-index: "004"
        description:
          type: string
          x-stream-index: "003"
        disabled_at:
          format: date-time
          type: number
          x-stream-index: "006"
        disabled_reason:
          type: string
          x-stream-index: "007"
        firebase_apn_template:
          type: string
          x-stream-index: "023"
        firebase_credentials:
          type: string
          x-stream-index: "020"
        firebase_data_template:
          type: string
          x-stream-index: "021"
        firebase_host:
          type: string
          x-stream-index: "024"
        firebase_notification_template:
          type: string
          x-stream-index: "022"
        firebase_server_key:
          type: string
          x-stream-index: "019"
        huawei_app_id:
          type: string
          x-stream-index: "025"
        huawei_app_secret:
          type: string
          x-stream-index: "026"
        name:
          type: string
          x-stream-index: "001"
        type:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "005"
        xiaomi_app_secret:
          type: string
          x-stream-index: "028"
        xiaomi_package_name:
          type: string
          x-stream-index: "027"
      required:
      - name
      - type
      - created_at
      - updated_at
      type: object
    PushTemplate:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "007"
        enable_push:
          type: boolean
          x-stream-index: "003"
        event_type:
          enum:
          - message.new
          - message.updated
          - reaction.new
          - notification.reminder_due
          - feeds.activity.added
          - feeds.comment.added
          - feeds.activity.reaction.added
          - feeds.comment.reaction.added
          - feeds.follow.created
          - feeds.notification_feed.updated
          type: string
          x-stream-index: "005"
        template:
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "008"
      required:
      - enable_push
      - event_type
      - created_at
      - updated_at
      type: object
    QualityScoreReport:
      properties:
        histogram:
          items:
            $ref: '#/components/schemas/ReportByHistogramBucket'
          type: array
          x-stream-index: "001"
      required:
      - histogram
      type: object
    QualityScoreReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateQualityScoreReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    QueryAggregateCallStatsRequest:
      nullable: true
      properties:
        from:
          type: string
          x-stream-index: "002"
        report_types:
          items:
            type: string
          type: array
          x-stream-index: "004"
        to:
          type: string
          x-stream-index: "003"
      type: object
    QueryAggregateCallStatsResponse:
      description: Basic response information
      nullable: true
      properties:
        call_duration_report:
          $ref: '#/components/schemas/CallDurationReportResponse'
          x-stream-index: "002"
        call_participant_count_report:
          $ref: '#/components/schemas/CallParticipantCountReportResponse'
          x-stream-index: "004"
        calls_per_day_report:
          $ref: '#/components/schemas/CallsPerDayReportResponse'
          x-stream-index: "003"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        network_metrics_report:
          $ref: '#/components/schemas/NetworkMetricsReportResponse'
          x-stream-index: "008"
        quality_score_report:
          $ref: '#/components/schemas/QualityScoreReportResponse'
          x-stream-index: "005"
        sdk_usage_report:
          $ref: '#/components/schemas/SDKUsageReportResponse'
          x-stream-index: "006"
        user_feedback_report:
          $ref: '#/components/schemas/UserFeedbackReportResponse'
          x-stream-index: "007"
      required:
      - duration
      title: Response
      type: object
    QueryCallMembersRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
        id:
          maxLength: 64
          type: string
          x-stream-index: "001.002"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "004.001"
        next:
          type: string
          x-stream-index: "004.002"
        prev:
          type: string
          x-stream-index: "004.003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 1
          type: array
          x-stream-index: "003"
        type:
          maxLength: 64
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - id
      type: object
    QueryCallMembersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - members
      - duration
      title: Response
      type: object
    QueryCallParticipantsRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
      type: object
    QueryCallParticipantsResponse:
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001.001"
        duration:
          type: string
          x-stream-index: "004.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "001.002"
        own_capabilities:
          items:
            $ref: '#/components/schemas/OwnCapability'
          type: array
          x-stream-index: "001.004"
        participants:
          description: List of call participants
          items:
            $ref: '#/components/schemas/CallParticipantResponse'
          title: '[]CallParticipantResponse'
          type: array
          x-stream-index: "002"
        total_participants:
          format: int32
          type: integer
          x-stream-index: "003"
      required:
      - call
      - members
      - own_capabilities
      - blocked_users
      - participants
      - total_participants
      - duration
      type: object
    QueryCallSessionParticipantStatsResponse:
      description: Basic response information
      nullable: true
      properties:
        call_ended_at:
          format: date-time
          type: number
          x-stream-index: "007"
        call_id:
          type: string
          x-stream-index: "004"
        call_session_id:
          type: string
          x-stream-index: "005"
        call_started_at:
          format: date-time
          type: number
          x-stream-index: "006"
        call_type:
          type: string
          x-stream-index: "003"
        counts:
          $ref: '#/components/schemas/CallStatsParticipantCounts'
          x-stream-index: "008"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        next:
          type: string
          x-stream-index: "002.001"
        participants:
          items:
            $ref: '#/components/schemas/CallStatsParticipant'
          type: array
          x-stream-index: "009"
        prev:
          type: string
          x-stream-index: "002.002"
        tmp_data_source:
          type: string
          x-stream-index: "010"
      required:
      - duration
      - call_type
      - call_id
      - call_session_id
      - counts
      - participants
      title: Response
      type: object
    QueryCallSessionParticipantStatsTimelineResponse:
      description: Basic response information
      nullable: true
      properties:
        call_id:
          type: string
          x-stream-index: "003"
        call_session_id:
          type: string
          x-stream-index: "004"
        call_type:
          type: string
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        events:
          items:
            $ref: '#/components/schemas/CallParticipantTimeline'
          type: array
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "005"
        user_session_id:
          type: string
          x-stream-index: "006"
      required:
      - duration
      - call_type
      - call_id
      - call_session_id
      - user_id
      - user_session_id
      - events
      title: Response
      type: object
    QueryCallStatsRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "004.001"
        next:
          type: string
          x-stream-index: "004.002"
        prev:
          type: string
          x-stream-index: "004.003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 2
          type: array
          x-stream-index: "002"
      type: object
    QueryCallStatsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        next:
          type: string
          x-stream-index: "003.001"
        prev:
          type: string
          x-stream-index: "003.002"
        reports:
          items:
            $ref: '#/components/schemas/CallStatsReportSummaryResponse'
          type: array
          x-stream-index: "001"
      required:
      - reports
      - duration
      title: Response
      type: object
    QueryCallsRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          title: Filters
          type: object
          x-stream-index: "003"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "006.001"
        next:
          type: string
          x-stream-index: "006.002"
        prev:
          type: string
          x-stream-index: "006.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 2
          title: Sort
          type: array
          x-stream-index: "004"
      title: QueryCallsRequest
      type: object
    QueryCallsResponse:
      nullable: true
      properties:
        calls:
          items:
            $ref: '#/components/schemas/CallStateResponseFields'
          title: Calls
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - calls
      - duration
      title: QueryCallsResponse
      type: object
    QueryPollVotesRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          title: Filter
          type: object
          x-stream-index: "003"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "004"
      type: object
    QueryPollsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          title: Filter
          type: object
          x-stream-index: "002"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "003"
      type: object
    QueryPollsResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        polls:
          description: Polls data returned by the query
          items:
            $ref: '#/components/schemas/PollResponseData'
          title: PollsResponseData
          type: array
          x-stream-index: "001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - polls
      - duration
      type: object
    QueryUserFeedbackRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 2
          type: array
          x-stream-index: "002"
      type: object
    QueryUserFeedbackResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        next:
          type: string
          x-stream-index: "003.001"
        prev:
          type: string
          x-stream-index: "003.002"
        user_feedback:
          items:
            $ref: '#/components/schemas/UserFeedbackResponse'
          type: array
          x-stream-index: "001"
      required:
      - user_feedback
      - duration
      title: Response
      type: object
    QueryUsersPayload:
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        include_deactivated_users:
          type: boolean
          x-stream-index: "004"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.003"
        offset:
          format: int32
          maximum: 1000
          type: integer
          x-stream-index: "005.004"
        presence:
          type: boolean
          x-stream-index: "003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          type: array
          x-stream-index: "002"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "006.002"
        user_id:
          type: string
          x-stream-index: "006.001"
      required:
      - filter_conditions
      type: object
    QueryUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        users:
          description: Array of users as result of filters applied.
          items:
            $ref: '#/components/schemas/FullUserResponse'
          title: Users
          type: array
          x-stream-index: "001"
      required:
      - users
      - duration
      type: object
    RTMPBroadcastRequest:
      description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast.
      properties:
        layout:
          $ref: '#/components/schemas/LayoutSettingsRequest'
          description: If provided, will override the call's RTMP settings layout
          title: Layout
          x-stream-index: "005"
        name:
          description: Name identifier for RTMP broadcast, must be unique in call
          maxLength: 255
          title: Name
          type: string
          x-stream-index: "001"
        quality:
          description: If provided, will override the call's RTMP settings quality
          enum:
          - 360p
          - 480p
          - 720p
          - 1080p
          - 1440p
          - portrait-360x640
          - portrait-480x854
          - portrait-720x1280
          - portrait-1080x1920
          - portrait-1440x2560
          title: Quality
          type: string
          x-stream-index: "004"
        stream_key:
          description: If provided, will be appended at the end of stream_url
          title: Stream Key
          type: string
          x-stream-index: "003"
        stream_url:
          description: URL for the RTMP server to send the call to
          maxLength: 255
          title: Stream URL
          type: string
          x-stream-index: "002"
      required:
      - name
      - stream_url
      title: RTMPBroadcastRequest
      type: object
    RTMPIngress:
      description: RTMP input settings
      properties:
        address:
          title: Address
          type: string
          x-stream-index: "001"
      required:
      - address
      title: RTMPIngress
      type: object
    RTMPLocation:
      properties:
        name:
          type: string
          x-stream-index: "001"
        stream_key:
          type: string
          x-stream-index: "003"
        stream_url:
          type: string
          x-stream-index: "002"
      required:
      - name
      - stream_url
      - stream_key
      type: object
    RTMPSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "003"
        location:
          $ref: '#/components/schemas/RTMPLocation'
          x-stream-index: "004"
        quality_name:
          type: string
          x-stream-index: "002"
      required:
      - enabled
      type: object
    RTMPSettingsRequest:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsRequest'
          description: Layout for the composed RTMP stream
          title: LayoutSettings
          x-stream-index: "003"
        quality:
          description: Resolution to set for the RTMP stream
          enum:
          - 360p
          - 480p
          - 720p
          - 1080p
          - 1440p
          - portrait-360x640
          - portrait-480x854
          - portrait-720x1280
          - portrait-1080x1920
          - portrait-1440x2560
          title: Quality
          type: string
          x-stream-index: "002"
      title: RTMPSettingsRequest
      type: object
    RTMPSettingsResponse:
      description: RTMPSettingsResponse is the payload for RTMP settings
      properties:
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "003"
        quality:
          title: Quality
          type: string
          x-stream-index: "002"
      required:
      - enabled
      - quality
      - layout
      title: RTMPSettingsResponse
      type: object
    Reaction:
      nullable: true
      properties:
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "003"
        score:
          format: int32
          type: integer
          x-stream-index: "007"
        type:
          maxLength: 30
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - message_id
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReactionGroupResponse:
      description: ReactionGroupResponse contains all information about a reaction
        of the same type.
      nullable: true
      properties:
        count:
          description: Count is the number of reactions of this type.
          format: int32
          title: Count
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          description: FirstReactionAt is the time of the first reaction of this type.
            This is the same also if all reaction of this type are deleted, because
            if someone will react again with the same type, will be preserved the
            sorting.
          format: date-time
          title: FirstReactionAt
          type: number
          x-stream-index: "003"
        last_reaction_at:
          description: LastReactionAt is the time of the last reaction of this type.
          format: date-time
          title: LastReactionAt
          type: number
          x-stream-index: "004"
        sum_scores:
          description: 'SumScores is the sum of all scores of reactions of this type.
            Medium allows you to clap articles more than once and shows the sum of
            all claps from all users. For example, you can send `clap` x5 using `score:
            5`.'
          format: int32
          title: SumScores
          type: integer
          x-stream-index: "002"
      required:
      - count
      - sum_scores
      - first_reaction_at
      - last_reaction_at
      title: ReactionGroupResponse
      type: object
    ReactionResponse:
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        message_id:
          description: Message ID
          title: Message ID
          type: string
          x-stream-index: "001"
        score:
          description: Score of the reaction
          format: int32
          title: Score
          type: integer
          x-stream-index: "005"
        type:
          description: Type of reaction
          title: Type
          type: string
          x-stream-index: "004"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User
          title: UserResponse
          x-stream-index: "003"
        user_id:
          description: User ID
          title: User ID
          type: string
          x-stream-index: "002"
      required:
      - message_id
      - user_id
      - user
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReactivateUserRequest:
      nullable: true
      properties:
        created_by_id:
          description: ID of the user who's reactivating the user
          title: Created by ID
          type: string
          x-stream-index: "004"
        name:
          description: Set this field to put new name for the user
          title: Name
          type: string
          x-stream-index: "003"
        restore_messages:
          description: Restore previously deleted messages
          title: Restore messages
          type: boolean
          x-stream-index: "002"
      type: object
    ReactivateUserResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: 001.002.001
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Deactivated user object
          title: User
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    ReactivateUsersRequest:
      description: Reactivate users in batches
      nullable: true
      properties:
        created_by_id:
          description: ID of the user who's reactivating the users
          title: Created by ID
          type: string
          x-stream-index: "003"
        restore_channels:
          type: boolean
          x-stream-index: "004"
        restore_messages:
          description: Restore previously deleted messages
          title: Restore messages
          type: boolean
          x-stream-index: "002"
        user_ids:
          description: User IDs to reactivate
          items:
            type: string
          maximum: 100
          minimum: 1
          title: User IDs
          type: array
          x-stream-index: "001"
      required:
      - user_ids
      title: ReactivateUsersRequest
      type: object
    ReactivateUsersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: 001.002.001
        task_id:
          type: string
          x-stream-index: "001.001"
      required:
      - task_id
      - duration
      title: Response
      type: object
    ReadReceipts:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ReadReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    RecordSettings:
      properties:
        audio_only:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "004"
        mode:
          type: string
          x-stream-index: "002"
        quality:
          type: string
          x-stream-index: "003"
      required:
      - mode
      type: object
    RecordSettingsRequest:
      properties:
        audio_only:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsRequest'
          title: LayoutSettings
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          title: Mode
          type: string
          x-stream-index: "002"
        quality:
          enum:
          - 360p
          - 480p
          - 720p
          - 1080p
          - 1440p
          - portrait-360x640
          - portrait-480x854
          - portrait-720x1280
          - portrait-1080x1920
          - portrait-1440x2560
          type: string
          x-stream-index: "003"
      required:
      - mode
      title: RecordSettingsRequest
      type: object
    RecordSettingsResponse:
      description: RecordSettings is the payload for recording settings
      properties:
        audio_only:
          title: Audio Only
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "004"
        mode:
          title: Mode
          type: string
          x-stream-index: "002"
        quality:
          title: Quality
          type: string
          x-stream-index: "003"
      required:
      - audio_only
      - mode
      - quality
      - layout
      title: RecordSettingsResponse
      type: object
    ReminderResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "005"
        message_id:
          type: string
          x-stream-index: "004"
        remind_at:
          format: date-time
          type: number
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "006"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_at
      - updated_at
      type: object
    ReportByHistogramBucket:
      properties:
        category:
          type: string
          x-stream-index: "001"
        count:
          format: int32
          type: integer
          x-stream-index: "005"
        lower_bound:
          $ref: '#/components/schemas/Bound'
          x-stream-index: "002"
        sum:
          format: float
          type: number
          x-stream-index: "004"
        upper_bound:
          $ref: '#/components/schemas/Bound'
          x-stream-index: "003"
      required:
      - category
      - sum
      - count
      type: object
    ReportResponse:
      properties:
        call:
          $ref: '#/components/schemas/CallReportResponse'
          x-stream-index: "003"
        participants:
          $ref: '#/components/schemas/ParticipantReportResponse'
          x-stream-index: "001"
        user_ratings:
          $ref: '#/components/schemas/UserRatingReportResponse'
          x-stream-index: "002"
      required:
      - participants
      - user_ratings
      - call
      type: object
    Response:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001"
      required:
      - duration
      title: Response
      type: object
    RestoreUsersRequest:
      nullable: true
      properties:
        user_ids:
          items:
            type: string
          maximum: 100
          minimum: 1
          type: array
          x-stream-index: "001"
      required:
      - user_ids
      type: object
    RingSettings:
      properties:
        auto_cancel_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "002"
        incoming_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "001"
        missed_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "003"
      required:
      - incoming_call_timeout_ms
      - auto_cancel_timeout_ms
      - missed_call_timeout_ms
      type: object
    RingSettingsRequest:
      properties:
        auto_cancel_timeout_ms:
          description: When none of the callees accept a ring call in this time a
            rejection will be sent by the caller with reason 'timeout' by the SDKs
          format: int32
          maximum: 180000
          minimum: 5000
          title: AutoCancelTimeoutMs
          type: integer
          x-stream-index: "002"
        incoming_call_timeout_ms:
          description: When a callee is online but doesn't answer a ring call in this
            time a rejection will be sent with reason 'timeout' by the SDKs
          format: int32
          maximum: 180000
          minimum: 5000
          title: IncomingCallTimeoutMs
          type: integer
          x-stream-index: "001"
        missed_call_timeout_ms:
          description: When a callee doesn't accept or reject a ring call in this
            time a missed call event will be sent
          format: int32
          maximum: 180000
          minimum: 5000
          title: MissedCallTimeoutMs
          type: integer
          x-stream-index: "003"
      required:
      - incoming_call_timeout_ms
      - auto_cancel_timeout_ms
      title: RingSettingsRequest
      type: object
    RingSettingsResponse:
      properties:
        auto_cancel_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "002"
        incoming_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "001"
        missed_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "003"
      required:
      - incoming_call_timeout_ms
      - auto_cancel_timeout_ms
      - missed_call_timeout_ms
      type: object
    Role:
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "004"
        custom:
          description: Whether this is a custom role or built-in
          title: Custom
          type: boolean
          x-stream-index: "002"
        name:
          description: Unique role name
          title: Name
          type: string
          x-stream-index: "001"
        scopes:
          description: List of scopes where this role is currently present. `.app`
            means that role is present in app-level grants
          items:
            type: string
          title: Scopes
          type: array
          x-stream-index: "003"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "005"
      required:
      - name
      - custom
      - scopes
      - created_at
      - updated_at
      type: object
    S3Request:
      description: Config for creating Amazon S3 storage.
      properties:
        s3_api_key:
          description: 'The AWS API key. To use Amazon S3 as your storage provider,
            you have two authentication options: IAM role or API key. If you do not
            specify the `s3_api_key` parameter, Stream will use IAM role authentication.
            In that case make sure to have the correct IAM role configured for your
            application.'
          title: S3ApiKey
          type: string
          x-stream-index: "002"
        s3_custom_endpoint_url:
          description: The custom endpoint for S3. If you want to use a custom endpoint,
            you must also provide the `s3_api_key` and `s3_secret` parameters.
          title: S3CustomEndpointURL
          type: string
          x-stream-index: "004"
        s3_region:
          description: The AWS region where the bucket is hosted
          title: S3Region
          type: string
          x-stream-index: "001"
        s3_secret:
          description: The AWS API Secret
          title: S3Secret
          type: string
          x-stream-index: "003"
      required:
      - s3_region
      title: S3Request
      type: object
    SDKUsageReport:
      properties:
        per_sdk_usage:
          additionalProperties:
            $ref: '#/components/schemas/PerSDKUsageReport'
          type: object
          x-stream-index: "001"
      required:
      - per_sdk_usage
      type: object
    SDKUsageReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateSDKUsageReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    SRTIngress:
      properties:
        address:
          type: string
          x-stream-index: "001"
      required:
      - address
      type: object
    ScreensharingSettings:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      type: object
    ScreensharingSettingsRequest:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      type: object
    ScreensharingSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      type: object
    SendCallEventRequest:
      description: Send a call event to the other user
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          title: Custom
          type: object
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      title: SendCallEventRequest
      type: object
    SendCallEventResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: SendCallEventResponse
      type: object
    SendClosedCaptionRequest:
      nullable: true
      properties:
        end_time:
          format: date-time
          title: Optional end time, defaults to start_time + 1s if omitted
          type: number
          x-stream-index: "007"
        language:
          title: The language of the closed caption.
          type: string
          x-stream-index: "009"
        service:
          title: The service that generated the closed caption. By default stream
          type: string
          x-stream-index: "008"
        speaker_id:
          maxLength: 256
          title: Speaker user id
          type: string
          x-stream-index: "005"
        start_time:
          format: date-time
          title: Optional start time, defaults to now
          type: number
          x-stream-index: "006"
        text:
          maxLength: 32768
          title: The caption text
          type: string
          x-stream-index: "004"
        translated:
          title: Whether the closed caption is translated.
          type: boolean
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      required:
      - text
      - speaker_id
      type: object
    SendClosedCaptionResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    SessionSettings:
      properties:
        inactivity_timeout_seconds:
          format: int32
          maximum: 900
          minimum: 5
          type: integer
          x-stream-index: "001"
      required:
      - inactivity_timeout_seconds
      type: object
    SessionSettingsRequest:
      properties:
        inactivity_timeout_seconds:
          format: int32
          maximum: 900
          minimum: 5
          type: integer
          x-stream-index: "001"
      required:
      - inactivity_timeout_seconds
      type: object
    SessionSettingsResponse:
      properties:
        inactivity_timeout_seconds:
          format: int32
          maximum: 900
          minimum: 5
          type: integer
          x-stream-index: "001"
      required:
      - inactivity_timeout_seconds
      type: object
    SharedLocation:
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "013"
        channel_cid:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "010"
        created_by_device_id:
          type: string
          x-stream-index: "008"
        end_at:
          format: date-time
          type: number
          x-stream-index: "009"
        latitude:
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "006"
        longitude:
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "012"
        message_id:
          type: string
          x-stream-index: "004"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "011"
        user_id:
          type: string
          x-stream-index: "005"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_by_device_id
      - created_at
      - updated_at
      type: object
    SharedLocationResponse:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001.011"
        channel_cid:
          description: Channel CID
          title: string
          type: string
          x-stream-index: "001.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.008"
        created_by_device_id:
          description: Device ID that created the live location
          title: string
          type: string
          x-stream-index: "001.006"
        duration:
          type: string
          x-stream-index: "002.001"
        end_at:
          description: Time when the live location expires
          format: date-time
          title: string
          type: number
          x-stream-index: "001.007"
        latitude:
          description: Latitude coordinate
          format: float
          title: number
          type: number
          x-stream-index: "001.004"
        longitude:
          description: Longitude coordinate
          format: float
          title: number
          type: number
          x-stream-index: "001.005"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001.010"
        message_id:
          description: Message ID
          title: string
          type: string
          x-stream-index: "001.002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "001.009"
        user_id:
          description: User ID
          title: string
          type: string
          x-stream-index: "001.003"
      required:
      - channel_cid
      - message_id
      - user_id
      - latitude
      - longitude
      - created_by_device_id
      - created_at
      - updated_at
      - duration
      type: object
    SharedLocationResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "011"
        channel_cid:
          type: string
          x-stream-index: "001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        created_by_device_id:
          type: string
          x-stream-index: "006"
        end_at:
          format: date-time
          type: number
          x-stream-index: "007"
        latitude:
          format: float
          type: number
          x-stream-index: "004"
        longitude:
          format: float
          type: number
          x-stream-index: "005"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - channel_cid
      - message_id
      - user_id
      - latitude
      - longitude
      - created_by_device_id
      - created_at
      - updated_at
      type: object
    SharedLocationsResponse:
      nullable: true
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocationResponseData'
          type: array
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - active_live_locations
      - duration
      type: object
    SortParamRequest:
      nullable: true
      properties:
        direction:
          description: Direction of sorting, 1 for Ascending, -1 for Descending, default
            is 1
          format: int32
          title: Direction
          type: integer
          x-stream-index: "002"
        field:
          description: Name of field to sort by
          title: Field
          type: string
          x-stream-index: "001"
      type: object
    SpeechSegmentConfig:
      properties:
        max_speech_caption_ms:
          format: int32
          type: integer
          x-stream-index: "001"
        silence_duration_ms:
          format: int32
          type: integer
          x-stream-index: "002"
      type: object
    StartClosedCaptionsRequest:
      nullable: true
      properties:
        enable_transcription:
          description: Enable transcriptions along with closed captions
          title: Enable Transcription
          type: boolean
          x-stream-index: "002"
        external_storage:
          description: Which external storage to use for transcriptions (only applicable
            if enable_transcription is true)
          title: External Storage
          type: string
          x-stream-index: "003"
        language:
          description: The spoken language in the call, if not provided the language
            defined in the transcription settings will be used
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          title: Language
          type: string
          x-stream-index: "004"
        speech_segment_config:
          $ref: '#/components/schemas/SpeechSegmentConfig'
          x-stream-index: "005"
      type: object
    StartClosedCaptionsResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    StartFrameRecordingRequest:
      nullable: true
      properties:
        recording_external_storage:
          type: string
          x-stream-index: "002"
      title: StartFrameRecordingRequest
      type: object
    StartFrameRecordingResponse:
      description: StartFrameRecordingResponse is the response payload for the start
        frame recording endpoint.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: StartFrameRecordingResponse
      type: object
    StartHLSBroadcastingRequest:
      description: StartHLSBroadcastingRequest is the payload for starting an HLS
        broadcasting.
      nullable: true
      title: StartHLSBroadcastingRequest
      type: object
    StartHLSBroadcastingResponse:
      description: StartHLSBroadcastingResponse is the payload for starting an HLS
        broadcasting.
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
        playlist_url:
          description: the URL of the HLS playlist
          title: PlaylistURL
          type: string
          x-stream-index: "002"
      required:
      - duration
      - playlist_url
      title: StartHLSBroadcastingResponse
      type: object
    StartRTMPBroadcastsRequest:
      description: StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.
      nullable: true
      properties:
        broadcasts:
          description: List of broadcasts to start
          items:
            $ref: '#/components/schemas/RTMPBroadcastRequest'
          maximum: 1
          minimum: 1
          title: Broadcasts
          type: array
          x-stream-index: "002"
      required:
      - broadcasts
      title: StartRTMPBroadcastsRequest
      type: object
    StartRTMPBroadcastsResponse:
      description: StartRTMPBroadcastsResponse is the payload for starting an RTMP
        broadcast.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: StartRTMPBroadcastsResponse
      type: object
    StartRecordingRequest:
      nullable: true
      properties:
        recording_external_storage:
          type: string
          x-stream-index: "002"
      title: StartRecordingRequest
      type: object
    StartRecordingResponse:
      description: StartRecordingResponse is the response payload for the start recording
        endpoint.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: StartRecordingResponse
      type: object
    StartTranscriptionRequest:
      nullable: true
      properties:
        enable_closed_captions:
          description: Enable closed captions along with transcriptions
          title: Enable Closed Captions
          type: boolean
          x-stream-index: "003"
        language:
          description: The spoken language in the call, if not provided the language
            defined in the transcription settings will be used
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          title: Language
          type: string
          x-stream-index: "004"
        transcription_external_storage:
          description: Store transcriptions in this external storage
          title: External Storage
          type: string
          x-stream-index: "002"
      type: object
    StartTranscriptionResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: StartTranscriptionResponse
      type: object
    StopAllRTMPBroadcastsRequest:
      nullable: true
      title: StopAllRTMPBroadcastsRequest
      type: object
    StopAllRTMPBroadcastsResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: StopAllRTMPBroadcastsResponse
      type: object
    StopClosedCaptionsRequest:
      nullable: true
      properties:
        stop_transcription:
          type: boolean
          x-stream-index: "003"
      type: object
    StopClosedCaptionsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    StopFrameRecordingRequest:
      nullable: true
      type: object
    StopFrameRecordingResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    StopHLSBroadcastingRequest:
      nullable: true
      type: object
    StopHLSBroadcastingResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    StopLiveRequest:
      nullable: true
      properties:
        continue_closed_caption:
          type: boolean
          x-stream-index: "006"
        continue_hls:
          type: boolean
          x-stream-index: "003"
        continue_recording:
          type: boolean
          x-stream-index: "004"
        continue_rtmp_broadcasts:
          type: boolean
          x-stream-index: "007"
        continue_transcription:
          type: boolean
          x-stream-index: "005"
      title: StopLiveRequest
      type: object
    StopLiveResponse:
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          description: The call that was stopped
          title: Call
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - call
      - duration
      title: StopLiveResponse
      type: object
    StopRTMPBroadcastsRequest:
      description: Request for stopping RTMP broadcasts
      nullable: true
      title: StopRTMPBroadcastsRequest
      type: object
    StopRTMPBroadcastsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    StopRecordingRequest:
      nullable: true
      type: object
    StopRecordingResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    StopTranscriptionRequest:
      nullable: true
      properties:
        stop_closed_captions:
          type: boolean
          x-stream-index: "003"
      type: object
    StopTranscriptionResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    SubscriberAllMetrics:
      properties:
        audio:
          $ref: '#/components/schemas/SubscriberAudioMetrics'
          x-stream-index: "001"
        rtt_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
        video:
          $ref: '#/components/schemas/SubscriberVideoMetrics'
          x-stream-index: "002"
      type: object
    SubscriberAudioMetrics:
      properties:
        concealment_pct:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
        jitter_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "001"
        packets_lost_pct:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "002"
      type: object
    SubscriberStatsResponse:
      properties:
        total:
          format: int32
          type: integer
          x-stream-index: "001"
        total_subscribed_duration_seconds:
          format: int32
          type: integer
          x-stream-index: "003"
        unique:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - total
      - unique
      - total_subscribed_duration_seconds
      type: object
    SubscriberVideoMetrics:
      properties:
        fps_30:
          $ref: '#/components/schemas/ActiveCallsFPSStats'
          x-stream-index: "002"
        jitter_ms:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "001"
        packets_lost_pct:
          $ref: '#/components/schemas/ActiveCallsLatencyStats'
          x-stream-index: "003"
      type: object
    SubscribersMetrics:
      properties:
        all:
          $ref: '#/components/schemas/SubscriberAllMetrics'
          x-stream-index: "001"
      type: object
    TargetResolution:
      properties:
        bitrate:
          format: int32
          maximum: 6000000
          type: integer
          x-stream-index: "003"
        height:
          format: int32
          maximum: 3840
          minimum: 240
          type: integer
          x-stream-index: "002"
        width:
          format: int32
          maximum: 3840
          minimum: 240
          type: integer
          x-stream-index: "001"
      required:
      - width
      - height
      - bitrate
      type: object
    Thresholds:
      description: Sets thresholds for AI moderation
      properties:
        explicit:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for explicit messages
          title: LabelThresholds
          x-stream-index: "001"
        spam:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for spam
          title: LabelThresholds
          x-stream-index: "002"
        toxic:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for toxic messages
          title: LabelThresholds
          x-stream-index: "003"
      title: Auto moderation thresholds
      type: object
    ThumbnailResponse:
      properties:
        image_url:
          type: string
          x-stream-index: "001"
      required:
      - image_url
      type: object
    ThumbnailsSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ThumbnailsSettingsRequest:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    ThumbnailsSettingsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    TrackStatsResponse:
      nullable: true
      properties:
        duration_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
        track_type:
          type: string
          x-stream-index: "001"
      required:
      - track_type
      - duration_seconds
      type: object
    TranscriptionSettings:
      properties:
        closed_caption_mode:
          enum:
          - available
          - disabled
          - auto-on
          title: Mode
          type: string
          x-stream-index: "002"
        language:
          description: The language used in this call as a two letter code
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          title: Language
          type: string
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          title: Mode
          type: string
          x-stream-index: "001"
        speech_segment_config:
          $ref: '#/components/schemas/SpeechSegmentConfig'
          x-stream-index: "006"
        translation:
          $ref: '#/components/schemas/TranslationSettings'
          x-stream-index: "005"
      required:
      - mode
      - closed_caption_mode
      - languages
      - language
      type: object
    TranscriptionSettingsRequest:
      properties:
        closed_caption_mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "002"
        language:
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          type: string
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        speech_segment_config:
          $ref: '#/components/schemas/SpeechSegmentConfig'
          x-stream-index: "006"
        translation:
          $ref: '#/components/schemas/TranslationSettings'
          x-stream-index: "005"
      type: object
    TranscriptionSettingsResponse:
      properties:
        closed_caption_mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "002"
        language:
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          type: string
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        speech_segment_config:
          $ref: '#/components/schemas/SpeechSegmentConfig'
          x-stream-index: "006"
        translation:
          $ref: '#/components/schemas/TranslationSettings'
          x-stream-index: "005"
      required:
      - mode
      - closed_caption_mode
      - languages
      - language
      type: object
    TranslationSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        languages:
          items:
            type: string
          type: array
          x-stream-index: "002"
      required:
      - enabled
      - languages
      type: object
    TypingIndicators:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    TypingIndicatorsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    UnblockUserRequest:
      description: UnblockUserRequest is the payload for unblocking a user.
      nullable: true
      properties:
        user_id:
          description: the user to unblock
          title: UserID
          type: string
          x-stream-index: "003"
      required:
      - user_id
      title: UnblockUserRequest
      type: object
    UnblockUserResponse:
      description: UnblockUserResponse is the payload for unblocking a user.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: UnblockUserResponse
      type: object
    UnblockUsersRequest:
      nullable: true
      properties:
        blocked_user_id:
          type: string
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      required:
      - blocked_user_id
      type: object
    UnblockUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    UnblockedUserEvent:
      description: |-
        This event is sent when a user is unblocked on a call,
        this can be useful to notify the user that they can now join the call again
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        type:
          default: call.unblocked_user
          description: 'The type of event: "call.unblocked_user" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user that was unblocked
          title: User
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user
      title: UnblockedUserEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UnpinRequest:
      description: UnpinRequest is the payload for unpinning a message.
      nullable: true
      properties:
        session_id:
          description: the session ID of the user who pinned the message
          title: SessionID
          type: string
          x-stream-index: "003"
        user_id:
          description: the user ID of the user who pinned the message
          title: UserID
          type: string
          x-stream-index: "002"
      required:
      - user_id
      - session_id
      title: UnpinRequest
      type: object
    UnpinResponse:
      description: UnpinResponse is the payload for unpinning a message.
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: UnpinResponse
      type: object
    UpdateAppRequest:
      nullable: true
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        apn_config:
          $ref: '#/components/schemas/APNConfig'
          x-stream-index: "001.003"
        async_moderation_config:
          $ref: '#/components/schemas/AsyncModerationConfiguration'
          x-stream-index: "001.039"
        async_url_enrich_enabled:
          type: boolean
          x-stream-index: "001.019"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "001.018"
        before_message_send_hook_url:
          type: string
          x-stream-index: "001.020"
        cdn_expiration_seconds:
          format: int32
          maximum: 1209600
          minimum: 14400
          type: integer
          x-stream-index: "001.038"
        channel_hide_members_only:
          type: boolean
          x-stream-index: "001.033"
        custom_action_handler_url:
          type: string
          x-stream-index: "001.021"
        datadog_info:
          $ref: '#/components/schemas/DataDogInfo'
          x-stream-index: "001.040"
        disable_auth_checks:
          type: boolean
          x-stream-index: "001.001"
        disable_permissions_checks:
          type: boolean
          x-stream-index: "001.002"
        enforce_unique_usernames:
          enum:
          - "no"
          - app
          - team
          type: string
          x-stream-index: "001.022"
        event_hooks:
          items:
            $ref: '#/components/schemas/EventHook'
          type: array
          x-stream-index: "001.046"
        feeds_moderation_enabled:
          type: boolean
          x-stream-index: "001.042"
        feeds_v2_region:
          type: string
          x-stream-index: "001.041"
        file_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "001.030"
        firebase_config:
          $ref: '#/components/schemas/FirebaseConfig'
          x-stream-index: "001.004"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "001.034"
        guest_user_creation_disabled:
          type: boolean
          x-stream-index: "001.043"
        huawei_config:
          $ref: '#/components/schemas/HuaweiConfig'
          x-stream-index: "001.005"
        image_moderation_block_labels:
          items:
            type: string
          type: array
          x-stream-index: "001.015"
        image_moderation_enabled:
          type: boolean
          x-stream-index: "001.016"
        image_moderation_labels:
          items:
            type: string
          type: array
          x-stream-index: "001.014"
        image_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "001.029"
        max_aggregated_activities_length:
          format: int32
          type: integer
          x-stream-index: "001.049"
        migrate_permissions_to_v2:
          type: boolean
          x-stream-index: "001.035"
        moderation_dashboard_preferences:
          $ref: '#/components/schemas/ModerationDashboardPreferences'
          x-stream-index: "001.044"
        moderation_enabled:
          type: boolean
          x-stream-index: "001.009"
        moderation_webhook_url:
          type: string
          x-stream-index: "001.010"
        multi_tenant_enabled:
          type: boolean
          x-stream-index: "001.013"
        permission_version:
          enum:
          - v1
          - v2
          type: string
          x-stream-index: "001.011"
        push_config:
          $ref: '#/components/schemas/PushConfig'
          x-stream-index: "001.007"
        reminders_interval:
          format: int32
          maximum: 86400
          minimum: 60
          type: integer
          x-stream-index: "001.036"
        reminders_max_members:
          format: int32
          minimum: 2
          type: integer
          x-stream-index: "001.037"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.031"
        sns_key:
          type: string
          x-stream-index: "001.027"
        sns_secret:
          type: string
          x-stream-index: "001.028"
        sns_topic_arn:
          type: string
          x-stream-index: "001.026"
        sqs_key:
          type: string
          x-stream-index: "001.024"
        sqs_secret:
          type: string
          x-stream-index: "001.025"
        sqs_url:
          type: string
          x-stream-index: "001.023"
        user_response_time_enabled:
          type: boolean
          x-stream-index: "001.048"
        user_search_disallowed_roles:
          items:
            type: string
          type: array
          x-stream-index: "001.012"
        webhook_events:
          items:
            type: string
          type: array
          x-stream-index: "001.032"
        webhook_url:
          type: string
          x-stream-index: "001.008"
        xiaomi_config:
          $ref: '#/components/schemas/XiaomiConfig'
          x-stream-index: "001.006"
      type: object
    UpdateBlockListRequest:
      nullable: true
      properties:
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "005"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "006"
        team:
          type: string
          x-stream-index: "002"
        words:
          description: List of words to block
          items:
            type: string
          minimum: 1
          title: Words
          type: array
          x-stream-index: "003"
      title: Update block list
      type: object
      x-stream-docs-page-id: update_block_list
    UpdateBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklist:
          $ref: '#/components/schemas/BlockListResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      title: Response
      type: object
    UpdateCallMembersRequest:
      description: Update call members
      nullable: true
      properties:
        remove_members:
          description: List of userID to remove
          items:
            type: string
          maximum: 100
          title: Remove Members
          type: array
          x-stream-index: "003"
        update_members:
          description: List of members to update or insert
          items:
            $ref: '#/components/schemas/MemberRequest'
          maximum: 100
          title: Update Members
          type: array
          x-stream-index: "004"
      title: UpdateCallMembersRequest
      type: object
    UpdateCallMembersResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "002"
      required:
      - duration
      - members
      title: Response
      type: object
    UpdateCallRequest:
      description: Request for updating a call
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "003"
        settings_override:
          $ref: '#/components/schemas/CallSettingsRequest'
          description: the settings to change for this call
          title: Settings Override
          x-stream-index: "004"
        starts_at:
          description: the time the call is scheduled to start
          format: date-time
          title: Starts At
          type: number
          x-stream-index: "005"
      title: UpdateCallRequest
      type: object
    UpdateCallResponse:
      description: Response for updating a call
      nullable: true
      properties:
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "001.001"
        duration:
          type: string
          x-stream-index: "002.001"
        members:
          items:
            $ref: '#/components/schemas/MemberResponse'
          type: array
          x-stream-index: "001.002"
        own_capabilities:
          items:
            $ref: '#/components/schemas/OwnCapability'
          type: array
          x-stream-index: "001.004"
      required:
      - call
      - members
      - own_capabilities
      - blocked_users
      - duration
      title: UpdateCallResponse
      type: object
    UpdateCallTypeRequest:
      description: UpdateCallTypeRequest is the payload for updating a call type.
      nullable: true
      properties:
        external_storage:
          type: string
          x-stream-index: "002.004"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "002.001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          x-stream-index: "002.002"
        settings:
          $ref: '#/components/schemas/CallSettingsRequest'
          x-stream-index: "002.003"
      title: UpdateCallTypeRequest
      type: object
    UpdateCallTypeResponse:
      description: UpdateCallTypeResponse is the payload for updating a call type.
      nullable: true
      properties:
        created_at:
          description: the time the call type was created
          format: date-time
          title: CreatedAt
          type: number
          x-stream-index: "001.005"
        duration:
          type: string
          x-stream-index: "002.001"
        external_storage:
          description: the external storage for the call type
          title: ExternalStorage
          type: string
          x-stream-index: "001.007"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          description: the permissions granted to each role
          title: Grants
          type: object
          x-stream-index: "001.002"
        name:
          description: the name of the call type
          title: Name
          type: string
          x-stream-index: "001.001"
        notification_settings:
          $ref: '#/components/schemas/NotificationSettings'
          description: the notification settings for the call type
          title: NotificationSettings
          x-stream-index: "001.004"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          description: the settings for the call type
          title: Settings
          x-stream-index: "001.003"
        updated_at:
          description: the time the call type was last updated
          format: date-time
          title: UpdatedAt
          type: number
          x-stream-index: "001.006"
      required:
      - name
      - grants
      - settings
      - notification_settings
      - created_at
      - updated_at
      - duration
      title: UpdateCallTypeResponse
      type: object
    UpdateExternalStorageRequest:
      description: External storage
      nullable: true
      properties:
        aws_s3:
          $ref: '#/components/schemas/S3Request'
          description: Only required if you want to create an Amazon S3 storage
          title: AwsS3
          x-stream-index: "003.004"
        azure_blob:
          $ref: '#/components/schemas/AzureRequest'
          description: Only required if you want to create an Azure Blob Storage
          title: AzureBlob
          x-stream-index: "003.006"
        bucket:
          description: The name of the bucket on the service provider
          title: Bucket
          type: string
          x-stream-index: "003.002"
        gcs_credentials:
          type: string
          x-stream-index: "003.005"
        path:
          description: The path prefix to use for storing files
          title: Path
          type: string
          x-stream-index: "003.003"
        storage_type:
          description: The type of storage to use
          enum:
          - s3
          - gcs
          - abs
          title: StorageType
          type: string
          x-stream-index: "003.001"
      required:
      - storage_type
      - bucket
      title: ExternalStorageRequest
      type: object
    UpdateExternalStorageResponse:
      description: Basic response information
      nullable: true
      properties:
        bucket:
          type: string
          x-stream-index: "001.003"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        name:
          type: string
          x-stream-index: "001.001"
        path:
          type: string
          x-stream-index: "001.004"
        type:
          enum:
          - s3
          - gcs
          - abs
          type: string
          x-stream-index: "001.002"
      required:
      - name
      - type
      - bucket
      - path
      - duration
      title: Response
      type: object
    UpdateLiveLocationRequest:
      nullable: true
      properties:
        end_at:
          description: Time when the live location expires
          format: date-time
          title: string
          type: number
          x-stream-index: "004"
        latitude:
          description: Latitude coordinate
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          title: number
          type: number
          x-stream-index: "002"
        longitude:
          description: Longitude coordinate
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          title: number
          type: number
          x-stream-index: "003"
        message_id:
          description: Live location ID
          title: string
          type: string
          x-stream-index: "001"
      required:
      - message_id
      type: object
    UpdatePollOptionRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "004"
        id:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
        text:
          description: Option text
          title: string
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "005.002"
        user_id:
          type: string
          x-stream-index: "005.001"
      required:
      - id
      - text
      type: object
    UpdatePollPartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          description: Sets new field values
          title: Set
          type: object
          x-stream-index: "002.001"
          x-stream-map:
            description: New value to set
            key: field
            title: Value
        unset:
          description: Array of field names to unset
          items:
            type: string
          title: Unset
          type: array
          x-stream-index: "002.002"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      type: object
    UpdatePollRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "011"
        allow_answers:
          description: Allow answers
          title: boolean
          type: boolean
          x-stream-index: "009"
        allow_user_suggested_options:
          description: Allow user suggested options
          title: boolean
          type: boolean
          x-stream-index: "008"
        description:
          description: Poll description
          title: string
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          description: Enforce unique vote
          title: boolean
          type: boolean
          x-stream-index: "005"
        id:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
        is_closed:
          description: Is closed
          title: boolean
          type: boolean
          x-stream-index: "010"
        max_votes_allowed:
          description: Max votes allowed
          format: int32
          maximum: 10
          title: integer
          type: integer
          x-stream-index: "007"
        name:
          description: Poll name
          title: string
          type: string
          x-stream-index: "002"
        options:
          description: Poll options
          items:
            $ref: '#/components/schemas/PollOptionRequest'
          maximum: 100
          title: PollOptions
          type: array
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "012.002"
        user_id:
          type: string
          x-stream-index: "012.001"
        voting_visibility:
          description: Voting visibility
          enum:
          - anonymous
          - public
          title: string
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      type: object
    UpdateUserPartialRequest:
      properties:
        id:
          description: User ID to update
          title: ID
          type: string
          x-stream-index: "001"
        set:
          additionalProperties: {}
          type: object
          x-stream-index: "002.001"
        unset:
          items:
            type: string
          type: array
          x-stream-index: "002.002"
      required:
      - id
      type: object
    UpdateUserPermissionsRequest:
      nullable: true
      properties:
        grant_permissions:
          items:
            type: string
          type: array
          x-stream-index: "002"
        revoke_permissions:
          items:
            type: string
          type: array
          x-stream-index: "003"
        user_id:
          type: string
          x-stream-index: "001"
      required:
      - user_id
      type: object
    UpdateUserPermissionsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    UpdateUsersPartialRequest:
      nullable: true
      properties:
        users:
          items:
            $ref: '#/components/schemas/UpdateUserPartialRequest'
          maximum: 100
          type: array
          x-stream-index: "001"
      required:
      - users
      type: object
    UpdateUsersRequest:
      nullable: true
      properties:
        users:
          additionalProperties:
            $ref: '#/components/schemas/UserRequest'
          description: Object containing users
          title: Users
          type: object
          x-stream-index: "001"
          x-stream-map:
            key: user_id
      required:
      - users
      type: object
    UpdateUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        membership_deletion_task_id:
          type: string
          x-stream-index: "002"
        users:
          additionalProperties:
            $ref: '#/components/schemas/FullUserResponse'
          description: Object containing users
          title: Users
          type: object
          x-stream-index: "001"
          x-stream-map:
            key: user_id
      required:
      - users
      - membership_deletion_task_id
      - duration
      type: object
    UpdatedCallPermissionsEvent:
      description: This event is sent to notify about permission changes for a user,
        clients receiving this event should update their UI accordingly
      properties:
        call_cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.002"
        own_capabilities:
          description: The capabilities of the current user
          items:
            $ref: '#/components/schemas/OwnCapability'
          title: Own capabilities
          type: array
          x-stream-index: "004"
        type:
          default: call.permissions_updated
          description: 'The type of event: "call.permissions_updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The user who received the new permissions
          title: User
          x-stream-index: "003"
      required:
      - type
      - created_at
      - call_cid
      - user
      - own_capabilities
      title: UpdatedCallPermissionsEvent
      type: object
      x-stream-event-call-type: true
      x-stream-event-doc-group: call
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UpsertPushPreferencesRequest:
      nullable: true
      properties:
        preferences:
          description: A list of push preferences for channels, calls, or the user.
          items:
            $ref: '#/components/schemas/PushPreferenceInput'
          type: array
          x-stream-index: "001"
      required:
      - preferences
      type: object
    UpsertPushPreferencesResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        user_channel_preferences:
          additionalProperties:
            additionalProperties:
              $ref: '#/components/schemas/ChannelPushPreferences'
            type: object
          description: The channel specific push notification preferences, only returned
            for channels you've edited.
          title: User Channel Notification Preferences
          type: object
          x-stream-index: "002"
        user_preferences:
          additionalProperties:
            $ref: '#/components/schemas/PushPreferences'
          description: The user preferences, always returned regardless if you edited
            it
          title: User Preferences
          type: object
          x-stream-index: "001"
      required:
      - user_preferences
      - user_channel_preferences
      - duration
      type: object
    UpsertPushProviderRequest:
      nullable: true
      properties:
        push_provider:
          $ref: '#/components/schemas/PushProvider'
          x-stream-index: "001"
      type: object
    UpsertPushProviderResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        push_provider:
          $ref: '#/components/schemas/PushProviderResponse'
          x-stream-index: "001"
      required:
      - push_provider
      - duration
      title: Response
      type: object
    UpsertPushTemplateRequest:
      nullable: true
      properties:
        enable_push:
          description: Whether to send push notification for this event
          title: boolean
          type: boolean
          x-stream-index: "002"
        event_type:
          description: Event type (message.new, message.updated, reaction.new)
          enum:
          - message.new
          - message.updated
          - reaction.new
          - notification.reminder_due
          - feeds.activity.added
          - feeds.comment.added
          - feeds.activity.reaction.added
          - feeds.comment.reaction.added
          - feeds.follow.created
          - feeds.notification_feed.updated
          title: string
          type: string
          x-stream-index: "003"
        push_provider_name:
          description: Push provider name
          title: string
          type: string
          x-stream-index: "004"
        push_provider_type:
          description: Push provider type (firebase, apn)
          enum:
          - firebase
          - apn
          title: string
          type: string
          x-stream-index: "005"
        template:
          description: Push template
          title: string
          type: string
          x-stream-index: "006"
      required:
      - event_type
      - push_provider_type
      type: object
    UpsertPushTemplateResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        template:
          $ref: '#/components/schemas/PushTemplate'
          x-stream-index: "002"
      required:
      - duration
      title: Response
      type: object
    User:
      properties:
        avg_response_time:
          format: int32
          readOnly: true
          type: integer
          x-stream-index: "046"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "017"
        banned:
          type: boolean
          x-stream-index: "016"
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deactivated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "014"
        deleted_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "013"
        id:
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "023"
        language:
          type: string
          x-stream-index: "035"
        last_active:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "011"
        last_engaged_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "012"
        online:
          readOnly: true
          type: boolean
          x-stream-index: "022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "026"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "042"
        role:
          type: string
          x-stream-index: "004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "005"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "009"
      required:
      - id
      - role
      - teams_role
      - custom
      - banned
      - online
      type: object
    UserBannedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "006.002"
        channel_type:
          type: string
          x-stream-index: "006.003"
        cid:
          type: string
          x-stream-index: "006.001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008.002"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
        expiration:
          format: date-time
          type: number
          x-stream-index: "003"
        reason:
          type: string
          x-stream-index: "004"
        shadow:
          type: boolean
          x-stream-index: "002"
        team:
          type: string
          x-stream-index: "005.001"
        type:
          default: user.banned
          type: string
          x-stream-index: "008.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "007.001"
      required:
      - created_by
      - shadow
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: UserBannedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserDeactivatedEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.002"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
        type:
          default: user.deactivated
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - created_by
      - type
      - created_at
      title: UserDeactivatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserFeedbackReport:
      properties:
        count_by_rating:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "001"
        unreported_count:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - count_by_rating
      - unreported_count
      type: object
    UserFeedbackReportResponse:
      properties:
        daily:
          items:
            $ref: '#/components/schemas/DailyAggregateUserFeedbackReportResponse'
          type: array
          x-stream-index: "001"
      required:
      - daily
      type: object
    UserFeedbackResponse:
      properties:
        cid:
          type: string
          x-stream-index: "001"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "009"
        platform:
          $ref: '#/components/schemas/PlatformDataResponse'
          x-stream-index: "008"
        rating:
          format: int32
          type: integer
          x-stream-index: "004"
        reason:
          type: string
          x-stream-index: "005"
        sdk:
          type: string
          x-stream-index: "006"
        sdk_version:
          type: string
          x-stream-index: "007"
        session_id:
          type: string
          x-stream-index: "002"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - cid
      - session_id
      - user_id
      - rating
      - reason
      - sdk
      - sdk_version
      - platform
      type: object
    UserMuteResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004"
        expires:
          format: date-time
          type: number
          x-stream-index: "003"
        target:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    UserMutedEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004.002"
        target_user:
          type: string
          x-stream-index: "001"
        target_users:
          items:
            type: string
          type: array
          x-stream-index: "002"
        type:
          default: user.muted
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      title: UserMutedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserRatingReportResponse:
      properties:
        average:
          format: float
          type: number
          x-stream-index: "002"
        count:
          format: int32
          type: integer
          x-stream-index: "001"
      required:
      - count
      - average
      type: object
    UserReactivatedEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        type:
          default: user.reactivated
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
      required:
      - type
      - created_at
      title: UserReactivatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserRequest:
      description: User request object
      properties:
        custom:
          additionalProperties: {}
          description: Custom user data
          title: Custom
          type: object
          x-stream-index: "004"
        id:
          description: User ID
          title: ID
          type: string
          x-stream-index: "001"
        image:
          description: User's profile image URL
          title: Image
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "006"
        language:
          type: string
          x-stream-index: "005"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "002"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "007"
        role:
          description: User's global role
          title: Role
          type: string
          x-stream-index: "008"
        teams:
          description: List of teams the user belongs to
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "010"
        teams_role:
          additionalProperties:
            type: string
          description: Map of team-specific roles for the user
          title: TeamsRole
          type: object
          x-stream-index: "009"
      required:
      - id
      title: UserRequest
      type: object
    UserResponse:
      description: User response object
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        ban_expires:
          description: Date when ban expires
          format: date-time
          title: Ban expires
          type: number
          x-stream-index: "003"
        banned:
          description: Whether a user is banned or not
          title: Banned
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          description: Date of deactivation
          format: date-time
          title: Deactivated at
          type: number
          x-stream-index: "001.016"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "001.011"
        devices:
          description: List of devices user is using
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "006"
        id:
          description: Unique user identifier
          title: ID
          type: string
          x-stream-index: "001.001"
        image:
          title: Image
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "007"
        language:
          description: Preferred language of a user
          title: Language
          type: string
          x-stream-index: "001.005"
        last_active:
          description: Date of last activity
          format: date-time
          title: Last active
          type: number
          x-stream-index: "001.014"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "001.002"
        online:
          description: Whether a user online or not
          title: Online
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          description: User privacy settings
          title: Privacy settings
          x-stream-index: "005"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationSettingsResponse'
          description: User push notification settings
          title: Push notifications
          x-stream-index: "004"
        revoke_tokens_issued_before:
          description: Revocation date for tokens
          format: date-time
          title: Revoke tokens issued before
          type: number
          x-stream-index: "001.015"
        role:
          description: Determines the set of user permissions
          title: Role
          type: string
          x-stream-index: "001.006"
        shadow_banned:
          description: Whether a user is shadow banned
          title: Shadow banned
          type: boolean
          x-stream-index: "002"
        teams:
          description: List of teams user is a part of
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      title: UserResponse
      type: object
    UserResponsePrivacyFields:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: number
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "001.011"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "003"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: number
          x-stream-index: "001.014"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "002"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      type: object
    UserUpdatedEvent:
      description: This event is sent when a user gets updated. The event contains
        information about the updated user.
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        type:
          default: user.updated
          description: 'The type of event: "user.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.002"
        user:
          $ref: '#/components/schemas/UserResponsePrivacyFields'
          description: The updated user
          title: User
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - custom
      - user
      title: UserUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    VideoReactionOverTimeResponse:
      properties:
        by_minute:
          items:
            $ref: '#/components/schemas/CountByMinuteResponse'
          type: array
          x-stream-index: "001"
      type: object
    VideoReactionsResponse:
      nullable: true
      properties:
        count_over_time:
          $ref: '#/components/schemas/VideoReactionOverTimeResponse'
          x-stream-index: "002"
        reaction:
          type: string
          x-stream-index: "001"
      required:
      - reaction
      type: object
    VideoSettings:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        camera_default_on:
          type: boolean
          x-stream-index: "004"
        camera_facing:
          enum:
          - front
          - back
          - external
          type: string
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      - target_resolution
      - camera_default_on
      - camera_facing
      type: object
    VideoSettingsRequest:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        camera_default_on:
          type: boolean
          x-stream-index: "004"
        camera_facing:
          enum:
          - front
          - back
          - external
          type: string
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      type: object
    VideoSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        camera_default_on:
          type: boolean
          x-stream-index: "004"
        camera_facing:
          enum:
          - front
          - back
          - external
          type: string
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      - target_resolution
      - camera_default_on
      - camera_facing
      type: object
    WHIPIngress:
      properties:
        address:
          description: URL for a new whip input, every time a new link is created
          title: Address
          type: string
          x-stream-index: "001"
      required:
      - address
      title: WHIPIngress
      type: object
    WebhookEvent:
      description: The discriminator object for all webhook events, it maps events'
        payload to the final type
      discriminator:
        mapping:
          call.accepted: '#/components/schemas/CallAcceptedEvent'
          call.blocked_user: '#/components/schemas/BlockedUserEvent'
          call.closed_caption: '#/components/schemas/ClosedCaptionEvent'
          call.closed_captions_failed: '#/components/schemas/CallClosedCaptionsFailedEvent'
          call.closed_captions_started: '#/components/schemas/CallClosedCaptionsStartedEvent'
          call.closed_captions_stopped: '#/components/schemas/CallClosedCaptionsStoppedEvent'
          call.created: '#/components/schemas/CallCreatedEvent'
          call.deleted: '#/components/schemas/CallDeletedEvent'
          call.ended: '#/components/schemas/CallEndedEvent'
          call.frame_recording_failed: '#/components/schemas/CallFrameRecordingFailedEvent'
          call.frame_recording_ready: '#/components/schemas/CallFrameRecordingFrameReadyEvent'
          call.frame_recording_started: '#/components/schemas/CallFrameRecordingStartedEvent'
          call.frame_recording_stopped: '#/components/schemas/CallFrameRecordingStoppedEvent'
          call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
          call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
          call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
          call.kicked_user: '#/components/schemas/KickedUserEvent'
          call.live_started: '#/components/schemas/CallLiveStartedEvent'
          call.member_added: '#/components/schemas/CallMemberAddedEvent'
          call.member_removed: '#/components/schemas/CallMemberRemovedEvent'
          call.member_updated: '#/components/schemas/CallMemberUpdatedEvent'
          call.member_updated_permission: '#/components/schemas/CallMemberUpdatedPermissionEvent'
          call.missed: '#/components/schemas/CallMissedEvent'
          call.moderation_blur: '#/components/schemas/CallModerationBlurEvent'
          call.moderation_warning: '#/components/schemas/CallModerationWarningEvent'
          call.notification: '#/components/schemas/CallNotificationEvent'
          call.permission_request: '#/components/schemas/PermissionRequestEvent'
          call.permissions_updated: '#/components/schemas/UpdatedCallPermissionsEvent'
          call.reaction_new: '#/components/schemas/CallReactionEvent'
          call.recording_failed: '#/components/schemas/CallRecordingFailedEvent'
          call.recording_ready: '#/components/schemas/CallRecordingReadyEvent'
          call.recording_started: '#/components/schemas/CallRecordingStartedEvent'
          call.recording_stopped: '#/components/schemas/CallRecordingStoppedEvent'
          call.rejected: '#/components/schemas/CallRejectedEvent'
          call.ring: '#/components/schemas/CallRingEvent'
          call.rtmp_broadcast_failed: '#/components/schemas/CallRtmpBroadcastFailedEvent'
          call.rtmp_broadcast_started: '#/components/schemas/CallRtmpBroadcastStartedEvent'
          call.rtmp_broadcast_stopped: '#/components/schemas/CallRtmpBroadcastStoppedEvent'
          call.session_ended: '#/components/schemas/CallSessionEndedEvent'
          call.session_participant_count_updated: '#/components/schemas/CallSessionParticipantCountsUpdatedEvent'
          call.session_participant_joined: '#/components/schemas/CallSessionParticipantJoinedEvent'
          call.session_participant_left: '#/components/schemas/CallSessionParticipantLeftEvent'
          call.session_started: '#/components/schemas/CallSessionStartedEvent'
          call.stats_report_ready: '#/components/schemas/CallStatsReportReadyEvent'
          call.transcription_failed: '#/components/schemas/CallTranscriptionFailedEvent'
          call.transcription_ready: '#/components/schemas/CallTranscriptionReadyEvent'
          call.transcription_started: '#/components/schemas/CallTranscriptionStartedEvent'
          call.transcription_stopped: '#/components/schemas/CallTranscriptionStoppedEvent'
          call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
          call.updated: '#/components/schemas/CallUpdatedEvent'
          call.user_feedback_submitted: '#/components/schemas/CallUserFeedbackSubmittedEvent'
          call.user_muted: '#/components/schemas/CallUserMutedEvent'
          custom: '#/components/schemas/CustomVideoEvent'
          export.channels.error: '#/components/schemas/AsyncExportErrorEvent'
          export.channels.success: '#/components/schemas/AsyncExportChannelsEvent'
          export.users.error: '#/components/schemas/AsyncExportErrorEvent'
          export.users.success: '#/components/schemas/AsyncExportUsersEvent'
          user.banned: '#/components/schemas/UserBannedEvent'
          user.deactivated: '#/components/schemas/UserDeactivatedEvent'
          user.muted: '#/components/schemas/UserMutedEvent'
          user.reactivated: '#/components/schemas/UserReactivatedEvent'
          user.updated: '#/components/schemas/UserUpdatedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AsyncExportChannelsEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportUsersEvent'
      - $ref: '#/components/schemas/BlockedUserEvent'
      - $ref: '#/components/schemas/CallAcceptedEvent'
      - $ref: '#/components/schemas/CallClosedCaptionsFailedEvent'
      - $ref: '#/components/schemas/CallClosedCaptionsStartedEvent'
      - $ref: '#/components/schemas/CallClosedCaptionsStoppedEvent'
      - $ref: '#/components/schemas/CallCreatedEvent'
      - $ref: '#/components/schemas/CallDeletedEvent'
      - $ref: '#/components/schemas/CallEndedEvent'
      - $ref: '#/components/schemas/CallFrameRecordingFailedEvent'
      - $ref: '#/components/schemas/CallFrameRecordingFrameReadyEvent'
      - $ref: '#/components/schemas/CallFrameRecordingStartedEvent'
      - $ref: '#/components/schemas/CallFrameRecordingStoppedEvent'
      - $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
      - $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
      - $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
      - $ref: '#/components/schemas/CallLiveStartedEvent'
      - $ref: '#/components/schemas/CallMemberAddedEvent'
      - $ref: '#/components/schemas/CallMemberRemovedEvent'
      - $ref: '#/components/schemas/CallMemberUpdatedEvent'
      - $ref: '#/components/schemas/CallMemberUpdatedPermissionEvent'
      - $ref: '#/components/schemas/CallMissedEvent'
      - $ref: '#/components/schemas/CallModerationBlurEvent'
      - $ref: '#/components/schemas/CallModerationWarningEvent'
      - $ref: '#/components/schemas/CallNotificationEvent'
      - $ref: '#/components/schemas/CallReactionEvent'
      - $ref: '#/components/schemas/CallRecordingFailedEvent'
      - $ref: '#/components/schemas/CallRecordingReadyEvent'
      - $ref: '#/components/schemas/CallRecordingStartedEvent'
      - $ref: '#/components/schemas/CallRecordingStoppedEvent'
      - $ref: '#/components/schemas/CallRejectedEvent'
      - $ref: '#/components/schemas/CallRingEvent'
      - $ref: '#/components/schemas/CallRtmpBroadcastFailedEvent'
      - $ref: '#/components/schemas/CallRtmpBroadcastStartedEvent'
      - $ref: '#/components/schemas/CallRtmpBroadcastStoppedEvent'
      - $ref: '#/components/schemas/CallSessionEndedEvent'
      - $ref: '#/components/schemas/CallSessionParticipantCountsUpdatedEvent'
      - $ref: '#/components/schemas/CallSessionParticipantJoinedEvent'
      - $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
      - $ref: '#/components/schemas/CallSessionStartedEvent'
      - $ref: '#/components/schemas/CallStatsReportReadyEvent'
      - $ref: '#/components/schemas/CallTranscriptionFailedEvent'
      - $ref: '#/components/schemas/CallTranscriptionReadyEvent'
      - $ref: '#/components/schemas/CallTranscriptionStartedEvent'
      - $ref: '#/components/schemas/CallTranscriptionStoppedEvent'
      - $ref: '#/components/schemas/CallUpdatedEvent'
      - $ref: '#/components/schemas/CallUserFeedbackSubmittedEvent'
      - $ref: '#/components/schemas/CallUserMutedEvent'
      - $ref: '#/components/schemas/ClosedCaptionEvent'
      - $ref: '#/components/schemas/CustomVideoEvent'
      - $ref: '#/components/schemas/KickedUserEvent'
      - $ref: '#/components/schemas/PermissionRequestEvent'
      - $ref: '#/components/schemas/UnblockedUserEvent'
      - $ref: '#/components/schemas/UpdatedCallPermissionsEvent'
      - $ref: '#/components/schemas/UserBannedEvent'
      - $ref: '#/components/schemas/UserDeactivatedEvent'
      - $ref: '#/components/schemas/UserMutedEvent'
      - $ref: '#/components/schemas/UserReactivatedEvent'
      - $ref: '#/components/schemas/UserUpdatedEvent'
    XiaomiConfig:
      properties:
        Disabled:
          type: boolean
          writeOnly: true
          x-stream-index: "003"
        package_name:
          type: string
          x-stream-index: "001"
        secret:
          type: string
          x-stream-index: "002"
      type: object
    XiaomiConfigFields:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        package_name:
          type: string
          x-stream-index: "002"
        secret:
          type: string
          x-stream-index: "003"
      required:
      - enabled
      type: object
  securitySchemes:
    JWT:
      description: |
        JWT should be always provided when stream-auth-type=jwt.

        Using JWT auth request could be authenticated as user or as server-side.

        When using user authentication permission checking is going to be applied to requests based on the user that is
        performing a request.

        The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform
        requests.

        **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not
        shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.
        If you wish, you can configure your application to ignore authentication (see `disable_auth_check`)
        The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.
      in: header
      name: Authorization
      type: apiKey
    api_key:
      description: Application API key should be always set in order to authenticate
        the request.
      in: query
      name: api_key
      type: apiKey
    stream-auth-type:
      description: |-
        Stream-Auth-Type should be always set in order to authenticate the request. Possible
        values: `jwt` or `anonymous`.

        `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization
        header.

        `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available
        to anonymous users.
      in: header
      name: Stream-Auth-Type
      type: apiKey
info:
  title: Stream API
  version: v198.13.0
openapi: 3.0.3
paths:
  /api/v2/app:
    get:
      description: |
        This Method returns the application settings
      operationId: GetApp
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get App Settings
      tags:
      - product:common
    patch:
      description: |
        This Method updates one or more application settings
      operationId: UpdateApp
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAppRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update App Settings
      tags:
      - product:common
  /api/v2/blocklists:
    get:
      description: |
        Returns all available block lists
      operationId: ListBlockLists
      parameters:
      - in: query
        name: team
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List block lists
      tags:
      - product:common
    post:
      description: |
        Creates a new application blocklist, once created the blocklist can be used by any channel type
      operationId: CreateBlockList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBlockListRequest'
        description: Block list
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create block list
      tags:
      - product:common
  /api/v2/blocklists/{name}:
    delete:
      description: |
        Deletes previously created application blocklist
      operationId: DeleteBlockList
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: team
        schema:
          type: string
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete block list
      tags:
      - product:common
    get:
      description: |
        Returns block list by given name
      operationId: GetBlockList
      parameters:
      - in: path
        name: name
        required: true
        schema:
          description: Block list name
          title: Name
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: team
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBlockListResponse'
          description: GetBlockListResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get block list
      tags:
      - product:common
    put:
      description: |
        Updates contents of the block list
      operationId: UpdateBlockList
      parameters:
      - in: path
        name: name
        required: true
        schema:
          description: Block list name
          title: Name
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBlockListRequest'
        description: Update block list
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update block list
      tags:
      - product:common
  /api/v2/check_push:
    post:
      description: |
        Sends a test message via push, this is a test endpoint to verify your push settings
      operationId: CheckPush
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckPushRequest'
        description: CheckPushRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckPushResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Check push
      tags:
      - product:common
  /api/v2/check_sns:
    post:
      description: |
        Validates Amazon SNS configuration
      operationId: CheckSNS
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckSNSRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckSNSResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Check SNS
      tags:
      - product:common
  /api/v2/check_sqs:
    post:
      description: |
        Validates Amazon SQS credentials
      operationId: CheckSQS
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckSQSRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckSQSResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Check SQS
      tags:
      - product:common
  /api/v2/devices:
    delete:
      description: |
        Deletes one device
      operationId: DeleteDevice
      parameters:
      - in: query
        name: id
        required: true
        schema:
          description: Device ID to delete
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: user_id
        schema:
          description: '**Server-side only**. User ID which server acts upon'
          title: User ID
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete device
      tags:
      - product:common
    get:
      description: |
        Returns all available devices
      operationId: ListDevices
      parameters:
      - in: query
        name: user_id
        schema:
          description: '**Server-side only**. User ID which server acts upon'
          title: User ID
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
          description: ListDevicesResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List devices
      tags:
      - product:common
    post:
      description: |
        Adds a new device to a user, if the same device already exists the call will have no effect
      operationId: CreateDevice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeviceRequest'
        description: CreateDeviceRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create device
      tags:
      - product:common
  /api/v2/export/users:
    post:
      description: |
        Exports user profile, reactions and messages for list of given users
      operationId: ExportUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportUsersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Export users
      tags:
      - product:common
  /api/v2/external_storage:
    get:
      description: |
        Lists external storage
      operationId: ListExternalStorage
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExternalStorageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List external storage
      tags:
      - product:common
    post:
      description: |
        Creates new external storage
      operationId: CreateExternalStorage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExternalStorageRequest'
        description: CreateExternalStorageRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateExternalStorageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create external storage
      tags:
      - product:common
  /api/v2/external_storage/{name}:
    delete:
      description: |
        Deletes external storage
      operationId: DeleteExternalStorage
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteExternalStorageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete external storage
      tags:
      - product:common
    put:
      description: |2+

      operationId: UpdateExternalStorage
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExternalStorageRequest'
        description: ExternalStorageRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateExternalStorageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update External Storage
      tags:
      - product:common
  /api/v2/external_storage/{name}/check:
    get:
      description: |2+

      operationId: CheckExternalStorage
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckExternalStorageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Check External Storage
      tags:
      - product:common
  /api/v2/guest:
    post:
      description: |2+

      operationId: CreateGuest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGuestRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGuestResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create Guest
      tags:
      - product:common
  /api/v2/import_urls:
    post:
      description: |
        Creates a new import URL
      operationId: CreateImportURL
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImportURLRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateImportURLResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create import URL
      tags:
      - product:common
  /api/v2/imports:
    get:
      description: |
        Gets an import
      operationId: ListImports
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImportsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get import
      tags:
      - product:common
    post:
      description: |
        Creates a new import
      operationId: CreateImport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImportRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateImportResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create import
      tags:
      - product:common
  /api/v2/imports/{id}:
    get:
      description: |
        Gets an import
      operationId: GetImport
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetImportResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get import
      tags:
      - product:common
  /api/v2/og:
    get:
      description: |
        Get an OpenGraph attachment for a link
      operationId: GetOG
      parameters:
      - in: query
        name: url
        required: true
        schema:
          description: URL to be scraped
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOGResponse'
          description: Get OG Attachment
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get OG
      tags:
      - product:common
  /api/v2/permissions:
    get:
      description: |
        Lists all available permissions
      operationId: ListPermissions
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPermissionsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List permissions
      tags:
      - product:common
  /api/v2/permissions/{id}:
    get:
      description: |
        Gets custom permission
      operationId: GetPermission
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Permission ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCustomPermissionResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get permission
      tags:
      - product:common
  /api/v2/polls:
    post:
      description: |
        Creates a new poll
      operationId: CreatePoll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePollRequest'
        description: Create Poll Request
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create poll
      tags:
      - product:common
    put:
      description: |
        Updates a poll

        Sends events:
        - feeds.poll.closed
        - feeds.poll.updated
        - poll.closed
        - poll.updated
      operationId: UpdatePoll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update poll
      tags:
      - product:common
  /api/v2/polls/{poll_id}:
    delete:
      description: |
        Deletes a poll

        Sends events:
        - feeds.poll.deleted
        - poll.deleted
      operationId: DeletePoll
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete poll
      tags:
      - product:common
    get:
      description: |
        Retrieves a poll
      operationId: GetPoll
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get poll
      tags:
      - product:common
    patch:
      description: |
        Updates a poll partially

        Sends events:
        - feeds.poll.closed
        - feeds.poll.updated
        - poll.closed
        - poll.updated
      operationId: UpdatePollPartial
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollPartialRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partial update poll
      tags:
      - product:common
  /api/v2/polls/{poll_id}/options:
    post:
      description: |
        Creates a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: CreatePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePollOptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create poll option
      tags:
      - product:common
    put:
      description: |
        Updates a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: UpdatePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollOptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update poll option
      tags:
      - product:common
  /api/v2/polls/{poll_id}/options/{option_id}:
    delete:
      description: |
        Deletes a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: DeletePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: path
        name: option_id
        required: true
        schema:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "003"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete poll option
      tags:
      - product:common
    get:
      description: |
        Retrieves a poll option
      operationId: GetPollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: path
        name: option_id
        required: true
        schema:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "003"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get poll option
      tags:
      - product:common
  /api/v2/polls/{poll_id}/votes:
    post:
      description: |
        Queries votes
      operationId: QueryPollVotes
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryPollVotesRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollVotesResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query votes
      tags:
      - product:common
  /api/v2/polls/query:
    post:
      description: |
        Queries polls
      operationId: QueryPolls
      parameters:
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryPollsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPollsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query polls
      tags:
      - product:common
  /api/v2/push_preferences:
    post:
      description: |
        Upserts the push preferences for a user and or channel member. Set to all, mentions or none
      operationId: UpdatePushNotificationPreferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPushPreferencesRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertPushPreferencesResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Push notification preferences
      tags:
      - product:common
  /api/v2/push_providers:
    get:
      description: |
        List details of all push providers.
      operationId: ListPushProviders
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPushProvidersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List push providers
      tags:
      - product:common
    post:
      description: |
        Upsert a push provider for v2 with multi bundle/package support
      operationId: UpsertPushProvider
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPushProviderRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertPushProviderResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upsert a push provider
      tags:
      - product:common
  /api/v2/push_providers/{type}/{name}:
    delete:
      description: |
        Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint
      operationId: DeletePushProvider
      parameters:
      - in: path
        name: type
        required: true
        schema:
          enum:
          - apn
          - firebase
          - huawei
          - xiaomi
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: name
        required: true
        schema:
          maxLength: 36
          minLength: 1
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete a push provider
      tags:
      - product:common
  /api/v2/push_templates:
    get:
      description: |
        Retrieve push notification templates for Chat.
      operationId: GetPushTemplates
      parameters:
      - in: query
        name: push_provider_name
        schema:
          description: Push provider name to filter templates
          title: string
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: push_provider_type
        required: true
        schema:
          description: Push provider type (firebase, apn) to filter templates
          enum:
          - firebase
          - apn
          title: string
          type: string
          writeOnly: true
          x-stream-index: "003"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPushTemplatesResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get push notification templates
      tags:
      - product:common
    post:
      description: |
        Create or update a push notification template for a specific event type and push provider
      operationId: UpsertPushTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPushTemplateRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertPushTemplateResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upsert a push notification template
      tags:
      - product:common
  /api/v2/rate_limits:
    get:
      description: |
        Get rate limits usage and quotas
      operationId: GetRateLimits
      parameters:
      - in: query
        name: server_side
        schema:
          description: Whether to include server-side platform limits or not
          title: Server-side
          type: boolean
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: android
        schema:
          description: Whether to include Android platform limits or not
          title: Android
          type: boolean
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: ios
        schema:
          description: Whether to include iOS platform limits or not
          title: iOS
          type: boolean
          writeOnly: true
          x-stream-index: "003"
      - in: query
        name: web
        schema:
          description: Whether to include web platform limits or not
          title: Web
          type: boolean
          writeOnly: true
          x-stream-index: "004"
      - in: query
        name: endpoints
        schema:
          description: Specific endpoints to show limits for, as a comma-separated
            list of values
          title: Endpoints
          type: string
          writeOnly: true
          x-stream-index: "005"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRateLimitsResponse'
          description: Get Rate Limits Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get rate limits
      tags:
      - product:common
  /api/v2/roles:
    get:
      description: |
        Lists all available roles
      operationId: ListRoles
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRolesResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List roles
      tags:
      - product:common
    post:
      description: |
        Creates custom role
      operationId: CreateRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoleRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRoleResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create role
      tags:
      - product:common
  /api/v2/roles/{name}:
    delete:
      description: |
        Deletes custom role
      operationId: DeleteRole
      parameters:
      - in: path
        name: name
        required: true
        schema:
          description: Role name
          title: Name
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete role
      tags:
      - product:common
  /api/v2/tasks/{id}:
    get:
      description: |
        Gets status of a task
      operationId: GetTask
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Task ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTaskResponse'
          description: Get Task Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get status of a task
      tags:
      - product:common
  /api/v2/uploads/file:
    delete:
      description: |
        Deletes previously uploaded file
      operationId: DeleteFile
      parameters:
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete file
      tags:
      - product:common
    post:
      description: |
        Uploads file
      operationId: UploadFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileUploadRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUploadResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upload file
      tags:
      - product:common
  /api/v2/uploads/image:
    delete:
      description: |
        Deletes previously uploaded image
      operationId: DeleteImage
      parameters:
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete image
      tags:
      - product:common
    post:
      description: |
        Uploads image
      operationId: UploadImage
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImageUploadRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageUploadResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upload image
      tags:
      - product:common
  /api/v2/users:
    get:
      description: |
        Find and filter users
      operationId: QueryUsers
      parameters:
      - content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryUsersPayload'
              x-stream-index: "001"
        in: query
        name: payload
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query users
      tags:
      - product:common
    patch:
      description: |
        Updates certain fields of the user

        Sends events:
        - user.presence.changed
        - user.updated
        - user.presence.changed
      operationId: UpdateUsersPartial
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUsersPartialRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partially update user
      tags:
      - product:common
    post:
      description: |
        Update or create users in bulk

        Sends events:
        - user.updated
      operationId: UpdateUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upsert users
      tags:
      - product:common
  /api/v2/users/{user_id}/deactivate:
    post:
      description: |
        Deactivates user with possibility to activate it back

        Sends events:
        - user.deactivated
      operationId: DeactivateUser
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          title: User ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeactivateUserRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeactivateUserResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Deactivate user
      tags:
      - product:common
  /api/v2/users/{user_id}/export:
    get:
      description: |
        Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
      operationId: ExportUser
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          title: User ID
          type: string
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportUserResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Export user
      tags:
      - product:common
  /api/v2/users/{user_id}/reactivate:
    post:
      description: |
        Activates user who's been deactivated previously

        Sends events:
        - user.reactivated
      operationId: ReactivateUser
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          title: User ID
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReactivateUserRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReactivateUserResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Reactivate user
      tags:
      - product:common
  /api/v2/users/block:
    get:
      description: |
        Get list of blocked Users
      operationId: GetBlockedUsers
      parameters:
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBlockedUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get list of blocked Users
      tags:
      - product:common
    post:
      description: |
        Block users
      operationId: BlockUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Block user
      tags:
      - product:common
  /api/v2/users/deactivate:
    post:
      description: |
        Deactivate users in batches

        Sends events:
        - user.deactivated
      operationId: DeactivateUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeactivateUsersRequest'
        description: DeactivateUsersRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeactivateUsersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Deactivate users
      tags:
      - product:common
  /api/v2/users/delete:
    post:
      description: |
        Deletes users and optionally all their belongings asynchronously.

        Sends events:
        - channel.deleted
        - user.deleted
      operationId: DeleteUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete Users
      tags:
      - product:common
  /api/v2/users/live_locations:
    get:
      description: |
        Retrieves all active live locations for a user
      operationId: GetUserLiveLocations
      parameters:
      - in: query
        name: user_id
        schema:
          description: User ID to get live locations for. If not provided, returns
            live locations for the authenticated user.
          title: string
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedLocationsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get user live locations
      tags:
      - product:common
    put:
      description: |
        Updates an existing live location with new coordinates or expiration time
      operationId: UpdateLiveLocation
      parameters:
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "005.001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveLocationRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedLocationResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update live location
      tags:
      - product:common
  /api/v2/users/reactivate:
    post:
      description: |
        Reactivate users in batches

        Sends events:
        - user.reactivated
        - user.reactivated
      operationId: ReactivateUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReactivateUsersRequest'
        description: ReactivateUsersRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReactivateUsersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Reactivate users
      tags:
      - product:common
  /api/v2/users/restore:
    post:
      description: |
        Restore soft deleted users
      operationId: RestoreUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Restore users
      tags:
      - product:common
  /api/v2/users/unblock:
    post:
      description: |
        Unblock users
      operationId: UnblockUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnblockUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Unblock user
      tags:
      - product:common
  /api/v2/video/active_calls_status:
    get:
      description: |
        Get the current status of all active calls including metrics and summary information
      operationId: GetActiveCallsStatus
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetActiveCallsStatusResponse'
          description: GetActiveCallsStatusResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get active calls status
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}:
    get:
      description: |2+

      operationId: GetCall
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: query
        name: members_limit
        schema:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          writeOnly: true
          x-stream-index: "004"
      - in: query
        name: ring
        schema:
          type: boolean
          writeOnly: true
          x-stream-index: "005"
      - in: query
        name: notify
        schema:
          type: boolean
          writeOnly: true
          x-stream-index: "006"
      - in: query
        name: video
        schema:
          type: boolean
          writeOnly: true
          x-stream-index: "007"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallResponse'
          description: GetCallResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get Call
      tags:
      - product:video
    patch:
      description: |2


        Sends events:
        - call.updated
      operationId: UpdateCall
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCallRequest'
        description: UpdateCallRequest
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCallResponse'
          description: UpdateCallResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update Call
      tags:
      - product:video
    post:
      description: |
        Gets or creates a new call

        Sends events:
        - call.created
        - call.notification
        - call.ring
      operationId: GetOrCreateCall
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrCreateCallRequest'
        description: GetOrCreateCallRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrCreateCallResponse'
          description: GetOrCreateCallResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get or create a call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/{session}/recordings/{filename}:
    delete:
      description: |
        Deletes recording
      operationId: DeleteRecording
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: path
        name: session
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: path
        name: filename
        required: true
        schema:
          maxLength: 256
          type: string
          writeOnly: true
          x-stream-index: "004"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRecordingResponse'
          description: DeleteRecordingResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete recording
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}:
    delete:
      description: |
        Deletes transcription
      operationId: DeleteTranscription
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: path
        name: session
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: path
        name: filename
        required: true
        schema:
          maxLength: 256
          type: string
          writeOnly: true
          x-stream-index: "004"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTranscriptionResponse'
          description: DeleteTranscriptionResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete transcription
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/block:
    post:
      description: |
        Block a user, preventing them from joining the call until they are unblocked.

        Sends events:
        - call.blocked_user
      operationId: BlockUser
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockUserRequest'
        description: BlockUserRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUserResponse'
          description: BlockUserResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Block user on a call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/closed_captions:
    post:
      description: |
        Sends a closed caption event to the call

        Sends events:
        - call.closed_caption
      operationId: SendClosedCaption
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendClosedCaptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendClosedCaptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Send closed caption
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/delete:
    post:
      description: |2


        Sends events:
        - call.deleted
      operationId: DeleteCall
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCallRequest'
        description: DeleteCallRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCallResponse'
          description: DeleteCallResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete Call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/event:
    post:
      description: |
        Sends custom event to the call

        Sends events:
        - custom
      operationId: SendCallEvent
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCallEventRequest'
        description: SendCallEventRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendCallEventResponse'
          description: SendCallEventResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Send custom event
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/feedback:
    post:
      description: |2


        Sends events:
        - call.user_feedback_submitted
      operationId: CollectUserFeedback
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectUserFeedbackRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectUserFeedbackResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Collect user feedback
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/go_live:
    post:
      description: |2


        Sends events:
        - call.live_started
      operationId: GoLive
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoLiveRequest'
        description: GoLiveRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoLiveResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Set call as live
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/kick:
    post:
      description: |
        Kicks a user from the call. Optionally block the user from rejoining by setting block=true.

        Sends events:
        - call.blocked_user
        - call.kicked_user
      operationId: KickUser
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KickUserRequest'
        description: KickUserRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KickUserResponse'
          description: KickUserResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Kick user from a call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/mark_ended:
    post:
      description: |2


        Sends events:
        - call.ended
      operationId: EndCall
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndCallResponse'
          description: EndCallResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: End call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/members:
    post:
      description: |2


        Sends events:
        - call.member_added
        - call.member_removed
        - call.member_updated
      operationId: UpdateCallMembers
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCallMembersRequest'
        description: UpdateCallMembersRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCallMembersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update Call Member
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/mute_users:
    post:
      description: |
        Mutes users in a call
      operationId: MuteUsers
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MuteUsersRequest'
        description: MuteUsersRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MuteUsersResponse'
          description: MuteUsersResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mute users
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/participants:
    post:
      description: |
        Returns a list of participants connected to the call
      operationId: QueryCallParticipants
      parameters:
      - in: path
        name: id
        required: true
        schema:
          maxLength: 255
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: type
        required: true
        schema:
          maxLength: 255
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: limit
        schema:
          format: int32
          maximum: 100
          type: integer
          x-stream-index: "004"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryCallParticipantsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallParticipantsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query call participants
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/pin:
    post:
      description: |
        Pins a track for all users in the call.
      operationId: VideoPin
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinRequest'
        description: PinRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PinResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Pin
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/recordings:
    get:
      description: |
        Lists recordings
      operationId: ListRecordings
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecordingsResponse'
          description: ListRecordingsResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List recordings
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/report:
    get:
      description: |2+

      operationId: GetCallReport
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: query
        name: session_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallReportResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get call report
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/rtmp_broadcasts:
    post:
      description: |
        Starts RTMP broadcasts for the provided RTMP destinations
      operationId: StartRTMPBroadcasts
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartRTMPBroadcastsRequest'
        description: StartRTMPBroadcastsRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartRTMPBroadcastsResponse'
          description: StartRTMPBroadcastsResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start RTMP broadcasts
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop:
    post:
      description: |
        Stop RTMP broadcasts for the provided RTMP destinations
      operationId: StopRTMPBroadcast
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopRTMPBroadcastsRequest'
        description: StopRTMPBroadcastsRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopRTMPBroadcastsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop RTMP broadcasts
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop:
    post:
      description: |
        Stop all RTMP broadcasts for the provided call
      operationId: StopAllRTMPBroadcasts
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopAllRTMPBroadcastsResponse'
          description: StopAllRTMPBroadcastsResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop all RTMP broadcasts for a call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/start_broadcasting:
    post:
      description: |
        Starts HLS broadcasting
      operationId: StartHLSBroadcasting
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartHLSBroadcastingResponse'
          description: StartHLSBroadcastingResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start HLS broadcasting
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/start_closed_captions:
    post:
      description: |
        Starts closed captions
      operationId: StartClosedCaptions
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartClosedCaptionsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartClosedCaptionsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start closed captions
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/start_frame_recording:
    post:
      description: |
        Starts frame by frame recording

        Sends events:
        - call.frame_recording_started
      operationId: StartFrameRecording
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartFrameRecordingRequest'
        description: StartFrameRecordingRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartFrameRecordingResponse'
          description: StartFrameRecordingResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start frame recording
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/start_recording:
    post:
      description: |
        Starts recording

        Sends events:
        - call.recording_started
      operationId: StartRecording
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartRecordingRequest'
        description: StartRecordingRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartRecordingResponse'
          description: StartRecordingResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start recording
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/start_transcription:
    post:
      description: |
        Starts transcription
      operationId: StartTranscription
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartTranscriptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartTranscriptionResponse'
          description: StartTranscriptionResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Start transcription
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_broadcasting:
    post:
      description: |
        Stops HLS broadcasting
      operationId: StopHLSBroadcasting
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopHLSBroadcastingResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop HLS broadcasting
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_closed_captions:
    post:
      description: |
        Stops closed captions

        Sends events:
        - call.transcription_stopped
      operationId: StopClosedCaptions
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopClosedCaptionsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopClosedCaptionsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop closed captions
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_frame_recording:
    post:
      description: |
        Stops frame recording

        Sends events:
        - call.frame_recording_stopped
      operationId: StopFrameRecording
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopFrameRecordingResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop frame recording
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_live:
    post:
      description: |2


        Sends events:
        - call.updated
      operationId: StopLive
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopLiveRequest'
        description: StopLiveRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopLiveResponse'
          description: StopLiveResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Set call as not live
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_recording:
    post:
      description: |
        Stops recording

        Sends events:
        - call.recording_stopped
      operationId: StopRecording
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopRecordingResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop recording
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/stop_transcription:
    post:
      description: |
        Stops transcription

        Sends events:
        - call.transcription_stopped
      operationId: StopTranscription
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopTranscriptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopTranscriptionResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop transcription
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/transcriptions:
    get:
      description: |
        Lists transcriptions
      operationId: ListTranscriptions
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of call
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Call ID
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTranscriptionsResponse'
          description: ListTranscriptionsResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List transcriptions
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/unblock:
    post:
      description: |
        Removes the block for a user on a call. The user will be able to join the call again.

        Sends events:
        - call.unblocked_user
      operationId: UnblockUser
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnblockUserRequest'
        description: UnblockUserRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockUserResponse'
          description: UnblockUserResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Unblocks user on a call
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/unpin:
    post:
      description: |
        Unpins a track for all users in the call.
      operationId: VideoUnpin
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnpinRequest'
        description: UnpinRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnpinResponse'
          description: UnpinResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Unpin
      tags:
      - product:video
  /api/v2/video/call/{type}/{id}/user_permissions:
    post:
      description: |
        Updates user permissions

        Sends events:
        - call.permissions_updated
      operationId: UpdateUserPermissions
      parameters:
      - in: path
        name: type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "005.001"
      - in: path
        name: id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "005.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserPermissionsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUserPermissionsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update user permissions
      tags:
      - product:video
  /api/v2/video/call/feedback:
    post:
      description: |2+

      operationId: QueryUserFeedback
      parameters:
      - in: query
        name: full
        schema:
          type: boolean
          writeOnly: true
          x-stream-index: "003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryUserFeedbackRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUserFeedbackResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query user reported feedback for the calls
      tags:
      - product:video
  /api/v2/video/call/members:
    post:
      description: |
        Query call members with filter query
      operationId: QueryCallMembers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryCallMembersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallMembersResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query call members
      tags:
      - product:video
  /api/v2/video/call/stats:
    post:
      description: |2+

      operationId: QueryCallStats
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryCallStatsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallStatsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query Call Stats
      tags:
      - product:video
  /api/v2/video/call_stats/{call_type}/{call_id}/{session}/participant/{user}/{user_session}/details:
    get:
      description: |2+

      operationId: GetCallSessionParticipantStatsDetails
      parameters:
      - in: path
        name: call_type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: path
        name: call_id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: path
        name: session
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "004"
      - in: path
        name: user
        required: true
        schema:
          maxLength: 256
          type: string
          writeOnly: true
          x-stream-index: "005"
      - in: path
        name: user_session
        required: true
        schema:
          maxLength: 256
          type: string
          writeOnly: true
          x-stream-index: "006"
      - in: query
        name: since
        schema:
          type: string
          writeOnly: true
          x-stream-index: "007"
      - in: query
        name: until
        schema:
          type: string
          writeOnly: true
          x-stream-index: "008"
      - in: query
        name: max_points
        schema:
          format: int32
          maximum: 4096
          minimum: 1
          type: integer
          writeOnly: true
          x-stream-index: "009"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallSessionParticipantStatsDetailsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get call session participant stats details
      tags:
      - product:video
  /api/v2/video/call_stats/{call_type}/{call_id}/{session}/participants:
    get:
      description: |2+

      operationId: QueryCallSessionParticipantStats
      parameters:
      - in: path
        name: call_type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: path
        name: call_id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: path
        name: session
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "004"
      - in: query
        name: sort
        schema:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 1
          type: array
          writeOnly: true
          x-stream-index: "005"
      - in: query
        name: filter_conditions
        schema:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "006"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallSessionParticipantStatsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query call participant statistics
      tags:
      - product:video
  /api/v2/video/call_stats/{call_type}/{call_id}/{session}/participants/{user}/{user_session}/timeline:
    get:
      description: |2+

      operationId: GetCallSessionParticipantStatsTimeline
      parameters:
      - in: path
        name: call_type
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: path
        name: call_id
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: path
        name: session
        required: true
        schema:
          maxLength: 64
          type: string
          writeOnly: true
          x-stream-index: "004"
      - in: path
        name: user
        required: true
        schema:
          maxLength: 128
          type: string
          writeOnly: true
          x-stream-index: "005"
      - in: path
        name: user_session
        required: true
        schema:
          maxLength: 128
          type: string
          writeOnly: true
          x-stream-index: "006"
      - in: query
        name: start_time
        schema:
          type: string
          writeOnly: true
          x-stream-index: "007"
      - in: query
        name: end_time
        schema:
          type: string
          writeOnly: true
          x-stream-index: "008"
      - in: query
        name: severity
        schema:
          items:
            type: string
          type: array
          writeOnly: true
          x-stream-index: "009"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallSessionParticipantStatsTimelineResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get participant timeline events
      tags:
      - product:video
  /api/v2/video/calls:
    post:
      description: |
        Query calls with filter query
      operationId: QueryCalls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryCallsRequest'
        description: QueryCallsRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCallsResponse'
          description: QueryCallsResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query call
      tags:
      - product:video
  /api/v2/video/calltypes:
    get:
      description: |2+

      operationId: ListCallTypes
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCallTypeResponse'
          description: ListCallTypeResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List Call Type
      tags:
      - product:video
    post:
      description: |2+

      operationId: CreateCallType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCallTypeRequest'
        description: CreateCallTypeRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCallTypeResponse'
          description: CreateCallTypeResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create Call Type
      tags:
      - product:video
  /api/v2/video/calltypes/{name}:
    delete:
      description: |2+

      operationId: DeleteCallType
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete Call Type
      tags:
      - product:video
    get:
      description: |2+

      operationId: GetCallType
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallTypeResponse'
          description: GetCallTypeResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get Call Type
      tags:
      - product:video
    put:
      description: |2+

      operationId: UpdateCallType
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCallTypeRequest'
        description: UpdateCallTypeRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCallTypeResponse'
          description: UpdateCallTypeResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update Call Type
      tags:
      - product:video
  /api/v2/video/edges:
    get:
      description: |
        Returns the list of all edges available for video calls.
      operationId: GetEdges
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEdgesResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get Edges
      tags:
      - product:video
  /api/v2/video/stats:
    post:
      description: |2+

      operationId: QueryAggregateCallStats
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryAggregateCallStatsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryAggregateCallStatsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query Aggregate call Stats
      tags:
      - product:video
security:
- JWT: []
  api_key: []
  stream-auth-type: []
- api_key: []
  stream-auth-type: []
servers:
- description: Stream API
  url: https://chat.stream-io-api.com