Class default

Index

Constructors

Methods

acceptInvite addPaymentMethod addUser clearDocusignAuth clearHellosignAuth clearSimplesignAuth create createCampaign createEmailTemplate createNewsletter delete deleteCampaign deleteEmailTemplate deleteNewsletter deleteNewsletterSubscriber exportNewsletterSubscribers findByDomain getLedger getPaymentMethods getUser importGameInstalls importNewsletterSubscribers join list listCampaignEmails listCampaigns listEmailTemplates listInvites listNewsletterSubscribers listNewsletters listUsers newsletterCampaignReports newsletterReports newsletterSubscriberTrend populateEmailTemplate registerNewsletterSubscriber removetUser retrieveInvite scheduleCampaign sendCampaign sendInvite setDefaultPaymentMethod testCampaign update updateCampaign updateEmailTemplate updateNewsletter updateNewsletterSubscriber updatetUser uploadBannerImageBlob uploadBannerImageFile uploadLogoBlob uploadLogoFile uploadNewsletterBannerImageBlob uploadNewsletterBannerImageFile uploadVideoLogoBlob uploadVideoLogoFile view viewCampaign viewEmailTemplate viewNewsletter viewNewsletterSubscriber

Constructors

constructor

new default(): default
Returns default

Methods

`Static` acceptInvite

acceptInvite<T>(community_id, token, params?): AxiosPromise<default<T>>
Accept an invite to a community. The JSON Web Token (JWT) must be related to the token.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community
- token: string
  The token required to accept the user.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communityAcceptInvite
- Defined in api/Communities.ts:214

`Static` addPaymentMethod

addPaymentMethod<T>(community_id, data, params?): AxiosPromise<default<T>>
Add a payment method to the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to update.
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/51802cc0cb758850807345918130cf3e
- Defined in api/Communities.ts:331

`Static` addUser

addUser<T>(community_id, data?, params?): AxiosPromise<default<T>>
Add a user to a community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community.
- Optional data: object
  The data to be passed when adding a user.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/createcommunityUser
- Defined in api/Communities.ts:255

`Static` clearDocusignAuth

clearDocusignAuth<T>(community_id): AxiosPromise<default<T>>
Clear Docusign authentication information from the current user.
Type Parameters
- T
Parameters
- community_id: string
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Users%20Route/userCreateDonationPage
- Defined in api/Communities.ts:383

`Static` clearHellosignAuth

clearHellosignAuth<T>(community_id): AxiosPromise<default<T>>
Clear SimpleSin authentication information from the current user.
Type Parameters
- T
Parameters
- community_id: string
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Users%20Route/userCreateDonationPage
- Defined in api/Communities.ts:407

`Static` clearSimplesignAuth

clearSimplesignAuth<T>(community_id): AxiosPromise<default<T>>
Clear SimpleSin authentication information from the current user.
Type Parameters
- T
Parameters
- community_id: string
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Users%20Route/userCreateDonationPage
- Defined in api/Communities.ts:395

`Static` create

create<T>(data, params?): AxiosPromise<default<T>>
Create a new community.
Type Parameters
- T
Parameters
- data: object
  The data to be passed when creating a community.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/newCommunityResourceStorage
- Defined in api/Communities.ts:28

`Static` createCampaign

createCampaign<T>(community_id, newsletter_id, data, params?): AxiosPromise<default<T>>
Create a new campaign for a newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- data: object
  The data for the new campaign.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:630

`Static` createEmailTemplate

createEmailTemplate<T>(community_id, data, params?): AxiosPromise<default<T>>
Create a new email template for the community
Type Parameters
- T
Parameters
- community_id: string
- data: object
  The data to be passed when creating a community.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/newCommunityResourceStorage
- Defined in api/Communities.ts:432

`Static` createNewsletter

createNewsletter<T>(community_id, data, params?): AxiosPromise<default<T>>
Create a new newsletter for a community.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- data: object
  The data for the new newsletter.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:511

`Static` delete

delete<T>(community_id, params?): AxiosPromise<default<T>>
Deletes a community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to delete.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/destoryCommunityStorage
- Defined in api/Communities.ts:70

`Static` deleteCampaign

deleteCampaign<T>(community_id, newsletter_id, campaign_id, params?): AxiosPromise<default<T>>
Delete a specific campaign.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:668

`Static` deleteEmailTemplate

deleteEmailTemplate<T>(community_id, template_id, params?): AxiosPromise<default<T>>
Deletes an email template for the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to delete.
- template_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/destoryCommunityStorage
- Defined in api/Communities.ts:474

`Static` deleteNewsletter

deleteNewsletter<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
Delete a specific newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:546

`Static` deleteNewsletterSubscriber

deleteNewsletterSubscriber<T>(community_id, newsletter_id, subscriber_id, params?): AxiosPromise<default<T>>
Delete a specific subscriber from a newsletter (admin only).
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- subscriber_id: string
  The ID of the subscriber.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:773

`Static` exportNewsletterSubscribers

exportNewsletterSubscribers<T>(community_id, newsletter_id, data, params?): AxiosPromise<default<T>>
Export subscribers for a specific newsletter. The file is generated asynchronously on the server and the user is emailed a link to download the file.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- data: {
  format: "csv" | "xlsx";
  }
  Export options (format: 'csv' or 'xlsx').
  - format: "csv" | "xlsx"
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:863

`Static` findByDomain

findByDomain<T>(domain, params?): AxiosPromise<default<T>>
Finds a community either by its subdomain or cname. The cname must be active.
Type Parameters
- T
Parameters
- domain: string
  The subcname of the community.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise
- Defined in api/Communities.ts:304

`Static` getLedger

getLedger<T>(community_id, params?): AxiosPromise<default<T>>
Get the ledger for all transactions from the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communitysUserInviteList
- Defined in api/Communities.ts:372

`Static` getPaymentMethods

getPaymentMethods<T>(community_id, params?): AxiosPromise<default<T>>
Get the available payment methods.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communitysUserInviteList
- Defined in api/Communities.ts:359

`Static` getUser

getUser<T>(community_id, user_id, params?): AxiosPromise<default<T>>
Retrieves a single user and their information that is associated with a community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community.
- user_id: string
  The id of the user.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/showcommunityUser
- Defined in api/Communities.ts:269

`Static` importGameInstalls

importGameInstalls<T>(community_id, newsletter_id, data, params?): AxiosPromise<default<T>>
Import game installs from a game title installations to a newsletter
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- data: {
  format: "csv" | "xlsx";
  }
  Export options (format: 'csv' or 'xlsx').
  - format: "csv" | "xlsx"
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:885

`Static` importNewsletterSubscribers

importNewsletterSubscribers<T>(community_id, newsletter_id, file, data?, params?): AxiosPromise<default<T>>
Import subscribers from a CSV or XLS file into a newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- file: File
  The CSV or XLS file.
- Optional data: object
- Optional params: Record<string, any>
  Additional parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:559

`Static` join

join<T>(community_id, data, params?): AxiosPromise<default<T>>
Has a user join a community. The join is executed using the current user's authentication token.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to update.
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/updateCommunityStorage
- Defined in api/Communities.ts:317

`Static` list

list<T>(params?): AxiosPromise<default<T>>
List all the communities.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/resourceCommunityList
- Defined in api/Communities.ts:15

`Static` listCampaignEmails

listCampaignEmails<T>(community_id, newsletter_id, campaign_id, params?): AxiosPromise<default<T>>
List all emails sent in a campaign.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:721

`Static` listCampaigns

listCampaigns<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
List all campaigns for a newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:618

`Static` listEmailTemplates

listEmailTemplates<T>(community_id, params?): AxiosPromise<default<T>>
List all the saved email templates for the community.
Type Parameters
- T
Parameters
- community_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/resourceCommunityList
- Defined in api/Communities.ts:419

`Static` listInvites

listInvites<T>(community_id, params?): AxiosPromise<default<T>>
List the invites that have been sent for the community to users.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communitysUserInviteList
- Defined in api/Communities.ts:186

`Static` listNewsletterSubscribers

listNewsletterSubscribers<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
List all subscribers of a newsletter (admin only).
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:735

`Static` listNewsletters

listNewsletters<T>(params?): AxiosPromise<default<T>>
List all newsletters for a community.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:500

`Static` listUsers

listUsers<T>(community_id, params?): AxiosPromise<default<T>>
List the users who are currently associated with the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communityUserList
- Defined in api/Communities.ts:241

`Static` newsletterCampaignReports

newsletterCampaignReports<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
Get campaign-level stats for a newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
  Optional query params (start_date, end_date, etc).
Returns AxiosPromise<default<T>>
Promise with campaign stats
- Defined in api/Communities.ts:820

`Static` newsletterReports

newsletterReports<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
Get newsletter overall reports (subscriber changes, unsubscribes, etc.).
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
  Optional query params (start_date, end_date, etc).
Returns AxiosPromise<default<T>>
Promise with aggregated data
- Defined in api/Communities.ts:799

`Static` newsletterSubscriberTrend

newsletterSubscriberTrend<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
Retrieves daily subscriber trend data for the specified newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The UUID of the community
- newsletter_id: string
  The UUID of the newsletter
- Optional params: Record<string, any>
  Optional date-range filter (start_date, end_date, etc.)
Returns AxiosPromise<default<T>>
- Defined in api/Communities.ts:840

`Static` populateEmailTemplate

populateEmailTemplate<T>(community_id, template_id, data, params?): AxiosPromise<default<T>>
Populates an email template for the community that will replace the platholders with the data provided.
Type Parameters
- T
Parameters
- community_id: string
- template_id: string
- data: object
  The data to be passed when creating a community.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/newCommunityResourceStorage
- Defined in api/Communities.ts:488

`Static` registerNewsletterSubscriber

registerNewsletterSubscriber<T>(community_id, newsletter_id, data, params?): AxiosPromise<default<T>>
Register a new subscriber to a newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- data: object
  The subscriber data.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:787

`Static` removetUser

removetUser<T>(community_id, user_id, params?): AxiosPromise<default<T>>
Removes a user from a community.
Type Parameters
- T
Parameters
- community_id: string
  The id of community.
- user_id: string
  The id of the user.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise
- Defined in api/Communities.ts:293

`Static` retrieveInvite

retrieveInvite<T>(community_id, token, params?): AxiosPromise<default<T>>
Retrieves a user's invite that have been sent.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community
- token: string
  The token required to get the invite.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communityAcceptInvite
- Defined in api/Communities.ts:228

`Static` scheduleCampaign

scheduleCampaign<T>(community_id, newsletter_id, campaign_id, data, params?): AxiosPromise<default<T>>
Schedule a campaign to be sent later.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- data: object
  The scheduling data (e.g., scheduled_at).
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:693

`Static` sendCampaign

sendCampaign<T>(community_id, newsletter_id, campaign_id, params?): AxiosPromise<default<T>>
Send a campaign immediately.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:680

`Static` sendInvite

sendInvite<T>(community_id, data?, params?): AxiosPromise<default<T>>
Send an invitation to a user to join the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community.
- Optional data: object
  The data that will be passed into sending an invite.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/communitys%20Route/communitySendInvite
- Defined in api/Communities.ts:200

`Static` setDefaultPaymentMethod

setDefaultPaymentMethod<T>(community_id, data, params?): AxiosPromise<default<T>>
Sets the default payment method for the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to update.
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/dd743e8a7da3b2bebe557cbc6675380d
- Defined in api/Communities.ts:345

`Static` testCampaign

testCampaign<T>(community_id, newsletter_id, campaign_id, data, params?): AxiosPromise<default<T>>
Test an email campaign by sending an email to the current user.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- data: object
  The scheduling data (e.g., scheduled_at).
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:706

`Static` update

update<T>(community_id, data, params?): AxiosPromise<default<T>>
Update a community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to update.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/updateCommunityStorage
- Defined in api/Communities.ts:43

`Static` updateCampaign

updateCampaign<T>(community_id, newsletter_id, campaign_id, data, params?): AxiosPromise<default<T>>
Update a specific campaign.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:656

`Static` updateEmailTemplate

updateEmailTemplate<T>(community_id, template_id, data, params?): AxiosPromise<default<T>>
Update an email template for the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community to update.
- template_id: string
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/updateCommunityStorage
- Defined in api/Communities.ts:447

`Static` updateNewsletter

updateNewsletter<T>(community_id, newsletter_id, data, params?): AxiosPromise<default<T>>
Update a specific newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:535

`Static` updateNewsletterSubscriber

updateNewsletterSubscriber<T>(community_id, newsletter_id, subscriber_id, data, params?): AxiosPromise<default<T>>
Update a specific subscriber of a newsletter (admin only).
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- subscriber_id: string
  The ID of the subscriber.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:761

`Static` updatetUser

updatetUser<T>(community_id, user_id, data?, params?): AxiosPromise<default<T>>
Updates the users information associated with the community.
Type Parameters
- T
Parameters
- community_id: string
  The id of the community.
- user_id: string
  The id of the user.
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise
- Defined in api/Communities.ts:281

`Static` uploadBannerImageBlob

uploadBannerImageBlob<T>(community_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the community using a Blob.
Type Parameters
- T
Parameters
- community_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
- Defined in api/Communities.ts:136

`Static` uploadBannerImageFile

uploadBannerImageFile<T>(community_id, file, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the community using a File object.
Type Parameters
- T
Parameters
- community_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
- Defined in api/Communities.ts:119

`Static` uploadLogoBlob

uploadLogoBlob<T>(community_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the main image for the community using a Blob.
Type Parameters
- T
Parameters
- community_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadLogoCommunityImage
- Defined in api/Communities.ts:102

`Static` uploadLogoFile

uploadLogoFile<T>(community_id, file, data?, params?): AxiosPromise<default<T>>
Updates the main image for the community using a File object.
Type Parameters
- T
Parameters
- community_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadLogoCommunityImage
- Defined in api/Communities.ts:85

`Static` uploadNewsletterBannerImageBlob

uploadNewsletterBannerImageBlob<T>(community_id, newsletter_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the game show using a Blob.
Type Parameters
- T
Parameters
- community_id: string
- newsletter_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
- Defined in api/Communities.ts:598

`Static` uploadNewsletterBannerImageFile

uploadNewsletterBannerImageFile<T>(community_id, newsletter_id, file, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the game show using a File object.
Type Parameters
- T
Parameters
- community_id: string
- newsletter_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
- Defined in api/Communities.ts:578

`Static` uploadVideoLogoBlob

uploadVideoLogoBlob<T>(community_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the community using a Blob.
Type Parameters
- T
Parameters
- community_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
- Defined in api/Communities.ts:170

`Static` uploadVideoLogoFile

uploadVideoLogoFile<T>(community_id, file, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the community using a File object.
Type Parameters
- T
Parameters
- community_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/uploadBannerCommunityImage
- Defined in api/Communities.ts:153

`Static` view

view<T>(community_id, params?): AxiosPromise<default<T>>
Retrieve the information for a single community.
Type Parameters
- T
Parameters
- community_id: string
  The id fo the community to retrieve.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/showCommunityStorage
- Defined in api/Communities.ts:57

`Static` viewCampaign

viewCampaign<T>(community_id, newsletter_id, campaign_id, params?): AxiosPromise<default<T>>
Get a specific campaign.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- campaign_id: string
  The ID of the campaign.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:643

`Static` viewEmailTemplate

viewEmailTemplate<T>(community_id, template_id, params?): AxiosPromise<default<T>>
Retrieve a single email template for the community.
Type Parameters
- T
Parameters
- community_id: string
  The id fo the community to retrieve.
- template_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Community%20Route/showCommunityStorage
- Defined in api/Communities.ts:461

`Static` viewNewsletter

viewNewsletter<T>(community_id, newsletter_id, params?): AxiosPromise<default<T>>
Get a specific newsletter.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:523

`Static` viewNewsletterSubscriber

viewNewsletterSubscriber<T>(community_id, newsletter_id, subscriber_id, params?): AxiosPromise<default<T>>
Get a specific subscriber of a newsletter (admin only).
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- newsletter_id: string
  The ID of the newsletter.
- subscriber_id: string
  The ID of the subscriber.
- Optional params: Record<string, any>
  Query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/Communities.ts:748

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static acceptInvite

Type Parameters

T

Parameters

community_id: string

token: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static addPaymentMethod

Type Parameters

T

Parameters

community_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static addUser

Type Parameters

T

Parameters

community_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static clearDocusignAuth

Type Parameters

T

Parameters

community_id: string

Returns AxiosPromise<default<T>>

See

Static clearHellosignAuth

Type Parameters

T

Parameters

community_id: string

Returns AxiosPromise<default<T>>

See

Static clearSimplesignAuth

Type Parameters

T

Parameters

community_id: string

Returns AxiosPromise<default<T>>

See

Static create

Type Parameters

T

Parameters

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static createCampaign

Type Parameters

T

Parameters

community_id: string

newsletter_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static createEmailTemplate

Type Parameters

T

Parameters

community_id: string

data: object

Optional params: Record<string, any>

`Static` acceptInvite

`Optional` params: Record<string, any>

`Static` addPaymentMethod

`Optional` params: Record<string, any>

`Static` addUser

`Optional` data: object

`Optional` params: Record<string, any>

`Static` clearDocusignAuth

`Static` clearHellosignAuth

`Static` clearSimplesignAuth

`Static` create

`Optional` params: Record<string, any>

`Static` createCampaign

`Optional` params: Record<string, any>

`Static` createEmailTemplate

`Optional` params: Record<string, any>

`Static` createNewsletter

`Optional` params: Record<string, any>

`Static` delete

`Optional` params: Record<string, any>

`Static` deleteCampaign

`Optional` params: Record<string, any>

`Static` deleteEmailTemplate

`Optional` params: Record<string, any>

`Static` deleteNewsletter

`Optional` params: Record<string, any>

`Static` deleteNewsletterSubscriber

`Optional` params: Record<string, any>

`Static` exportNewsletterSubscribers

data: {
format: "csv" | "xlsx";
}

`Optional` params: Record<string, any>

`Static` findByDomain

`Optional` params: Record<string, any>