Class APIAdmin

Constructors

constructor

new APIAdmin(web): APIAdmin
Parameters
- web: WebDataManager
Returns APIAdmin
- Defined in src/classes/admin.ts:8

Methods

bulkToggleDropGames

bulkToggleDropGames(__namedParameters): Promise<WebResponse<DropGamesBulkResult>>
Parameters
- __namedParameters: {
      all?: boolean;
      auth: string;
      dbIds?: string[];
      ignored: boolean;
      platform?: DropPlatform;
  }
  - Optionalall?: boolean
  - auth: string
  - OptionaldbIds?: string[]
  - ignored: boolean
  - Optionalplatform?: DropPlatform
Returns Promise<WebResponse<DropGamesBulkResult>>
- Defined in src/classes/admin.ts:118

createFixUrlRule

createFixUrlRule(__namedParameters): Promise<WebResponse<FixUrlRule>>
Parameters
- __namedParameters: {
      auth: string;
      enabled?: boolean;
      original: string;
      replacement: string;
  }
  - auth: string
  - Optionalenabled?: boolean
  - original: string
  - replacement: string
Returns Promise<WebResponse<FixUrlRule>>
- Defined in src/classes/admin.ts:54

deleteFixUrlRule

deleteFixUrlRule(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  ruleId: string;
  }
  - auth: string
  - ruleId: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/admin.ts:68

getAdmin

getAdmin(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/admin.ts:11

getAnalytics

getAnalytics<T>(__namedParameters): Promise<WebResponse<Analytics<T, string>>>
Type Parameters
- T extends string = string
Parameters
- __namedParameters: {
  auth: string;
  lookback?: number;
  }
  - auth: string
  - Optionallookback?: number
Returns Promise<WebResponse<Analytics<T, string>>>
- Defined in src/classes/admin.ts:25

getAnalyticsEvents

getAnalyticsEvents(__namedParameters): Promise<WebResponse<AnalyticsEventsResponse>>
Parameters
- __namedParameters: {
      auth: string;
      guildId?: string;
      kind?: AnalyticsEventKind;
      limit?: number;
      offset?: number;
      range?: number;
      source?: string;
      userId?: string;
  }
  - auth: string
  - OptionalguildId?: string
  - Optionalkind?: AnalyticsEventKind
  - Optionallimit?: number
  - Optionaloffset?: number
  - Optionalrange?: number
  - Optionalsource?: string
  - OptionaluserId?: string
Returns Promise<WebResponse<AnalyticsEventsResponse>>
- Defined in src/classes/admin.ts:189

getCooldowns

getCooldowns(__namedParameters): Promise<WebResponse<CooldownsResponse>>
Parameters
- __namedParameters: {
      auth: string;
      guildId?: string;
      limit?: number;
      page?: number;
      platform?: string;
      streamer?: string;
  }
  - auth: string
  - OptionalguildId?: string
  - Optionallimit?: number
  - Optionalpage?: number
  - Optionalplatform?: string
  - Optionalstreamer?: string
Returns Promise<WebResponse<CooldownsResponse>>
- Defined in src/classes/admin.ts:175

getDropsSettings

getDropsSettings(__namedParameters): Promise<WebResponse<DropsSettingsResult>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<DropsSettingsResult>>
- Defined in src/classes/admin.ts:139

getEmailList

getEmailList(__namedParameters): Promise<WebResponse<EmailList>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<EmailList>>
- Defined in src/classes/admin.ts:18

getFeatureFlags

getFeatureFlags(__namedParameters): Promise<WebResponse<FeatureFlagStatus[]>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<FeatureFlagStatus[]>>
- Defined in src/classes/admin.ts:89

getFixUrlRules

getFixUrlRules(__namedParameters): Promise<WebResponse<FixUrlRule[]>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<FixUrlRule[]>>
- Defined in src/classes/admin.ts:47

getGuildDropsAudit

getGuildDropsAudit(__namedParameters): Promise<WebResponse<GuildDropsAuditResponse>>
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      platform?: DropPlatform;
  }
  - auth: string
  - guildId: string
  - Optionalplatform?: DropPlatform
Returns Promise<WebResponse<GuildDropsAuditResponse>>
- Defined in src/classes/admin.ts:161

getGuildVods

getGuildVods(__namedParameters): Promise<WebResponse<GuildVodsResponse>>
Parameters
- __namedParameters: {
      auth: string;
      creator?: string;
      enrich?: boolean;
      guildId: string;
      limit?: number;
      page?: number;
  }
  - auth: string
  - Optionalcreator?: string
  - Optionalenrich?: boolean
  - guildId: string
  - Optionallimit?: number
  - Optionalpage?: number
Returns Promise<WebResponse<GuildVodsResponse>>
- Defined in src/classes/admin.ts:154

getNotificationProviders

getNotificationProviders(__namedParameters): Promise<WebResponse<NotificationProviderStatus[]>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<NotificationProviderStatus[]>>
- Defined in src/classes/admin.ts:75

getPubSubHealth

getPubSubHealth(__namedParameters): Promise<WebResponse<PubSubHealthResponse>>
Parameters
- __namedParameters: {
      all?: boolean;
      auth: string;
      channel?: string;
      platform: "youtube";
  }
  - Optionalall?: boolean
  - auth: string
  - Optionalchannel?: string
  - platform: "youtube"
Returns Promise<WebResponse<PubSubHealthResponse>>
- Defined in src/classes/admin.ts:168

getSystemHealth

getSystemHealth(__namedParameters): Promise<WebResponse<SystemHealthResponse>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<SystemHealthResponse>>
- Defined in src/classes/admin.ts:182

listDropCampaigns

listDropCampaigns(__namedParameters): Promise<WebResponse<DropCampaignsListResponse>>
Parameters
- __namedParameters: {
      auth: string;
      gameId?: string;
      limit?: number;
      page?: number;
      platform?: DropPlatform;
      status?: string;
  }
  - auth: string
  - OptionalgameId?: string
  - Optionallimit?: number
  - Optionalpage?: number
  - Optionalplatform?: DropPlatform
  - Optionalstatus?: string
Returns Promise<WebResponse<DropCampaignsListResponse>>
- Defined in src/classes/admin.ts:132

listDropGames

listDropGames(__namedParameters): Promise<WebResponse<DropGamesListResponse>>
Parameters
- __namedParameters: {
      auth: string;
      limit?: number;
      page?: number;
      platform?: DropPlatform;
      search?: string;
      status?: "enabled" | "all" | "disabled";
  }
  - auth: string
  - Optionallimit?: number
  - Optionalpage?: number
  - Optionalplatform?: DropPlatform
  - Optionalsearch?: string
  - Optionalstatus?: "enabled" | "all" | "disabled"
Returns Promise<WebResponse<DropGamesListResponse>>
- Defined in src/classes/admin.ts:104

reconcileDropGames

reconcileDropGames(__namedParameters): Promise<WebResponse<DropGamesReconcileResult>>
Parameters
- __namedParameters: {
      auth: string;
      keep: string[];
      platform?: DropPlatform;
  }
  - auth: string
  - keep: string[]
  - Optionalplatform?: DropPlatform
Returns Promise<WebResponse<DropGamesReconcileResult>>
- Defined in src/classes/admin.ts:125

setDropsSettings

setDropsSettings(__namedParameters): Promise<WebResponse<DropsSettingsResult>>
Parameters
- __namedParameters: {
      auth: string;
      global?: boolean;
      kick?: boolean;
      twitch?: boolean;
  }
  - auth: string
  - Optionalglobal?: boolean
  - Optionalkick?: boolean
  - Optionaltwitch?: boolean
Returns Promise<WebResponse<DropsSettingsResult>>
- Defined in src/classes/admin.ts:146

setFeatureFlag

setFeatureFlag(__namedParameters): Promise<WebResponse<FeatureFlag>>
Parameters
- __namedParameters: {
      auth: string;
      feature:
          | "club"
          | "statusRoles"
          | "streamRoles"
          | "linkedRoles"
          | "stickyMessages"
          | "welcomeLeave"
          | "giveaways"
          | "freeGames"
          | "gameChangelogs"
          | "robloxNotifications"
          | "fixLinks"
          | "clipperNotifications"
          | "scheduledMessages"
          | "reactionRoles"
          | "clipForwarding"
          | "whatnot"
          | "fishing"
          | "starboards"
          | "syncedRoles"
          | "birthdays"
          | "autoStatusLiveRoles"
          | "emotes"
          | "liveRoles"
          | "statCounters"
          | "voteSkipping";
      status: FeatureStatus;
  }
  - auth: string
  - feature:
        | "club"
        | "statusRoles"
        | "streamRoles"
        | "linkedRoles"
        | "stickyMessages"
        | "welcomeLeave"
        | "giveaways"
        | "freeGames"
        | "gameChangelogs"
        | "robloxNotifications"
        | "fixLinks"
        | "clipperNotifications"
        | "scheduledMessages"
        | "reactionRoles"
        | "clipForwarding"
        | "whatnot"
        | "fishing"
        | "starboards"
        | "syncedRoles"
        | "birthdays"
        | "autoStatusLiveRoles"
        | "emotes"
        | "liveRoles"
        | "statCounters"
        | "voteSkipping"
  - status: FeatureStatus
Returns Promise<WebResponse<FeatureFlag>>
- Defined in src/classes/admin.ts:96

setNotificationProvider

setNotificationProvider(__namedParameters): Promise<WebResponse<NotificationProvider>>
Parameters
- __namedParameters: {
      auth: string;
      enabled: boolean;
      name: NotificationProviderName;
  }
  - auth: string
  - enabled: boolean
  - name: NotificationProviderName
Returns Promise<WebResponse<NotificationProvider>>
- Defined in src/classes/admin.ts:82

stripeCharge

stripeCharge(__namedParameters): Promise<WebResponse<AdminStripeChargeResponse>>
Parameters
- __namedParameters: {
      amountCents: number;
      auth: string;
      description?: string;
      dueDays?: number;
      guildId?: string;
      subscriptionId?: string;
  }
  - amountCents: number
  - auth: string
  - Optionaldescription?: string
  - OptionaldueDays?: number
  - OptionalguildId?: string
  - OptionalsubscriptionId?: string
Returns Promise<WebResponse<AdminStripeChargeResponse>>
- Defined in src/classes/admin.ts:34

toggleDropGame

toggleDropGame(__namedParameters): Promise<WebResponse<DropGameToggleResult>>
Parameters
- __namedParameters: {
      auth: string;
      dbId: string;
      ignored: boolean;
  }
  - auth: string
  - dbId: string
  - ignored: boolean
Returns Promise<WebResponse<DropGameToggleResult>>
- Defined in src/classes/admin.ts:111

updateFixUrlRule

updateFixUrlRule(__namedParameters): Promise<WebResponse<FixUrlRule>>
Parameters
- __namedParameters: {
      auth: string;
      enabled?: boolean;
      original?: string;
      replacement?: string;
      ruleId: string;
  }
  - auth: string
  - Optionalenabled?: boolean
  - Optionaloriginal?: string
  - Optionalreplacement?: string
  - ruleId: string
Returns Promise<WebResponse<FixUrlRule>>
- Defined in src/classes/admin.ts:61

Class APIAdmin

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIAdmin

Methods

bulkToggleDropGames

Parameters

Optionalall?: boolean

auth: string

OptionaldbIds?: string[]

ignored: boolean

Optionalplatform?: DropPlatform

Returns Promise<WebResponse<DropGamesBulkResult>>

createFixUrlRule

Parameters

auth: string

Optionalenabled?: boolean

original: string

replacement: string

Returns Promise<WebResponse<FixUrlRule>>

deleteFixUrlRule

Parameters

auth: string

ruleId: string

Returns Promise<WebResponse<string>>

getAdmin

Parameters

auth: string

Returns Promise<WebResponse<string>>

getAnalytics

Type Parameters

Parameters

auth: string

Optionallookback?: number

Returns Promise<WebResponse<Analytics<T, string>>>

getAnalyticsEvents

Parameters

auth: string

OptionalguildId?: string

Optionalkind?: AnalyticsEventKind

Optionallimit?: number

Optionaloffset?: number

Optionalrange?: number

Optionalsource?: string

OptionaluserId?: string

Returns Promise<WebResponse<AnalyticsEventsResponse>>

getCooldowns

Parameters

auth: string

OptionalguildId?: string

Optionallimit?: number

Optionalpage?: number

Optionalplatform?: string

Optionalstreamer?: string

Returns Promise<WebResponse<CooldownsResponse>>

getDropsSettings

Parameters

auth: string

Returns Promise<WebResponse<DropsSettingsResult>>

getEmailList

Parameters

auth: string

Returns Promise<WebResponse<EmailList>>

getFeatureFlags

Parameters

auth: string

Returns Promise<WebResponse<FeatureFlagStatus[]>>

getFixUrlRules

Parameters

auth: string

Returns Promise<WebResponse<FixUrlRule[]>>

getGuildDropsAudit

Parameters

auth: string

guildId: string

Optionalplatform?: DropPlatform

`Optional`all?: boolean

`Optional`dbIds?: string[]

`Optional`platform?: DropPlatform

`Optional`enabled?: boolean

`Optional`lookback?: number

`Optional`guildId?: string

`Optional`kind?: AnalyticsEventKind

`Optional`limit?: number

`Optional`offset?: number

`Optional`range?: number

`Optional`source?: string

`Optional`userId?: string

`Optional`guildId?: string

`Optional`limit?: number

`Optional`page?: number

`Optional`platform?: string

`Optional`streamer?: string

`Optional`platform?: DropPlatform

`Optional`creator?: string

`Optional`enrich?: boolean

`Optional`limit?: number

`Optional`page?: number

`Optional`all?: boolean

`Optional`channel?: string

`Optional`gameId?: string

`Optional`limit?: number

`Optional`page?: number

`Optional`platform?: DropPlatform

`Optional`status?: string

`Optional`limit?: number

`Optional`page?: number

`Optional`platform?: DropPlatform

`Optional`search?: string

`Optional`status?: "enabled" | "all" | "disabled"

`Optional`platform?: DropPlatform

`Optional`global?: boolean

`Optional`kick?: boolean

`Optional`twitch?: boolean