class PlumeURL

export default class PlumeURL

The client to interact with Plume URL.

rest

createURL

deleteURL

editURL

getURL

Constructors

constructor(
options?: PlumeURLOptions
)

Constructs a new instance of the PlumeURL class

readonly
rest : PlumeURLREST

createURL(
options: CreateURLOptions
) : Promise<URLData>

Create a new shortened URL.

deleteURL(
id: string
) : Promise<void>

Delete an URL.

editURL(
id: string
options: EditURLOptions
) : Promise<void>

Edit an URL.

getURL(
id: string
) : Promise<URLData>

Get an URL.

search(
{ customId, limit, page, expired }: SearchURLOptions
) : Promise<SearchURLResults>

Search URLs.

class PlumeURL

Table of contents

Properties

Methods

Constructors

constructor(
options?: PlumeURLOptions
)

Properties

readonly
rest : PlumeURLREST

Methods

createURL(
options: CreateURLOptions
) : Promise<URLData>

deleteURL(
id: string
) : Promise<void>

editURL(
id: string
options: EditURLOptions
) : Promise<void>

getURL(
id: string
) : Promise<URLData>

search(
{ customId, limit, page, expired }: SearchURLOptions
) : Promise<SearchURLResults>

class PlumeURL

Table of contents

Properties

Methods

Constructors

constructor(options?: PlumeURLOptions)

Properties

readonlyrest : PlumeURLREST

Methods

createURL(options: CreateURLOptions) : Promise<URLData>

deleteURL(id: string) : Promise<void>

editURL(id: stringoptions: EditURLOptions) : Promise<void>

getURL(id: string) : Promise<URLData>

search({ customId, limit, page, expired }: SearchURLOptions) : Promise<SearchURLResults>

constructor(
options?: PlumeURLOptions
)

readonly
rest : PlumeURLREST

createURL(
options: CreateURLOptions
) : Promise<URLData>

deleteURL(
id: string
) : Promise<void>

editURL(
id: string
options: EditURLOptions
) : Promise<void>

getURL(
id: string
) : Promise<URLData>

search(
{ customId, limit, page, expired }: SearchURLOptions
) : Promise<SearchURLResults>