Constructors
Methods
changePremiumData
- changePremiumData<T>(__namedParameters): Promise<WebResponse<true>>
Type Parameters
- T extends "user" | "guild" = never
Parameters
- __namedParameters: {
auth: string;
body: UpdatePremiumData<T>;
id: string;
type: T;
}auth: string
id: string
type: T
Returns Promise<WebResponse<true>>
createCheckoutSession
- createCheckoutSession<T>(__namedParameters): Promise<WebResponse<string>>
Type Parameters
- T extends "user" | "guild"
Returns Promise<WebResponse<string>>
createSubscriptionManagePortalUrl
- createSubscriptionManagePortalUrl(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
data: PortalData;
}
Returns Promise<WebResponse<string>>
deletePremiumPlan
- deletePremiumPlan(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
planId: string;
}auth: string
planId: string
Returns Promise<WebResponse<string>>
getPremiumPlan
- getPremiumPlan<T>(__namedParameters): Promise<WebResponse<PremiumPlan<T>>>
Parameters
- __namedParameters: {
includeFreeConnectionsDefault?: T;
planId: string;
}Optional
includeFreeConnectionsDefault?: T
planId: string
getPremiumPlans
- getPremiumPlans(__namedParameters): Promise<WebResponse<PremiumPlans>>
Parameters
- __namedParameters: {
refreshCache?: boolean;
}Optional
refreshCache?: boolean
getPremumData
- getPremumData<T>(__namedParameters): Promise<WebResponse<PremiumData<T>>>
Type Parameters
- T extends "user" | "guild" = never
Parameters
- __namedParameters: {
auth: string;
id: string;
type: T;
}auth: string
id: string
type: T
updatePremiumPlan
- updatePremiumPlan(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
plan: DeepPartial<DeepRequiredRemoveNull<{
bitfield: string;
cents: number;
colorScheme?: null | string;
defaultAutoLiveRoles?: null | number;
defaultConnections?: null | number;
defaultOverrides?: null | number;
defaultStatusRoles?: null | number;
defaultStickyMessages?: null | number;
description: string;
enabled: boolean;
highlighted?: null | boolean;
id: string;
isShown: boolean;
maxAllowedVodDurationToSave?: null | number;
maxAmountOfStreamersSavingVods?: null | number;
name: string;
onSaleTag?: null | boolean;
roleInSupportServer?: null | string;
showDecreasedPrice?: null | string;
type: "user" | "guild";
userPremiumServerPremium?: null | string;
}>, true>;
planId: string;
}auth: string
plan: DeepPartial<DeepRequiredRemoveNull<{
bitfield: string;
cents: number;
colorScheme?: null | string;
defaultAutoLiveRoles?: null | number;
defaultConnections?: null | number;
defaultOverrides?: null | number;
defaultStatusRoles?: null | number;
defaultStickyMessages?: null | number;
description: string;
enabled: boolean;
highlighted?: null | boolean;
id: string;
isShown: boolean;
maxAllowedVodDurationToSave?: null | number;
maxAmountOfStreamersSavingVods?: null | number;
name: string;
onSaleTag?: null | boolean;
roleInSupportServer?: null | string;
showDecreasedPrice?: null | string;
type: "user" | "guild";
userPremiumServerPremium?: null | string;
}>, true>
planId: string
Returns Promise<WebResponse<string>>