openapi: 3.0.3
info:
  title: 'Social Link'
  description: 'Social Link API documentation'
  version: 1.0.0
servers:
  -
    url: api.social-link.net
paths:
  '/v1/{project_id}':
    get:
      summary: 'Project Details'
      operationId: projectDetails
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: aba8c6c9-ec2f-447b-83f5-8b6746817732
                    team: "Social Link's Team"
                    status: published
                    name: 'Social Link'
                    slug: demo
                    theme: Rust
                    project_url: demo.slink.gg
                    domain_url: ''
                    final_url: demo.slink.gg
                    logo_url: 'https://social-link.net/assets/branding/logo.jpg'
                    providers:
                      discord:
                        enable_guild_check: 1
                        enable_booster_check: 1
                        guild_id: '76561198181797236'
                        role_id: '76561198181797236'
                        should_add_role: 1
                        bot_on_discord: 1
                      steam:
                        enable_group_check: 1
                        group_link: 'https://steamcommunity.com/groups/Social-Link'
                        group_id: '9134466'
                      twitch:
                        enable_follower_check: 1
                        enable_subscriber_check: 1
                        channel_link: null
                        broadcaster_id: '9134466'
                    notifications:
                      discord:
                        enable: true
                        webhook_url: 'https://discord.com/api/webhooks/76561198181797236/DxeO4+N$bP2z-CQw-=A*mqHZZrA:oa&X7|qPw<lA$b-_q[<j?ppb/C=X[<ynT<et(%1C'
                    game_servers:
                      -
                        status: enabled
                        connection_type: rcon
                        type: rust
                        name: 'Social Link Server'
                        rcon_ip: 1.1.1.1
                        rcon_port: '28016'
                        commands:
                          -
                            is_active: true
                            type: auth
                            provider: steam_group_member
                            command: 'say "Auth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                          -
                            is_active: true
                            type: auth
                            provider: discord_guild_member
                            command: 'say "Auth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                          -
                            is_active: true
                            type: auth
                            provider: discord_guild_nitro
                            command: 'say "Auth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                          -
                            is_active: true
                            type: deauth
                            provider: steam_group_member
                            command: 'say "Deauth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                          -
                            is_active: true
                            type: deauth
                            provider: discord_guild_member
                            command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                          -
                            is_active: true
                            type: deauth
                            provider: discord_guild_nitro
                            command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                        created_at: '2023-06-24T11:16:00.000000Z'
                        updated_at: '2023-06-24T11:16:00.000000Z'
                    metadata:
                      title: 'Social Link'
                      description: 'Social Link - Effortless Social Linking for Gamers'
                      theme_color: '#da532c'
                      favicon_url: 'https://social-link.net/assets/branding/logo.jpg'
                      image_url: 'https://social-link.net/assets/branding/banner.jpg'
                    created_at: '2023-06-24T11:15:59.000000Z'
                    updated_at: '2023-06-24T11:15:59.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
                      team:
                        type: string
                        example: "Social Link's Team"
                      status:
                        type: string
                        example: published
                      name:
                        type: string
                        example: 'Social Link'
                      slug:
                        type: string
                        example: demo
                      theme:
                        type: string
                        example: Rust
                      project_url:
                        type: string
                        example: demo.slink.gg
                      domain_url:
                        type: string
                        example: ''
                      final_url:
                        type: string
                        example: demo.slink.gg
                      logo_url:
                        type: string
                        example: 'https://social-link.net/assets/branding/logo.jpg'
                      providers:
                        type: object
                        properties:
                          discord:
                            type: object
                            properties:
                              enable_guild_check:
                                type: integer
                                example: 1
                              enable_booster_check:
                                type: integer
                                example: 1
                              guild_id:
                                type: string
                                example: '76561198181797236'
                              role_id:
                                type: string
                                example: '76561198181797236'
                              should_add_role:
                                type: integer
                                example: 1
                              bot_on_discord:
                                type: integer
                                example: 1
                          steam:
                            type: object
                            properties:
                              enable_group_check:
                                type: integer
                                example: 1
                              group_link:
                                type: string
                                example: 'https://steamcommunity.com/groups/Social-Link'
                              group_id:
                                type: string
                                example: '9134466'
                          twitch:
                            type: object
                            properties:
                              enable_follower_check:
                                type: integer
                                example: 1
                              enable_subscriber_check:
                                type: integer
                                example: 1
                              channel_link:
                                type: string
                                example: null
                              broadcaster_id:
                                type: string
                                example: '9134466'
                      notifications:
                        type: object
                        properties:
                          discord:
                            type: object
                            properties:
                              enable:
                                type: boolean
                                example: true
                              webhook_url:
                                type: string
                                example: 'https://discord.com/api/webhooks/76561198181797236/DxeO4+N$bP2z-CQw-=A*mqHZZrA:oa&X7|qPw<lA$b-_q[<j?ppb/C=X[<ynT<et(%1C'
                      game_servers:
                        type: array
                        example:
                          -
                            status: enabled
                            connection_type: rcon
                            type: rust
                            name: 'Social Link Server'
                            rcon_ip: 1.1.1.1
                            rcon_port: '28016'
                            commands:
                              -
                                is_active: true
                                type: auth
                                provider: steam_group_member
                                command: 'say "Auth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                              -
                                is_active: true
                                type: auth
                                provider: discord_guild_member
                                command: 'say "Auth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                              -
                                is_active: true
                                type: auth
                                provider: discord_guild_nitro
                                command: 'say "Auth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                              -
                                is_active: true
                                type: deauth
                                provider: steam_group_member
                                command: 'say "Deauth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                              -
                                is_active: true
                                type: deauth
                                provider: discord_guild_member
                                command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                              -
                                is_active: true
                                type: deauth
                                provider: discord_guild_nitro
                                command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                                created_at: '2023-06-24T11:16:00.000000Z'
                                updated_at: '2023-06-24T11:16:00.000000Z'
                            created_at: '2023-06-24T11:16:00.000000Z'
                            updated_at: '2023-06-24T11:16:00.000000Z'
                        items:
                          type: object
                          properties:
                            status:
                              type: string
                              example: enabled
                            connection_type:
                              type: string
                              example: rcon
                            type:
                              type: string
                              example: rust
                            name:
                              type: string
                              example: 'Social Link Server'
                            rcon_ip:
                              type: string
                              example: 1.1.1.1
                            rcon_port:
                              type: string
                              example: '28016'
                            commands:
                              type: array
                              example:
                                -
                                  is_active: true
                                  type: auth
                                  provider: steam_group_member
                                  command: 'say "Auth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                                -
                                  is_active: true
                                  type: auth
                                  provider: discord_guild_member
                                  command: 'say "Auth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                                -
                                  is_active: true
                                  type: auth
                                  provider: discord_guild_nitro
                                  command: 'say "Auth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                                -
                                  is_active: true
                                  type: deauth
                                  provider: steam_group_member
                                  command: 'say "Deauth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                                -
                                  is_active: true
                                  type: deauth
                                  provider: discord_guild_member
                                  command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildMember from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                                -
                                  is_active: true
                                  type: deauth
                                  provider: discord_guild_nitro
                                  command: 'say "Deauth {SteamID} - {SteamName} DiscordGuildNitro from Server 1 by Social Link!"'
                                  created_at: '2023-06-24T11:16:00.000000Z'
                                  updated_at: '2023-06-24T11:16:00.000000Z'
                              items:
                                type: object
                                properties:
                                  is_active:
                                    type: boolean
                                    example: true
                                  type:
                                    type: string
                                    example: auth
                                  provider:
                                    type: string
                                    example: steam_group_member
                                  command:
                                    type: string
                                    example: 'say "Auth {SteamID} - {SteamName} SteamGroupMember from Server 1 by Social Link!"'
                                  created_at:
                                    type: string
                                    example: '2023-06-24T11:16:00.000000Z'
                                  updated_at:
                                    type: string
                                    example: '2023-06-24T11:16:00.000000Z'
                            created_at:
                              type: string
                              example: '2023-06-24T11:16:00.000000Z'
                            updated_at:
                              type: string
                              example: '2023-06-24T11:16:00.000000Z'
                      metadata:
                        type: object
                        properties:
                          title:
                            type: string
                            example: 'Social Link'
                          description:
                            type: string
                            example: 'Social Link - Effortless Social Linking for Gamers'
                          theme_color:
                            type: string
                            example: '#da532c'
                          favicon_url:
                            type: string
                            example: 'https://social-link.net/assets/branding/logo.jpg'
                          image_url:
                            type: string
                            example: 'https://social-link.net/assets/branding/banner.jpg'
                      created_at:
                        type: string
                        example: '2023-06-24T11:15:59.000000Z'
                      updated_at:
                        type: string
                        example: '2023-06-24T11:15:59.000000Z'
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
  '/v1/{project_id}/players':
    get:
      summary: 'Players List'
      operationId: playersList
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      name: Player
                      is_banned: 0
                      steam:
                        id: '76561198181797236'
                        name: Havens
                        avatar: 'https://avatars.steamstatic.com/logo.jpg'
                        group_checked: 1
                        group_last_check: '2023-07-08T14:09:31.000000Z'
                      discord:
                        id: '765611981817972366'
                        name: Player
                        avatar: 'https://cdn.discordapp.com/avatars/765611981817972366/logo.jpg'
                        guild_checked: 1
                        guild_last_check: '2023-07-08T14:09:31.000000Z'
                        booster_checked: 0
                        booster_last_check: '2023-07-08T14:09:33.000000Z'
                        has_given_role: 1
                      twitch:
                        id: null
                        name: null
                        avatar: null
                        follower_checked: 0
                        follower_last_check: null
                        subscriber_checked: 0
                        subscriber_last_check: null
                      created_at: '2023-07-08T14:09:25.000000Z'
                      updated_at: '2023-07-08T14:09:33.000000Z'
                  links:
                    first: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=1'
                    last: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                    prev: null
                    next: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 2
                    links:
                      -
                        url: null
                        label: '&laquo; Previous'
                        active: false
                      -
                        url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=1'
                        label: '1'
                        active: true
                      -
                        url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                        label: '2'
                        active: false
                      -
                        url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                        label: 'Next &raquo;'
                        active: false
                    path: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players'
                    per_page: 1
                    to: 2
                    total: 2
                properties:
                  data:
                    type: array
                    example:
                      -
                        name: Player
                        is_banned: 0
                        steam:
                          id: '76561198181797236'
                          name: Havens
                          avatar: 'https://avatars.steamstatic.com/logo.jpg'
                          group_checked: 1
                          group_last_check: '2023-07-08T14:09:31.000000Z'
                        discord:
                          id: '765611981817972366'
                          name: Player
                          avatar: 'https://cdn.discordapp.com/avatars/765611981817972366/logo.jpg'
                          guild_checked: 1
                          guild_last_check: '2023-07-08T14:09:31.000000Z'
                          booster_checked: 0
                          booster_last_check: '2023-07-08T14:09:33.000000Z'
                          has_given_role: 1
                        twitch:
                          id: null
                          name: null
                          avatar: null
                          follower_checked: 0
                          follower_last_check: null
                          subscriber_checked: 0
                          subscriber_last_check: null
                        created_at: '2023-07-08T14:09:25.000000Z'
                        updated_at: '2023-07-08T14:09:33.000000Z'
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: Player
                        is_banned:
                          type: integer
                          example: 0
                        steam:
                          type: object
                          properties:
                            id:
                              type: string
                              example: '76561198181797236'
                            name:
                              type: string
                              example: Havens
                            avatar:
                              type: string
                              example: 'https://avatars.steamstatic.com/logo.jpg'
                            group_checked:
                              type: integer
                              example: 1
                            group_last_check:
                              type: string
                              example: '2023-07-08T14:09:31.000000Z'
                        discord:
                          type: object
                          properties:
                            id:
                              type: string
                              example: '765611981817972366'
                            name:
                              type: string
                              example: Player
                            avatar:
                              type: string
                              example: 'https://cdn.discordapp.com/avatars/765611981817972366/logo.jpg'
                            guild_checked:
                              type: integer
                              example: 1
                            guild_last_check:
                              type: string
                              example: '2023-07-08T14:09:31.000000Z'
                            booster_checked:
                              type: integer
                              example: 0
                            booster_last_check:
                              type: string
                              example: '2023-07-08T14:09:33.000000Z'
                            has_given_role:
                              type: integer
                              example: 1
                        twitch:
                          type: object
                          properties:
                            id:
                              type: string
                              example: null
                            name:
                              type: string
                              example: null
                            avatar:
                              type: string
                              example: null
                            follower_checked:
                              type: integer
                              example: 0
                            follower_last_check:
                              type: string
                              example: null
                            subscriber_checked:
                              type: integer
                              example: 0
                            subscriber_last_check:
                              type: string
                              example: null
                        created_at:
                          type: string
                          example: '2023-07-08T14:09:25.000000Z'
                        updated_at:
                          type: string
                          example: '2023-07-08T14:09:33.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=1'
                      last:
                        type: string
                        example: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                      prev:
                        type: string
                        example: null
                      next:
                        type: string
                        example: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 2
                      links:
                        type: array
                        example:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=1'
                            label: '1'
                            active: true
                          -
                            url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                            label: '2'
                            active: false
                          -
                            url: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players?page=2'
                            label: 'Next &raquo;'
                            active: false
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              example: null
                            label:
                              type: string
                              example: '&laquo; Previous'
                            active:
                              type: boolean
                              example: false
                      path:
                        type: string
                        example: 'https://social-link.net/api/v1/44e24df3-e002-4e45-a393-814d2da35c0a/players'
                      per_page:
                        type: integer
                        example: 1
                      to:
                        type: integer
                        example: 2
                      total:
                        type: integer
                        example: 2
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}':
    get:
      summary: 'Player Detail'
      operationId: playerDetail
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    name: Player
                    is_banned: 0
                    steam:
                      id: '76561198181797236'
                      name: Havens
                      avatar: 'https://avatars.steamstatic.com/logo.jpg'
                      group_checked: 1
                      group_last_check: '2023-07-08T14:09:31.000000Z'
                    discord:
                      id: '765611981817972366'
                      name: Player
                      avatar: 'https://cdn.discordapp.com/avatars/765611981817972366/logo.jpg'
                      guild_checked: 1
                      guild_last_check: '2023-07-08T14:09:31.000000Z'
                      booster_checked: 0
                      booster_last_check: '2023-07-08T14:09:33.000000Z'
                      has_given_role: 1
                    twitch:
                      id: null
                      name: null
                      avatar: null
                      follower_checked: 0
                      follower_last_check: null
                      subscriber_checked: 0
                      subscriber_last_check: null
                    created_at: '2023-07-08T14:09:25.000000Z'
                    updated_at: '2023-07-08T14:09:33.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Player
                      is_banned:
                        type: integer
                        example: 0
                      steam:
                        type: object
                        properties:
                          id:
                            type: string
                            example: '76561198181797236'
                          name:
                            type: string
                            example: Havens
                          avatar:
                            type: string
                            example: 'https://avatars.steamstatic.com/logo.jpg'
                          group_checked:
                            type: integer
                            example: 1
                          group_last_check:
                            type: string
                            example: '2023-07-08T14:09:31.000000Z'
                      discord:
                        type: object
                        properties:
                          id:
                            type: string
                            example: '765611981817972366'
                          name:
                            type: string
                            example: Player
                          avatar:
                            type: string
                            example: 'https://cdn.discordapp.com/avatars/765611981817972366/logo.jpg'
                          guild_checked:
                            type: integer
                            example: 1
                          guild_last_check:
                            type: string
                            example: '2023-07-08T14:09:31.000000Z'
                          booster_checked:
                            type: integer
                            example: 0
                          booster_last_check:
                            type: string
                            example: '2023-07-08T14:09:33.000000Z'
                          has_given_role:
                            type: integer
                            example: 1
                      twitch:
                        type: object
                        properties:
                          id:
                            type: string
                            example: null
                          name:
                            type: string
                            example: null
                          avatar:
                            type: string
                            example: null
                          follower_checked:
                            type: integer
                            example: 0
                          follower_last_check:
                            type: string
                            example: null
                          subscriber_checked:
                            type: integer
                            example: 0
                          subscriber_last_check:
                            type: string
                            example: null
                      created_at:
                        type: string
                        example: '2023-07-08T14:09:25.000000Z'
                      updated_at:
                        type: string
                        example: '2023-07-08T14:09:33.000000Z'
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: aperiam
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/discord/recheck-guild':
    put:
      summary: 'Discord Guild Re-check'
      operationId: discordGuildReCheck
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The Discord guild re-check has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The Discord guild re-check has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: nihil
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/discord/recheck-boost':
    put:
      summary: 'Discord Boost Re-check'
      operationId: discordBoostReCheck
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The Discord boost re-check has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The Discord boost re-check has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: explicabo
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/discord/unlink':
    put:
      summary: 'Discord Unlink'
      operationId: discordUnlink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The unlink has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The unlink has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: quis
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/discord/delete-data':
    delete:
      summary: 'Discord Delete Player Data'
      operationId: discordDeletePlayerData
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'Discord data deletion has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'Discord data deletion has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: cupiditate
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/twitch/unlink':
    put:
      summary: 'Twitch Unlink'
      operationId: twitchUnlink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The unlink has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The unlink has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: tempore
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/twitch/delete-data':
    delete:
      summary: 'Twitch Delete Player Data'
      operationId: twitchDeletePlayerData
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'Discord data deletion has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'Discord data deletion has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: repellendus
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/steam/recheck-group':
    put:
      summary: 'Steam Group Re-check'
      operationId: steamGroupReCheck
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The Steam group re-check has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The Steam group re-check has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: excepturi
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/steam/unlink':
    put:
      summary: 'Steam Group Unlink'
      operationId: steamGroupUnlink
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The unlink has been launched.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The unlink has been launched.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: ratione
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/ban':
    put:
      summary: 'Ban Player'
      operationId: banPlayer
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The player has been banned.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The player has been banned.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: ducimus
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/unban':
    put:
      summary: 'Unban Player'
      operationId: unbanPlayer
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The player has been unbanned.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The player has been unbanned.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: autem
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
  '/v1/{project_id}/players/{playerId}/delete':
    delete:
      summary: 'Delete Player'
      operationId: deletePlayer
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'The player has been deleted.'
                  data: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'The player has been deleted.'
                  data:
                    type: array
                    example: []
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: project_id
        description: 'The Project ID (UUID).'
        example: aba8c6c9-ec2f-447b-83f5-8b6746817732
        required: true
        schema:
          type: string
      -
        in: path
        name: playerId
        description: ''
        example: et
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The Steam ID (SteamID64) / Discord ID / Twitch ID of the player.'
        example: '76561198181797236'
        required: true
        schema:
          type: string
tags:
  -
    name: Endpoints
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []