glitch-javascript-sdk 2.6.2 → 2.6.3
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 +125 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Newsletters.d.ts +84 -0
- package/dist/esm/index.js +125 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/index.d.ts +84 -0
- package/package.json +1 -1
- package/src/api/Newsletters.ts +128 -0
- package/src/routes/NewslettersRoutes.ts +15 -0
package/dist/cjs/index.js
CHANGED
|
@@ -27061,6 +27061,19 @@ var NewslettersRoutes = /** @class */ (function () {
|
|
|
27061
27061
|
joinCourseWaitlist: { url: '/newsletters/joinCourseWaitlist', method: HTTP_METHODS.POST },
|
|
27062
27062
|
joinRaffleWaitlist: { url: '/newsletters/joinRaffleWaitlist', method: HTTP_METHODS.POST },
|
|
27063
27063
|
joinDiscordMarketplaceWaitlist: { url: '/newsletters/joinDiscordMarketplaceWaitlist', method: HTTP_METHODS.POST },
|
|
27064
|
+
// --- New Admin Routes ---
|
|
27065
|
+
listCampaigns: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.GET },
|
|
27066
|
+
createCampaign: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.POST },
|
|
27067
|
+
viewCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.GET },
|
|
27068
|
+
updateCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.PUT },
|
|
27069
|
+
getStats: { url: '/admin/newsletters/campaigns/{id}/stats', method: HTTP_METHODS.GET },
|
|
27070
|
+
sendCampaign: { url: '/admin/newsletters/campaigns/{id}/send', method: HTTP_METHODS.POST },
|
|
27071
|
+
listSubscribers: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.GET },
|
|
27072
|
+
// --- Subscriber Management (Admin) ---
|
|
27073
|
+
createSubscriber: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.POST },
|
|
27074
|
+
viewSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.GET },
|
|
27075
|
+
updateSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.PUT },
|
|
27076
|
+
deleteSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.DELETE },
|
|
27064
27077
|
};
|
|
27065
27078
|
return NewslettersRoutes;
|
|
27066
27079
|
}());
|
|
@@ -27105,6 +27118,118 @@ var Newsletters = /** @class */ (function () {
|
|
|
27105
27118
|
Newsletters.joinDiscordMarketplaceWaitlist = function (data, params) {
|
|
27106
27119
|
return Requests.processRoute(NewslettersRoutes.routes.joinDiscordMarketplaceWaitlist, data, undefined, params);
|
|
27107
27120
|
};
|
|
27121
|
+
/**
|
|
27122
|
+
* List all newsletter campaigns (Admin only).
|
|
27123
|
+
*
|
|
27124
|
+
* @param params Query parameters for pagination and filtering.
|
|
27125
|
+
* @returns Promise
|
|
27126
|
+
*/
|
|
27127
|
+
Newsletters.listCampaigns = function (params) {
|
|
27128
|
+
return Requests.processRoute(NewslettersRoutes.routes.listCampaigns, undefined, undefined, params);
|
|
27129
|
+
};
|
|
27130
|
+
/**
|
|
27131
|
+
* Create a new newsletter campaign draft (Admin only).
|
|
27132
|
+
*
|
|
27133
|
+
* @param data { subject, content_html, content_json }
|
|
27134
|
+
* @returns Promise
|
|
27135
|
+
*/
|
|
27136
|
+
Newsletters.createCampaign = function (data) {
|
|
27137
|
+
return Requests.processRoute(NewslettersRoutes.routes.createCampaign, data);
|
|
27138
|
+
};
|
|
27139
|
+
/**
|
|
27140
|
+
* Retrieve a specific newsletter campaign (Admin only).
|
|
27141
|
+
*
|
|
27142
|
+
* @param id The UUID of the campaign.
|
|
27143
|
+
* @returns Promise
|
|
27144
|
+
*/
|
|
27145
|
+
Newsletters.viewCampaign = function (id) {
|
|
27146
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewCampaign, undefined, { id: id });
|
|
27147
|
+
};
|
|
27148
|
+
/**
|
|
27149
|
+
* Update a newsletter campaign draft (Admin only).
|
|
27150
|
+
*
|
|
27151
|
+
* @param id The UUID of the campaign.
|
|
27152
|
+
* @param data The updated campaign data.
|
|
27153
|
+
* @returns Promise
|
|
27154
|
+
*/
|
|
27155
|
+
Newsletters.updateCampaign = function (id, data) {
|
|
27156
|
+
return Requests.processRoute(NewslettersRoutes.routes.updateCampaign, data, { id: id });
|
|
27157
|
+
};
|
|
27158
|
+
/**
|
|
27159
|
+
* Get analytics for a specific campaign (Admin only).
|
|
27160
|
+
* Returns open rates, click rates, and human vs proxy metrics.
|
|
27161
|
+
*
|
|
27162
|
+
* @param id The UUID of the campaign.
|
|
27163
|
+
* @returns Promise
|
|
27164
|
+
*/
|
|
27165
|
+
Newsletters.getCampaignStats = function (id) {
|
|
27166
|
+
return Requests.processRoute(NewslettersRoutes.routes.getStats, undefined, { id: id });
|
|
27167
|
+
};
|
|
27168
|
+
/**
|
|
27169
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
27170
|
+
*
|
|
27171
|
+
* @param id The UUID of the campaign.
|
|
27172
|
+
* @returns Promise
|
|
27173
|
+
*/
|
|
27174
|
+
Newsletters.sendCampaign = function (id) {
|
|
27175
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendCampaign, undefined, { id: id });
|
|
27176
|
+
};
|
|
27177
|
+
/**
|
|
27178
|
+
* List all newsletter subscribers (Admin only).
|
|
27179
|
+
*
|
|
27180
|
+
* @param params Query parameters for pagination and filtering.
|
|
27181
|
+
* @returns Promise
|
|
27182
|
+
*/
|
|
27183
|
+
Newsletters.listSubscribers = function (params) {
|
|
27184
|
+
return Requests.processRoute(NewslettersRoutes.routes.listSubscribers, undefined, undefined, params);
|
|
27185
|
+
};
|
|
27186
|
+
/**
|
|
27187
|
+
* Delete a newsletter campaign (Admin only).
|
|
27188
|
+
*/
|
|
27189
|
+
Newsletters.deleteCampaign = function (id) {
|
|
27190
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteCampaign, undefined, { id: id });
|
|
27191
|
+
};
|
|
27192
|
+
/**
|
|
27193
|
+
* Send a test email of a campaign to a specific address (Admin only).
|
|
27194
|
+
*/
|
|
27195
|
+
Newsletters.sendTestEmail = function (id, email) {
|
|
27196
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendTest, { email: email }, { id: id });
|
|
27197
|
+
};
|
|
27198
|
+
/**
|
|
27199
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
27200
|
+
*/
|
|
27201
|
+
Newsletters.getDetailedLogs = function (id, params) {
|
|
27202
|
+
return Requests.processRoute(NewslettersRoutes.routes.getLogs, undefined, { id: id }, params);
|
|
27203
|
+
};
|
|
27204
|
+
/**
|
|
27205
|
+
* Manually create a new subscriber (Admin only).
|
|
27206
|
+
*/
|
|
27207
|
+
Newsletters.createSubscriber = function (data) {
|
|
27208
|
+
return Requests.processRoute(NewslettersRoutes.routes.createSubscriber, data);
|
|
27209
|
+
};
|
|
27210
|
+
/**
|
|
27211
|
+
* Update a subscriber's details or status (Admin only).
|
|
27212
|
+
*/
|
|
27213
|
+
Newsletters.updateSubscriber = function (id, data) {
|
|
27214
|
+
return Requests.processRoute(NewslettersRoutes.routes.updateSubscriber, data, { id: id });
|
|
27215
|
+
};
|
|
27216
|
+
/**
|
|
27217
|
+
* Delete a subscriber (Admin only).
|
|
27218
|
+
*/
|
|
27219
|
+
Newsletters.deleteSubscriber = function (id) {
|
|
27220
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteSubscriber, undefined, { id: id });
|
|
27221
|
+
};
|
|
27222
|
+
/**
|
|
27223
|
+
* Retrieve a specific subscriber's details (Admin only).
|
|
27224
|
+
*
|
|
27225
|
+
* @see https://api.glitch.fun/api/documentation#/Newsletter%20Admin/showNewsletterSubscriber
|
|
27226
|
+
*
|
|
27227
|
+
* @param id The UUID of the subscriber.
|
|
27228
|
+
* @returns Promise
|
|
27229
|
+
*/
|
|
27230
|
+
Newsletters.viewSubscriber = function (id) {
|
|
27231
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id: id });
|
|
27232
|
+
};
|
|
27108
27233
|
return Newsletters;
|
|
27109
27234
|
}());
|
|
27110
27235
|
|