glitch-javascript-sdk 1.2.7 → 1.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/index.js CHANGED
@@ -19766,6 +19766,31 @@ var CommunitiesRoute = /** @class */ (function () {
19766
19766
  updateEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}', method: HTTP_METHODS.PUT },
19767
19767
  deleteEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}', method: HTTP_METHODS.DELETE },
19768
19768
  populateEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}/populate', method: HTTP_METHODS.POST },
19769
+ // Newsletters
19770
+ listNewsletters: { url: '/communities/{community_id}/newsletters', method: HTTP_METHODS.GET },
19771
+ createNewsletter: { url: '/communities/{community_id}/newsletters', method: HTTP_METHODS.POST },
19772
+ viewNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.GET },
19773
+ updateNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.PUT },
19774
+ deleteNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.DELETE },
19775
+ importNewsletterSubscribers: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/import', method: HTTP_METHODS.POST },
19776
+ uploadNewsletterBannerImage: { url: '/communities/{community_id}/newsletters/{newsletter_id}/uploadBannerImage', method: HTTP_METHODS.POST },
19777
+ // Campaigns
19778
+ listCampaigns: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns', method: HTTP_METHODS.GET },
19779
+ createCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns', method: HTTP_METHODS.POST },
19780
+ viewCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.GET },
19781
+ updateCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.PUT },
19782
+ deleteCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.DELETE },
19783
+ sendCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/send', method: HTTP_METHODS.POST },
19784
+ scheduleCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/schedule', method: HTTP_METHODS.POST },
19785
+ // Emails
19786
+ listCampaignEmails: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/emails', method: HTTP_METHODS.GET },
19787
+ // Subscribers (admin routes)
19788
+ listNewsletterSubscribers: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers', method: HTTP_METHODS.GET },
19789
+ viewNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.GET },
19790
+ updateNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.PUT },
19791
+ deleteNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.DELETE },
19792
+ // Subscriber registration (open route)
19793
+ registerNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers', method: HTTP_METHODS.POST },
19769
19794
  };
19770
19795
  return CommunitiesRoute;
19771
19796
  }());
@@ -20196,6 +20221,258 @@ var Communities = /** @class */ (function () {
20196
20221
  Communities.populateEmailTemplate = function (community_id, template_id, data, params) {
20197
20222
  return Requests.processRoute(CommunitiesRoute.routes.populateEmailTemplate, data, { community_id: community_id, template_id: template_id }, params);
20198
20223
  };
20224
+ /**
20225
+ * List all newsletters for a community.
20226
+ *
20227
+ * @param community_id The ID of the community.
20228
+ * @param params Query parameters.
20229
+ * @returns Promise
20230
+ */
20231
+ Communities.listNewsletters = function (community_id, params) {
20232
+ return Requests.processRoute(CommunitiesRoute.routes.listNewsletters, undefined, { community_id: community_id }, params);
20233
+ };
20234
+ /**
20235
+ * Create a new newsletter for a community.
20236
+ *
20237
+ * @param community_id The ID of the community.
20238
+ * @param data The data for the new newsletter.
20239
+ * @returns Promise
20240
+ */
20241
+ Communities.createNewsletter = function (community_id, data, params) {
20242
+ return Requests.processRoute(CommunitiesRoute.routes.createNewsletter, data, { community_id: community_id }, params);
20243
+ };
20244
+ /**
20245
+ * Get a specific newsletter.
20246
+ *
20247
+ * @param community_id The ID of the community.
20248
+ * @param newsletter_id The ID of the newsletter.
20249
+ * @param params Query parameters.
20250
+ * @returns Promise
20251
+ */
20252
+ Communities.viewNewsletter = function (community_id, newsletter_id, params) {
20253
+ return Requests.processRoute(CommunitiesRoute.routes.viewNewsletter, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
20254
+ };
20255
+ /**
20256
+ * Update a specific newsletter.
20257
+ *
20258
+ * @param community_id The ID of the community.
20259
+ * @param newsletter_id The ID of the newsletter.
20260
+ * @param data The data to update.
20261
+ * @returns Promise
20262
+ */
20263
+ Communities.updateNewsletter = function (community_id, newsletter_id, data, params) {
20264
+ return Requests.processRoute(CommunitiesRoute.routes.updateNewsletter, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
20265
+ };
20266
+ /**
20267
+ * Delete a specific newsletter.
20268
+ *
20269
+ * @param community_id The ID of the community.
20270
+ * @param newsletter_id The ID of the newsletter.
20271
+ * @returns Promise
20272
+ */
20273
+ Communities.deleteNewsletter = function (community_id, newsletter_id, params) {
20274
+ return Requests.processRoute(CommunitiesRoute.routes.deleteNewsletter, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
20275
+ };
20276
+ /**
20277
+ * Import subscribers from a CSV or XLS file into a newsletter.
20278
+ *
20279
+ * @param community_id The ID of the community.
20280
+ * @param newsletter_id The ID of the newsletter.
20281
+ * @param file The CSV or XLS file.
20282
+ * @param params Additional parameters.
20283
+ * @returns Promise
20284
+ */
20285
+ Communities.importNewsletterSubscribers = function (community_id, newsletter_id, file, data, params) {
20286
+ var url = CommunitiesRoute.routes.importNewsletterSubscribers.url
20287
+ .replace('{community_id}', community_id)
20288
+ .replace('{newsletter_id}', newsletter_id);
20289
+ return Requests.uploadFile(url, 'file', file, data, params);
20290
+ };
20291
+ /**
20292
+ * Updates the banner image for the game show using a File object.
20293
+ *
20294
+ * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
20295
+ *
20296
+ * @param file The file object to upload.
20297
+ * @param data Any additional data to pass along to the upload.
20298
+ *
20299
+ * @returns promise
20300
+ */
20301
+ Communities.uploadNewsletterBannerImageFile = function (community_id, newsletter_id, file, data, params) {
20302
+ var url = CommunitiesRoute.routes.uploadNewsletterBannerImage.url
20303
+ .replace('{community_id}', community_id)
20304
+ .replace('{newsletter_id}', newsletter_id);
20305
+ return Requests.uploadFile(url, 'image', file, data);
20306
+ };
20307
+ /**
20308
+ * Updates the banner image for the game show using a Blob.
20309
+ *
20310
+ * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
20311
+ *
20312
+ * @param blob The blob to upload.
20313
+ * @param data Any additional data to pass along to the upload
20314
+ *
20315
+ * @returns promise
20316
+ */
20317
+ Communities.uploadNewsletterBannerImageBlob = function (community_id, newsletter_id, blob, data, params) {
20318
+ var url = CommunitiesRoute.routes.uploadNewsletterBannerImage.url
20319
+ .replace('{community_id}', community_id)
20320
+ .replace('{newsletter_id}', newsletter_id);
20321
+ return Requests.uploadBlob(url, 'image', blob, data);
20322
+ };
20323
+ // Campaigns
20324
+ /**
20325
+ * List all campaigns for a newsletter.
20326
+ *
20327
+ * @param community_id The ID of the community.
20328
+ * @param newsletter_id The ID of the newsletter.
20329
+ * @param params Query parameters.
20330
+ * @returns Promise
20331
+ */
20332
+ Communities.listCampaigns = function (community_id, newsletter_id, params) {
20333
+ return Requests.processRoute(CommunitiesRoute.routes.listCampaigns, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
20334
+ };
20335
+ /**
20336
+ * Create a new campaign for a newsletter.
20337
+ *
20338
+ * @param community_id The ID of the community.
20339
+ * @param newsletter_id The ID of the newsletter.
20340
+ * @param data The data for the new campaign.
20341
+ * @returns Promise
20342
+ */
20343
+ Communities.createCampaign = function (community_id, newsletter_id, data, params) {
20344
+ return Requests.processRoute(CommunitiesRoute.routes.createCampaign, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
20345
+ };
20346
+ /**
20347
+ * Get a specific campaign.
20348
+ *
20349
+ * @param community_id The ID of the community.
20350
+ * @param newsletter_id The ID of the newsletter.
20351
+ * @param campaign_id The ID of the campaign.
20352
+ * @param params Query parameters.
20353
+ * @returns Promise
20354
+ */
20355
+ Communities.viewCampaign = function (community_id, newsletter_id, campaign_id, params) {
20356
+ return Requests.processRoute(CommunitiesRoute.routes.viewCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20357
+ };
20358
+ /**
20359
+ * Update a specific campaign.
20360
+ *
20361
+ * @param community_id The ID of the community.
20362
+ * @param newsletter_id The ID of the newsletter.
20363
+ * @param campaign_id The ID of the campaign.
20364
+ * @param data The data to update.
20365
+ * @returns Promise
20366
+ */
20367
+ Communities.updateCampaign = function (community_id, newsletter_id, campaign_id, data, params) {
20368
+ return Requests.processRoute(CommunitiesRoute.routes.updateCampaign, data, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20369
+ };
20370
+ /**
20371
+ * Delete a specific campaign.
20372
+ *
20373
+ * @param community_id The ID of the community.
20374
+ * @param newsletter_id The ID of the newsletter.
20375
+ * @param campaign_id The ID of the campaign.
20376
+ * @returns Promise
20377
+ */
20378
+ Communities.deleteCampaign = function (community_id, newsletter_id, campaign_id, params) {
20379
+ return Requests.processRoute(CommunitiesRoute.routes.deleteCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20380
+ };
20381
+ /**
20382
+ * Send a campaign immediately.
20383
+ *
20384
+ * @param community_id The ID of the community.
20385
+ * @param newsletter_id The ID of the newsletter.
20386
+ * @param campaign_id The ID of the campaign.
20387
+ * @returns Promise
20388
+ */
20389
+ Communities.sendCampaign = function (community_id, newsletter_id, campaign_id, params) {
20390
+ return Requests.processRoute(CommunitiesRoute.routes.sendCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20391
+ };
20392
+ /**
20393
+ * Schedule a campaign to be sent later.
20394
+ *
20395
+ * @param community_id The ID of the community.
20396
+ * @param newsletter_id The ID of the newsletter.
20397
+ * @param campaign_id The ID of the campaign.
20398
+ * @param data The scheduling data (e.g., scheduled_at).
20399
+ * @returns Promise
20400
+ */
20401
+ Communities.scheduleCampaign = function (community_id, newsletter_id, campaign_id, data, params) {
20402
+ return Requests.processRoute(CommunitiesRoute.routes.scheduleCampaign, data, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20403
+ };
20404
+ // Emails
20405
+ /**
20406
+ * List all emails sent in a campaign.
20407
+ *
20408
+ * @param community_id The ID of the community.
20409
+ * @param newsletter_id The ID of the newsletter.
20410
+ * @param campaign_id The ID of the campaign.
20411
+ * @param params Query parameters.
20412
+ * @returns Promise
20413
+ */
20414
+ Communities.listCampaignEmails = function (community_id, newsletter_id, campaign_id, params) {
20415
+ return Requests.processRoute(CommunitiesRoute.routes.listCampaignEmails, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
20416
+ };
20417
+ // Subscribers (admin routes)
20418
+ /**
20419
+ * List all subscribers of a newsletter (admin only).
20420
+ *
20421
+ * @param community_id The ID of the community.
20422
+ * @param newsletter_id The ID of the newsletter.
20423
+ * @param params Query parameters.
20424
+ * @returns Promise
20425
+ */
20426
+ Communities.listNewsletterSubscribers = function (community_id, newsletter_id, params) {
20427
+ return Requests.processRoute(CommunitiesRoute.routes.listNewsletterSubscribers, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
20428
+ };
20429
+ /**
20430
+ * Get a specific subscriber of a newsletter (admin only).
20431
+ *
20432
+ * @param community_id The ID of the community.
20433
+ * @param newsletter_id The ID of the newsletter.
20434
+ * @param subscriber_id The ID of the subscriber.
20435
+ * @param params Query parameters.
20436
+ * @returns Promise
20437
+ */
20438
+ Communities.viewNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, params) {
20439
+ return Requests.processRoute(CommunitiesRoute.routes.viewNewsletterSubscriber, undefined, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
20440
+ };
20441
+ /**
20442
+ * Update a specific subscriber of a newsletter (admin only).
20443
+ *
20444
+ * @param community_id The ID of the community.
20445
+ * @param newsletter_id The ID of the newsletter.
20446
+ * @param subscriber_id The ID of the subscriber.
20447
+ * @param data The data to update.
20448
+ * @returns Promise
20449
+ */
20450
+ Communities.updateNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, data, params) {
20451
+ return Requests.processRoute(CommunitiesRoute.routes.updateNewsletterSubscriber, data, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
20452
+ };
20453
+ /**
20454
+ * Delete a specific subscriber from a newsletter (admin only).
20455
+ *
20456
+ * @param community_id The ID of the community.
20457
+ * @param newsletter_id The ID of the newsletter.
20458
+ * @param subscriber_id The ID of the subscriber.
20459
+ * @returns Promise
20460
+ */
20461
+ Communities.deleteNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, params) {
20462
+ return Requests.processRoute(CommunitiesRoute.routes.deleteNewsletterSubscriber, undefined, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
20463
+ };
20464
+ // Subscriber registration (open route)
20465
+ /**
20466
+ * Register a new subscriber to a newsletter.
20467
+ *
20468
+ * @param community_id The ID of the community.
20469
+ * @param newsletter_id The ID of the newsletter.
20470
+ * @param data The subscriber data.
20471
+ * @returns Promise
20472
+ */
20473
+ Communities.registerNewsletterSubscriber = function (community_id, newsletter_id, data, params) {
20474
+ return Requests.processRoute(CommunitiesRoute.routes.registerNewsletterSubscriber, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
20475
+ };
20199
20476
  return Communities;
20200
20477
  }());
20201
20478
 
@@ -23648,6 +23925,12 @@ var GameShowsRoute = /** @class */ (function () {
23648
23925
  delete: { url: '/gameshows/{show_id}', method: HTTP_METHODS.DELETE },
23649
23926
  uploadLogo: { url: '/gameshows/{show_id}/uploadLogo', method: HTTP_METHODS.POST },
23650
23927
  uploadBannerImage: { url: '/gameshows/{show_id}/uploadBannerImage', method: HTTP_METHODS.POST },
23928
+ registerTitle: { url: '/gameshows/{show_id}/registerTitle', method: HTTP_METHODS.POST },
23929
+ listTitles: { url: '/gameshows/{show_id}/titles', method: HTTP_METHODS.GET },
23930
+ addTitle: { url: '/gameshows/{show_id}/addTitle', method: HTTP_METHODS.POST },
23931
+ viewTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.GET },
23932
+ updateTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.PUT },
23933
+ deleteTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.DELETE },
23651
23934
  };
23652
23935
  return GameShowsRoute;
23653
23936
  }());
@@ -23769,6 +24052,42 @@ var GameShows = /** @class */ (function () {
23769
24052
  var url = GameShowsRoute.routes.uploadBannerImage.url.replace('{show_id}', show_id);
23770
24053
  return Requests.uploadBlob(url, 'image', blob, data);
23771
24054
  };
24055
+ /**
24056
+ * Register a title to a game show.
24057
+ */
24058
+ GameShows.registerTitle = function (show_id, data, params) {
24059
+ return Requests.processRoute(GameShowsRoute.routes.registerTitle, data, { show_id: show_id }, params);
24060
+ };
24061
+ /**
24062
+ * Add a title to a game show by admin.
24063
+ */
24064
+ GameShows.addTitle = function (show_id, data, params) {
24065
+ return Requests.processRoute(GameShowsRoute.routes.addTitle, data, { show_id: show_id }, params);
24066
+ };
24067
+ /**
24068
+ * List all titles for a game show.
24069
+ */
24070
+ GameShows.listTitles = function (show_id, params) {
24071
+ return Requests.processRoute(GameShowsRoute.routes.listTitles, {}, { show_id: show_id }, params);
24072
+ };
24073
+ /**
24074
+ * Get details of a specific title in a game show.
24075
+ */
24076
+ GameShows.getTitle = function (show_id, title_id, params) {
24077
+ return Requests.processRoute(GameShowsRoute.routes.getTitle, {}, { show_id: show_id, title_id: title_id }, params);
24078
+ };
24079
+ /**
24080
+ * Update a specific title in a game show.
24081
+ */
24082
+ GameShows.updateTitle = function (show_id, title_id, data, params) {
24083
+ return Requests.processRoute(GameShowsRoute.routes.updateTitle, data, { show_id: show_id, title_id: title_id }, params);
24084
+ };
24085
+ /**
24086
+ * Delete a specific title from a game show.
24087
+ */
24088
+ GameShows.deleteTitle = function (show_id, title_id, params) {
24089
+ return Requests.processRoute(GameShowsRoute.routes.deleteTitle, {}, { show_id: show_id, title_id: title_id }, params);
24090
+ };
23772
24091
  return GameShows;
23773
24092
  }());
23774
24093