Class OneSDK

Constructors

constructor

new OneSDK(): OneSDK
Returns OneSDK

Properties

usePermission

usePermission: (
    templateNames: (
        | "DEFAULT"
        | "COMMENT"
        | "META"
        | "ORDER"
        | "REACTION"
        | "SETLIST"
        | "WORDPAETY"
        | "YT_SURVEY"
        | "CONFIG"
        | "SERVICE"
        | "USER"
        | "NOTIFICATION"
    )[],
    base?: SendType[],
) => SendType[] = usePermission

Accessors

config

get config(): Readonly<OneSDKConfig>
Returns Readonly<OneSDKConfig>

connected

get connected(): boolean
Returns boolean

PERM

get PERM(): {
    COMMENT: "COMMENT";
    CONFIG: "CONFIG";
    DEFAULT: "DEFAULT";
    META: "META";
    NOTIFICATION: "NOTIFICATION";
    ORDER: "ORDER";
    REACTION: "REACTION";
    SERVICE: "SERVICE";
    SETLIST: "SETLIST";
    USER: "USER";
    WORDPAETY: "WORDPAETY";
    YT_SURVEY: "YT_SURVEY";
}
Returns {
    COMMENT: "COMMENT";
    CONFIG: "CONFIG";
    DEFAULT: "DEFAULT";
    META: "META";
    NOTIFICATION: "NOTIFICATION";
    ORDER: "ORDER";
    REACTION: "REACTION";
    SERVICE: "SERVICE";
    SETLIST: "SETLIST";
    USER: "USER";
    WORDPAETY: "WORDPAETY";
    YT_SURVEY: "YT_SURVEY";
}

Methods

cancelOrder

cancelOrder(orderId: string): Promise<OrderItem[]>
Parameters
- orderId: string
Returns Promise<OrderItem[]>

checkLicensed

checkLicensed(): Promise<boolean>
Returns Promise<boolean>

completeOrder

completeOrder(orderId: string): Promise<OrderItem[]>
Parameters
- orderId: string
Returns Promise<OrderItem[]>

connect

connect(): Promise<void>
Returns Promise<void>

delete

delete<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>
Type Parameters
- T = any
- R = AxiosResponse<T, any>
- D = any
Parameters
- url: string
- Optionalconfig: AxiosRequestConfig<D>
Returns Promise<R>

get

get<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>
Type Parameters
- T = any
- R = AxiosResponse<T, any>
- D = any
Parameters
- url: string
- Optionalconfig: AxiosRequestConfig<D>
Returns Promise<R>

getComments

getComments(): Promise<Comment[]>
Returns Promise<Comment[]>

getCommentStyle

getCommentStyle(comment: Comment): { [key: string]: any }
Parameters
- comment: Comment
Returns { [key: string]: any }

getConfig

getConfig(): Promise<Config[]>
Returns Promise<Config[]>

getInfo

getInfo(): Promise<AppInfo>
Returns Promise<AppInfo>

getOrders

getOrders(): Promise<OrderItem[]>
Returns Promise<OrderItem[]>

getPinnedComment

getPinnedComment(): Promise<null | Comment>
Returns Promise<null | Comment>

getServices

getServices(): Promise<Service[]>
Returns Promise<Service[]>

getSetList

getSetList(): Promise<SetListAPIResponse>
Returns Promise<SetListAPIResponse>

getStyleVariable

getStyleVariable<T = any>(
    name: string,
    defaultValue: T,
    parser?: (val: string) => T,
): T
Type Parameters
- T = any
Parameters
- name: string
- defaultValue: T
- parser: (val: string) => T = ...
Returns T

getTemplates

getTemplates(): Promise<TemplateData[]>
Returns Promise<TemplateData[]>

post

post<T = any, R = AxiosResponse<T, any>, D = any>(
    url: string,
    data?: D,
    config?: AxiosRequestConfig<D>,
): Promise<R>
Type Parameters
- T = any
- R = AxiosResponse<T, any>
- D = any
Parameters
- url: string
- Optionaldata: D
- Optionalconfig: AxiosRequestConfig<D>
Returns Promise<R>

put

put<T = any, R = AxiosResponse<T, any>, D = any>(
    url: string,
    data?: D,
    config?: AxiosRequestConfig<D>,
): Promise<R>
Type Parameters
- T = any
- R = AxiosResponse<T, any>
- D = any
Parameters
- url: string
- Optionaldata: D
- Optionalconfig: AxiosRequestConfig<D>
Returns Promise<R>

ready

ready(): Promise<void>
Returns Promise<void>

reset

reset(): void
Returns void

searchComments

searchComments(
params: { comments: string[]; services: string[] },
): Promise<Comment[]>
Parameters
- params: { comments: string[]; services: string[] }
Returns Promise<Comment[]>

setup

setup(op?: Partial<OneSDKConfig>): Promise<void>
Parameters
- op: Partial<OneSDKConfig> = {}
Returns Promise<void>

subscribe<T extends Subscriber<SendType>>(subscriber: T): number
Type Parameters
- T extends Subscriber<SendType>
Parameters
- subscriber: T
Returns number

toNumberFromShortNumberFormat

toNumberFromShortNumberFormat(str: string): number
Parameters
- str: string
Returns number

toShortNumberFormat

toShortNumberFormat(num: number): string | number
Parameters
- num: number
Returns string | number

unsubscribe

unsubscribe(subscriberId: number): void
Parameters
- subscriberId: number
Returns void