Class default

Constructors

constructor

new default(): default
Returns default

Methods

`Static` createCampaign

createCampaign<T>(data): AxiosPromise<default<T>>
Create a new newsletter campaign draft (Admin only).
Type Parameters
- T
Parameters
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:73

`Static` createSubscriber

createSubscriber<T>(data): AxiosPromise<default<T>>
Manually create a new newsletter subscriber (Admin only).
Type Parameters
- T
Parameters
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:139

`Static` deleteCampaign

deleteCampaign<T>(id): AxiosPromise<default<T>>
Delete a newsletter campaign (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:94

`Static` deleteSubscriber

deleteSubscriber<T>(id): AxiosPromise<default<T>>
Permanently delete a subscriber from the system (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:160

`Static` downloadMarketingChecklist

downloadMarketingChecklist<T>(data, params?): AxiosPromise<default<T>>
Download the list of publictions, podcasts and blogs.
Type Parameters
- T
Parameters
- data: object
  The data to be passed when creating a team.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/Newsletters/downloadMarketingChecklists
- Defined in api/Newsletters.ts:18

`Static` getCampaignLogs

getCampaignLogs<T>(id, params?): AxiosPromise<default<T>>
Get detailed delivery and open logs for a campaign (Admin only).
Type Parameters
- T
Parameters
- id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:108

`Static` getCampaignStats

getCampaignStats<T>(id): AxiosPromise<default<T>>
Get high-level analytics for a specific campaign (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:101

`Static` joinCourseWaitlist

joinCourseWaitlist<T>(data, params?): AxiosPromise<default<T>>
Join the marketing course waitlist.
Type Parameters
- T
Parameters
- data: object
  { name, email, game, topics[] }
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Newsletters.ts:30

`Static` joinDiscordMarketplaceWaitlist

joinDiscordMarketplaceWaitlist<T>(data, params?): AxiosPromise<default<T>>
Join the Discord Marketplace waitlist.
Type Parameters
- T
Parameters
- data: object
  { name, email, game, categories[] }
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:48

`Static` joinNsfwWaitlist

joinNsfwWaitlist<T>(data, params?): AxiosPromise<default<T>>
Join the NSFW/Lewd game marketing waitlist.
Type Parameters
- T
Parameters
- data: object
  { name, email, game }
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:57

`Static` joinRaffleWaitlist

joinRaffleWaitlist<T>(data, params?): AxiosPromise<default<T>>
Join the raffle feature waitlist.
Type Parameters
- T
Parameters
- data: object
  { name, email, game, prizes[], interest_in_playtesters, launch_timeline, target_wishlist_count }
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:39

`Static` listCampaigns

listCampaigns<T>(params?): AxiosPromise<default<T>>
List all newsletter campaigns (Admin only).
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:66

`Static` listSubscribers

listSubscribers<T>(params?): AxiosPromise<default<T>>
List all newsletter subscribers (Admin only).
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:132

`Static` sendCampaign

sendCampaign<T>(id): AxiosPromise<default<T>>
Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:115

`Static` sendTestEmail

sendTestEmail<T>(id, email): AxiosPromise<default<T>>
Send a test email of a campaign to a specific address (Admin only).
Type Parameters
- T
Parameters
- id: string
- email: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:122

`Static` updateCampaign

updateCampaign<T>(id, data): AxiosPromise<default<T>>
Update a newsletter campaign draft (Admin only).
Type Parameters
- T
Parameters
- id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:87

`Static` updateSubscriber

updateSubscriber<T>(id, data): AxiosPromise<default<T>>
Update a subscriber's information or status (Admin only).
Type Parameters
- T
Parameters
- id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:153

`Static` viewCampaign

viewCampaign<T>(id): AxiosPromise<default<T>>
Retrieve a specific newsletter campaign (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:80

`Static` viewSubscriber

viewSubscriber<T>(id): AxiosPromise<default<T>>
Retrieve a specific subscriber's details (Admin only).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Newsletters.ts:146

Generated using TypeDoc