thiccccccums for the Kickkkkkkums

streamerbot/2.guide/20.platforms/2.trovo.md

@@ -5,7 +5,6 @@ navigation.icon: null
 icon: IconTrovo
 logo: /img/icons/trovo.png
 version: 0.2.3
-badge: New
 ---
 
 :api-reference-cards{path=trovo}

streamerbot/2.guide/20.platforms/3.kick.md

@@ -0,0 +1,13 @@
+---
+title: Kick
+description: Configure the Kick streaming platform with Streamer.bot
+navigation.icon: null
+icon: simple-icons:kick
+logo: /img/icons/kick.png
+version: 1.0.0
+badge: New
+---
+
+:api-reference-cards{path=kick}
+
+:wip

streamerbot/3.api/1.sub-actions/kick/channel/set-channel-category.md

@@ -0,0 +1,35 @@
+---
+title: Set Channel Category
+description: Update the current category of your Kick channel
+parameters:
+  - name: Source
+    type: Select
+    default: String
+    description: |
+      Select a source type for the new game value
+
+      - `String`: Select this option to manually enter the game title or load it from a variable
+      - `Specific Game`: Select this option to select a game from a dropdown
+  - name: Title
+    type: Text | Select
+    description: |
+      Select the new game category or enter the new game category by name
+variables:
+  - name: category.success
+    type: bool
+    description: The status of the sub-action request
+    value: True/False
+  - name: category.id
+    type: string
+    description: The unique category identifier
+    value: 5787
+  - name: category.name
+    description: The unique category name
+    value: Cats & Soup
+  - name: category.thumbnail
+    type: string
+    description: URL to the image for the selected category
+    value: https://files.kick.com/images/subcategories/5787/banner/conversion/153f16f9-6a5a-4449-b7c2-0a8e14f18092-banner.webp
+csharpMethods:
+  - KickSetCategory
+---

streamerbot/3.api/1.sub-actions/kick/channel/set-channel-title.md

@@ -0,0 +1,15 @@
+---
+title: Set Channel Title
+description: Update the current title of your Kick channel
+parameters:
+  - name: Title
+    type: Text
+    description: Enter the new title for your stream
+variables:
+  - name: titleSuccess
+    type: bool
+    description: The status of the sub-action request
+    value: True/False
+csharpMethods:
+  - KickSetTitle
+---

streamerbot/3.api/1.sub-actions/kick/chat/reply-to-message.md

@@ -0,0 +1,35 @@
+---
+title: Reply to Message
+description: Send a reply to a specific Kick chat message
+parameters:
+  - name: Reply Id
+    type: Text
+    default: '%messageId%'
+    required: true
+    description: |
+      Enter the unique ID of the message to reply to
+
+      ::tip
+      All triggers that contain the `Kick Chat` variables, will populate the `%messageId%`{lang=cs} variable
+      ::
+  - name: Message
+    type: Text
+    required: true
+    description: |
+      Enter the message contents
+  - name: Send using bot account
+    type: Toggle
+    default: false
+    description: |
+      - [x] Send the reply using your **Kick Bot** account
+      - [ ] Send the reply using your **Kick Broadcaster** account
+  - name: Fallback to Broadcaster
+    type: Toggle
+    default: false
+    description: |
+      - [x] If `Send using Bot account` is **checked**, it will attempt to send reply as Kick Bot account and, if unable, then send as Kick Broadcaster.
+      - [ ] If `Send using Bot account` is **unchecked**, it will attempt to send reply as Kick Bot account and, if unable, then do **nothing** (i.e. the Kick Bot account is not logged in.
+variables: []
+csharpMethods:
+  - KickReplyToMessage
+---

streamerbot/3.api/1.sub-actions/kick/chat/send-message-to-channel.md

@@ -0,0 +1,25 @@
+---
+title: Send Message
+description: Send a Kick chat message
+parameters:
+  - name: Message
+    type: Text
+    required: true
+    description: |
+      Enter the message contents
+  - name: Send using bot account
+    type: Toggle
+    default: Unchecked
+    description: |
+      - [x] Send the reply using your **Kick Bot** account
+      - [ ] Send the reply using your **Kick Broadcaster** account
+  - name: Fallback to Broadcaster
+    type: Toggle
+    default: Unchecked
+    description: |
+      - [x] If `Send using Bot account` is **checked**, it will attempt to send reply as Kick Bot account and, if unable, then send as Kick Broadcaster.
+      - [ ] If `Send using Bot account` is **unchecked**, it will attempt to send reply as Kick Bot account and, if unable, then do **nothing** (i.e. the Kick Bot account is not logged in.
+variables: []
+csharpMethods:
+  - SendKickMessage
+---

streamerbot/3.api/1.sub-actions/kick/moderation/ban-user.md

@@ -0,0 +1,36 @@
+---
+title: Ban User
+description: Ban a Kick user
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+  - name: Reason
+    type: String
+    required: false
+    description: ban reason
+variables:
+  - name: bannedUser
+    type: string
+    description: display name of the banned user
+    value: Amouranth
+  - name: bannedUserName
+    type: string
+    description: login name of the banned user
+    value: Amouranth
+  - name: bannedUserId
+    type: string
+    description: ID of the banned user
+    value: 12345678
+  - name: bannedUserType
+    type: string
+    description: platform of the banned user
+    value: kick
+  - name: banResult
+    type: bool
+    description: indicator whether the ban has been successful or not
+    value: True/False
+csharpMethods:
+  - KickBanUser
+---

streamerbot/3.api/1.sub-actions/kick/moderation/timeout-user.md

@@ -0,0 +1,37 @@
+---
+title: Timeout User
+description: Timeout a Kick user
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: Can be a user name or a variable like `%userName%`
+  - name: Duration
+    type: Int
+    required: true
+    description: Timeout duration in seconds. `0` is a permanent ban.
+variables:
+  - name: timedOutUser
+    type: string
+    description: display name of the timed out user
+    value: Amouranth
+  - name: timedOutUserName
+    type: string
+    description: login name of the timed out user
+    value: Amouranth
+  - name: timedOutUserId
+    type: string
+    description: ID of the timed out user
+    value: 12345678
+  - name: timedOutUserType
+    type: string
+    description: platform of the timed out user
+    value: kick
+  - name: timeoutResult
+    type: bool
+    description: indicator whether the timeout has been successful or not
+    value: True/False
+csharpMethods:
+  - KickTimeoutUser
+---
+

streamerbot/3.api/1.sub-actions/kick/moderation/unban-user.md

@@ -0,0 +1,32 @@
+---
+title: Unban User
+description: Unban a Kick user
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+variables:
+  - name: unbannedUser
+    type: string
+    description: display name of the unbanned user
+    value: Amouranth
+  - name: unbannedUserName
+    type: string
+    description: login name of the banned user
+    value: Amouranth
+  - name: unbannedUserId
+    type: string
+    description: ID of the banned user
+    value: 12345678
+  - name: unbannedUserType
+    type: string
+    description: platform of the banned user
+    value: kick
+  - name: unbanResult
+    type: bool
+    description: indicator whether the ban has been successful or not
+    value: True/False
+csharpMethods:
+  - KickUnbanUser
+---

streamerbot/3.api/1.sub-actions/kick/moderation/untimeout-user.md

@@ -0,0 +1,32 @@
+---
+title: UnTimeout User
+description: Untimeout a Kick user
+
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+variables:
+  - name: unTimedOutUser
+    type: string
+    description: display name of the untimed-out user
+    value: Amouranth
+  - name: unTimedOutUserName
+    type: string
+    description: login name of the untimed-out user
+    value: Amouranth
+  - name: unTimedOutUserId
+    type: string
+    description: ID of the untimed-out user
+    value: 12345678
+  - name: unTimedOutUserType
+    type: string
+    description: platform of the untimed-out user
+    value: kick
+  - name: unTimedOutResult
+    type: bool
+    description: indicator whether the untimeout has been successful or not
+    value: True/False
+csharpMethods: []
+---

streamerbot/3.api/1.sub-actions/kick/user-groups/add-user-to-group.md

@@ -0,0 +1,20 @@
+---
+title: Add User To Group
+description: Add a Kick user to a group
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+    value: Amouranth
+  - name: Group Name
+    type: String
+    required: true
+    description: can be a specific group name or a variable
+    value: BestFriends
+variables:
+  - name: addResult
+    type: bool
+    description: indicator whether the addition has been successful or not
+    value: True/False
+---

streamerbot/3.api/1.sub-actions/kick/user-groups/remove-user-from-group.md

@@ -0,0 +1,20 @@
+---
+title: Remove User From Group
+description: Remove a Kick user from a group
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+    value: Amouranth
+  - name: Group Name
+    type: String
+    required: true
+    description: can be a specific group name or a variable
+    value: BestFriends
+variables:
+  - name: removeResult
+    type: bool
+    description: indicator whether the removal has been successful or not
+    value: True/False
+---

streamerbot/3.api/1.sub-actions/kick/user-groups/user-in-group.md

@@ -0,0 +1,36 @@
+---
+title: User in Group
+description: Check if a Kick user is a member of a given group
+parameters:
+  - name: User Login
+    type: String
+    required: true
+    description: can be a user name or a variable like `%userName%`
+    value: Amouranth
+  - name: Group Name
+    type: String
+    required: true
+    description: can be a specific group name or a variable
+    value: BestFriends
+variables:
+  - name: inGroup
+    type: bool
+    description: indicator whether the user is in the specified group or not
+    value: True/False
+  - name: foundUser
+    type: string
+    description: the user's display name
+    value: Amouranth
+  - name: foundUserName
+    type: string
+    description: the user's login name
+    value: Amouranth
+  - name: foundUserId
+    type: string
+    description: the user's ID
+    value: 12345678
+  - name: foundUserType
+    type: string
+    description: the user's platform
+    value: kick
+---

streamerbot/3.api/1.sub-actions/kick/user/add-broadcaster-information.md

@@ -0,0 +1,27 @@
+---
+title: Add Broadcaster Information
+description: Fetch user data for the connected Kick broadcaster account
+variables:
+  - name: broadcastUser
+    description: Display name of the broadcaster account
+    type: string
+    value: Mustached_Maniac
+  - name: broadcastUserName
+    description: Username of the broadcaster account
+    type: string
+    value: mustached_maniac
+  - name: broadcastUserId
+    description: Unique user ID of the broadcaster account
+    type: string
+    value: 11088894
+  - name: broadcastUserType
+    description: Platform type of the broadcaster account
+    type: string
+    value: Kick
+  - name: broadcasterProfileUrl
+    description: Link to the 300x300px PNG version of the broadcaster's Kick profile image
+    type: string
+    value: https://files.kick.com/images/user/11088894/profile_image/conversion/4495b495-4753-455c-9434-7debf0b82ba3-fullsize.webp
+csharpMethods:
+  - KickGetBroadcaster
+---