glitch-javascript-sdk 2.6.3 → 2.6.4
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 +33 -55
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Newsletters.d.ts +17 -45
- package/dist/esm/index.js +33 -55
- package/dist/esm/index.js.map +1 -1
- package/dist/index.d.ts +17 -45
- package/package.json +1 -1
- package/src/api/Newsletters.ts +30 -54
- package/src/routes/NewslettersRoutes.ts +18 -13
package/dist/cjs/index.js
CHANGED
|
@@ -27061,15 +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
|
-
// ---
|
|
27064
|
+
// --- Admin Campaign Management ---
|
|
27065
27065
|
listCampaigns: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.GET },
|
|
27066
27066
|
createCampaign: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.POST },
|
|
27067
27067
|
viewCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.GET },
|
|
27068
27068
|
updateCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.PUT },
|
|
27069
|
-
|
|
27069
|
+
deleteCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.DELETE },
|
|
27070
|
+
// --- Admin Campaign Actions & Analytics ---
|
|
27071
|
+
getCampaignStats: { url: '/admin/newsletters/campaigns/{id}/stats', method: HTTP_METHODS.GET },
|
|
27072
|
+
getCampaignLogs: { url: '/admin/newsletters/campaigns/{id}/logs', method: HTTP_METHODS.GET },
|
|
27070
27073
|
sendCampaign: { url: '/admin/newsletters/campaigns/{id}/send', method: HTTP_METHODS.POST },
|
|
27074
|
+
sendTest: { url: '/admin/newsletters/campaigns/{id}/test', method: HTTP_METHODS.POST },
|
|
27075
|
+
// --- Admin Subscriber Management ---
|
|
27071
27076
|
listSubscribers: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.GET },
|
|
27072
|
-
// --- Subscriber Management (Admin) ---
|
|
27073
27077
|
createSubscriber: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.POST },
|
|
27074
27078
|
viewSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.GET },
|
|
27075
27079
|
updateSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.PUT },
|
|
@@ -27118,76 +27122,54 @@ var Newsletters = /** @class */ (function () {
|
|
|
27118
27122
|
Newsletters.joinDiscordMarketplaceWaitlist = function (data, params) {
|
|
27119
27123
|
return Requests.processRoute(NewslettersRoutes.routes.joinDiscordMarketplaceWaitlist, data, undefined, params);
|
|
27120
27124
|
};
|
|
27125
|
+
// --- ADMINISTRATIVE CAMPAIGN METHODS ---
|
|
27121
27126
|
/**
|
|
27122
27127
|
* List all newsletter campaigns (Admin only).
|
|
27123
|
-
*
|
|
27124
|
-
* @param params Query parameters for pagination and filtering.
|
|
27125
|
-
* @returns Promise
|
|
27126
27128
|
*/
|
|
27127
27129
|
Newsletters.listCampaigns = function (params) {
|
|
27128
27130
|
return Requests.processRoute(NewslettersRoutes.routes.listCampaigns, undefined, undefined, params);
|
|
27129
27131
|
};
|
|
27130
27132
|
/**
|
|
27131
27133
|
* Create a new newsletter campaign draft (Admin only).
|
|
27132
|
-
*
|
|
27133
|
-
* @param data { subject, content_html, content_json }
|
|
27134
|
-
* @returns Promise
|
|
27135
27134
|
*/
|
|
27136
27135
|
Newsletters.createCampaign = function (data) {
|
|
27137
27136
|
return Requests.processRoute(NewslettersRoutes.routes.createCampaign, data);
|
|
27138
27137
|
};
|
|
27139
27138
|
/**
|
|
27140
27139
|
* Retrieve a specific newsletter campaign (Admin only).
|
|
27141
|
-
*
|
|
27142
|
-
* @param id The UUID of the campaign.
|
|
27143
|
-
* @returns Promise
|
|
27144
27140
|
*/
|
|
27145
27141
|
Newsletters.viewCampaign = function (id) {
|
|
27146
27142
|
return Requests.processRoute(NewslettersRoutes.routes.viewCampaign, undefined, { id: id });
|
|
27147
27143
|
};
|
|
27148
27144
|
/**
|
|
27149
27145
|
* 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
27146
|
*/
|
|
27155
27147
|
Newsletters.updateCampaign = function (id, data) {
|
|
27156
27148
|
return Requests.processRoute(NewslettersRoutes.routes.updateCampaign, data, { id: id });
|
|
27157
27149
|
};
|
|
27158
27150
|
/**
|
|
27159
|
-
*
|
|
27160
|
-
* Returns open rates, click rates, and human vs proxy metrics.
|
|
27161
|
-
*
|
|
27162
|
-
* @param id The UUID of the campaign.
|
|
27163
|
-
* @returns Promise
|
|
27151
|
+
* Delete a newsletter campaign (Admin only).
|
|
27164
27152
|
*/
|
|
27165
|
-
Newsletters.
|
|
27166
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
27153
|
+
Newsletters.deleteCampaign = function (id) {
|
|
27154
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteCampaign, undefined, { id: id });
|
|
27167
27155
|
};
|
|
27168
27156
|
/**
|
|
27169
|
-
*
|
|
27170
|
-
*
|
|
27171
|
-
* @param id The UUID of the campaign.
|
|
27172
|
-
* @returns Promise
|
|
27157
|
+
* Get high-level analytics for a specific campaign (Admin only).
|
|
27173
27158
|
*/
|
|
27174
|
-
Newsletters.
|
|
27175
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
27159
|
+
Newsletters.getCampaignStats = function (id) {
|
|
27160
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignStats, undefined, { id: id });
|
|
27176
27161
|
};
|
|
27177
27162
|
/**
|
|
27178
|
-
*
|
|
27179
|
-
*
|
|
27180
|
-
* @param params Query parameters for pagination and filtering.
|
|
27181
|
-
* @returns Promise
|
|
27163
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
27182
27164
|
*/
|
|
27183
|
-
Newsletters.
|
|
27184
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
27165
|
+
Newsletters.getCampaignLogs = function (id, params) {
|
|
27166
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignLogs, undefined, { id: id }, params);
|
|
27185
27167
|
};
|
|
27186
27168
|
/**
|
|
27187
|
-
*
|
|
27169
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
27188
27170
|
*/
|
|
27189
|
-
Newsletters.
|
|
27190
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
27171
|
+
Newsletters.sendCampaign = function (id) {
|
|
27172
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendCampaign, undefined, { id: id });
|
|
27191
27173
|
};
|
|
27192
27174
|
/**
|
|
27193
27175
|
* Send a test email of a campaign to a specific address (Admin only).
|
|
@@ -27195,41 +27177,37 @@ var Newsletters = /** @class */ (function () {
|
|
|
27195
27177
|
Newsletters.sendTestEmail = function (id, email) {
|
|
27196
27178
|
return Requests.processRoute(NewslettersRoutes.routes.sendTest, { email: email }, { id: id });
|
|
27197
27179
|
};
|
|
27180
|
+
// --- ADMINISTRATIVE SUBSCRIBER METHODS ---
|
|
27198
27181
|
/**
|
|
27199
|
-
*
|
|
27182
|
+
* List all newsletter subscribers (Admin only).
|
|
27200
27183
|
*/
|
|
27201
|
-
Newsletters.
|
|
27202
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
27184
|
+
Newsletters.listSubscribers = function (params) {
|
|
27185
|
+
return Requests.processRoute(NewslettersRoutes.routes.listSubscribers, undefined, undefined, params);
|
|
27203
27186
|
};
|
|
27204
27187
|
/**
|
|
27205
|
-
* Manually create a new subscriber (Admin only).
|
|
27188
|
+
* Manually create a new newsletter subscriber (Admin only).
|
|
27206
27189
|
*/
|
|
27207
27190
|
Newsletters.createSubscriber = function (data) {
|
|
27208
27191
|
return Requests.processRoute(NewslettersRoutes.routes.createSubscriber, data);
|
|
27209
27192
|
};
|
|
27210
27193
|
/**
|
|
27211
|
-
*
|
|
27194
|
+
* Retrieve a specific subscriber's details (Admin only).
|
|
27195
|
+
*/
|
|
27196
|
+
Newsletters.viewSubscriber = function (id) {
|
|
27197
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id: id });
|
|
27198
|
+
};
|
|
27199
|
+
/**
|
|
27200
|
+
* Update a subscriber's information or status (Admin only).
|
|
27212
27201
|
*/
|
|
27213
27202
|
Newsletters.updateSubscriber = function (id, data) {
|
|
27214
27203
|
return Requests.processRoute(NewslettersRoutes.routes.updateSubscriber, data, { id: id });
|
|
27215
27204
|
};
|
|
27216
27205
|
/**
|
|
27217
|
-
*
|
|
27206
|
+
* Permanently delete a subscriber from the system (Admin only).
|
|
27218
27207
|
*/
|
|
27219
27208
|
Newsletters.deleteSubscriber = function (id) {
|
|
27220
27209
|
return Requests.processRoute(NewslettersRoutes.routes.deleteSubscriber, undefined, { id: id });
|
|
27221
27210
|
};
|
|
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
|
-
};
|
|
27233
27211
|
return Newsletters;
|
|
27234
27212
|
}());
|
|
27235
27213
|
|