glitch-javascript-sdk 2.6.2 → 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 +103 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Newsletters.d.ts +56 -0
- package/dist/esm/index.js +103 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/index.d.ts +56 -0
- package/package.json +1 -1
- package/src/api/Newsletters.ts +104 -0
- package/src/routes/NewslettersRoutes.ts +20 -0
|
@@ -30,5 +30,61 @@ declare class Newsletters {
|
|
|
30
30
|
* @param data { name, email, game, categories[] }
|
|
31
31
|
*/
|
|
32
32
|
static joinDiscordMarketplaceWaitlist<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
33
|
+
/**
|
|
34
|
+
* List all newsletter campaigns (Admin only).
|
|
35
|
+
*/
|
|
36
|
+
static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
37
|
+
/**
|
|
38
|
+
* Create a new newsletter campaign draft (Admin only).
|
|
39
|
+
*/
|
|
40
|
+
static createCampaign<T>(data: object): AxiosPromise<Response<T>>;
|
|
41
|
+
/**
|
|
42
|
+
* Retrieve a specific newsletter campaign (Admin only).
|
|
43
|
+
*/
|
|
44
|
+
static viewCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
45
|
+
/**
|
|
46
|
+
* Update a newsletter campaign draft (Admin only).
|
|
47
|
+
*/
|
|
48
|
+
static updateCampaign<T>(id: string, data: object): AxiosPromise<Response<T>>;
|
|
49
|
+
/**
|
|
50
|
+
* Delete a newsletter campaign (Admin only).
|
|
51
|
+
*/
|
|
52
|
+
static deleteCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
53
|
+
/**
|
|
54
|
+
* Get high-level analytics for a specific campaign (Admin only).
|
|
55
|
+
*/
|
|
56
|
+
static getCampaignStats<T>(id: string): AxiosPromise<Response<T>>;
|
|
57
|
+
/**
|
|
58
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
59
|
+
*/
|
|
60
|
+
static getCampaignLogs<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
61
|
+
/**
|
|
62
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
63
|
+
*/
|
|
64
|
+
static sendCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
65
|
+
/**
|
|
66
|
+
* Send a test email of a campaign to a specific address (Admin only).
|
|
67
|
+
*/
|
|
68
|
+
static sendTestEmail<T>(id: string, email: string): AxiosPromise<Response<T>>;
|
|
69
|
+
/**
|
|
70
|
+
* List all newsletter subscribers (Admin only).
|
|
71
|
+
*/
|
|
72
|
+
static listSubscribers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
73
|
+
/**
|
|
74
|
+
* Manually create a new newsletter subscriber (Admin only).
|
|
75
|
+
*/
|
|
76
|
+
static createSubscriber<T>(data: object): AxiosPromise<Response<T>>;
|
|
77
|
+
/**
|
|
78
|
+
* Retrieve a specific subscriber's details (Admin only).
|
|
79
|
+
*/
|
|
80
|
+
static viewSubscriber<T>(id: string): AxiosPromise<Response<T>>;
|
|
81
|
+
/**
|
|
82
|
+
* Update a subscriber's information or status (Admin only).
|
|
83
|
+
*/
|
|
84
|
+
static updateSubscriber<T>(id: string, data: object): AxiosPromise<Response<T>>;
|
|
85
|
+
/**
|
|
86
|
+
* Permanently delete a subscriber from the system (Admin only).
|
|
87
|
+
*/
|
|
88
|
+
static deleteSubscriber<T>(id: string): AxiosPromise<Response<T>>;
|
|
33
89
|
}
|
|
34
90
|
export default Newsletters;
|
package/dist/esm/index.js
CHANGED
|
@@ -13877,6 +13877,23 @@ var NewslettersRoutes = /** @class */ (function () {
|
|
|
13877
13877
|
joinCourseWaitlist: { url: '/newsletters/joinCourseWaitlist', method: HTTP_METHODS.POST },
|
|
13878
13878
|
joinRaffleWaitlist: { url: '/newsletters/joinRaffleWaitlist', method: HTTP_METHODS.POST },
|
|
13879
13879
|
joinDiscordMarketplaceWaitlist: { url: '/newsletters/joinDiscordMarketplaceWaitlist', method: HTTP_METHODS.POST },
|
|
13880
|
+
// --- Admin Campaign Management ---
|
|
13881
|
+
listCampaigns: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.GET },
|
|
13882
|
+
createCampaign: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.POST },
|
|
13883
|
+
viewCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.GET },
|
|
13884
|
+
updateCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.PUT },
|
|
13885
|
+
deleteCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.DELETE },
|
|
13886
|
+
// --- Admin Campaign Actions & Analytics ---
|
|
13887
|
+
getCampaignStats: { url: '/admin/newsletters/campaigns/{id}/stats', method: HTTP_METHODS.GET },
|
|
13888
|
+
getCampaignLogs: { url: '/admin/newsletters/campaigns/{id}/logs', method: HTTP_METHODS.GET },
|
|
13889
|
+
sendCampaign: { url: '/admin/newsletters/campaigns/{id}/send', method: HTTP_METHODS.POST },
|
|
13890
|
+
sendTest: { url: '/admin/newsletters/campaigns/{id}/test', method: HTTP_METHODS.POST },
|
|
13891
|
+
// --- Admin Subscriber Management ---
|
|
13892
|
+
listSubscribers: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.GET },
|
|
13893
|
+
createSubscriber: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.POST },
|
|
13894
|
+
viewSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.GET },
|
|
13895
|
+
updateSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.PUT },
|
|
13896
|
+
deleteSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.DELETE },
|
|
13880
13897
|
};
|
|
13881
13898
|
return NewslettersRoutes;
|
|
13882
13899
|
}());
|
|
@@ -13921,6 +13938,92 @@ var Newsletters = /** @class */ (function () {
|
|
|
13921
13938
|
Newsletters.joinDiscordMarketplaceWaitlist = function (data, params) {
|
|
13922
13939
|
return Requests.processRoute(NewslettersRoutes.routes.joinDiscordMarketplaceWaitlist, data, undefined, params);
|
|
13923
13940
|
};
|
|
13941
|
+
// --- ADMINISTRATIVE CAMPAIGN METHODS ---
|
|
13942
|
+
/**
|
|
13943
|
+
* List all newsletter campaigns (Admin only).
|
|
13944
|
+
*/
|
|
13945
|
+
Newsletters.listCampaigns = function (params) {
|
|
13946
|
+
return Requests.processRoute(NewslettersRoutes.routes.listCampaigns, undefined, undefined, params);
|
|
13947
|
+
};
|
|
13948
|
+
/**
|
|
13949
|
+
* Create a new newsletter campaign draft (Admin only).
|
|
13950
|
+
*/
|
|
13951
|
+
Newsletters.createCampaign = function (data) {
|
|
13952
|
+
return Requests.processRoute(NewslettersRoutes.routes.createCampaign, data);
|
|
13953
|
+
};
|
|
13954
|
+
/**
|
|
13955
|
+
* Retrieve a specific newsletter campaign (Admin only).
|
|
13956
|
+
*/
|
|
13957
|
+
Newsletters.viewCampaign = function (id) {
|
|
13958
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewCampaign, undefined, { id: id });
|
|
13959
|
+
};
|
|
13960
|
+
/**
|
|
13961
|
+
* Update a newsletter campaign draft (Admin only).
|
|
13962
|
+
*/
|
|
13963
|
+
Newsletters.updateCampaign = function (id, data) {
|
|
13964
|
+
return Requests.processRoute(NewslettersRoutes.routes.updateCampaign, data, { id: id });
|
|
13965
|
+
};
|
|
13966
|
+
/**
|
|
13967
|
+
* Delete a newsletter campaign (Admin only).
|
|
13968
|
+
*/
|
|
13969
|
+
Newsletters.deleteCampaign = function (id) {
|
|
13970
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteCampaign, undefined, { id: id });
|
|
13971
|
+
};
|
|
13972
|
+
/**
|
|
13973
|
+
* Get high-level analytics for a specific campaign (Admin only).
|
|
13974
|
+
*/
|
|
13975
|
+
Newsletters.getCampaignStats = function (id) {
|
|
13976
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignStats, undefined, { id: id });
|
|
13977
|
+
};
|
|
13978
|
+
/**
|
|
13979
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
13980
|
+
*/
|
|
13981
|
+
Newsletters.getCampaignLogs = function (id, params) {
|
|
13982
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignLogs, undefined, { id: id }, params);
|
|
13983
|
+
};
|
|
13984
|
+
/**
|
|
13985
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
13986
|
+
*/
|
|
13987
|
+
Newsletters.sendCampaign = function (id) {
|
|
13988
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendCampaign, undefined, { id: id });
|
|
13989
|
+
};
|
|
13990
|
+
/**
|
|
13991
|
+
* Send a test email of a campaign to a specific address (Admin only).
|
|
13992
|
+
*/
|
|
13993
|
+
Newsletters.sendTestEmail = function (id, email) {
|
|
13994
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendTest, { email: email }, { id: id });
|
|
13995
|
+
};
|
|
13996
|
+
// --- ADMINISTRATIVE SUBSCRIBER METHODS ---
|
|
13997
|
+
/**
|
|
13998
|
+
* List all newsletter subscribers (Admin only).
|
|
13999
|
+
*/
|
|
14000
|
+
Newsletters.listSubscribers = function (params) {
|
|
14001
|
+
return Requests.processRoute(NewslettersRoutes.routes.listSubscribers, undefined, undefined, params);
|
|
14002
|
+
};
|
|
14003
|
+
/**
|
|
14004
|
+
* Manually create a new newsletter subscriber (Admin only).
|
|
14005
|
+
*/
|
|
14006
|
+
Newsletters.createSubscriber = function (data) {
|
|
14007
|
+
return Requests.processRoute(NewslettersRoutes.routes.createSubscriber, data);
|
|
14008
|
+
};
|
|
14009
|
+
/**
|
|
14010
|
+
* Retrieve a specific subscriber's details (Admin only).
|
|
14011
|
+
*/
|
|
14012
|
+
Newsletters.viewSubscriber = function (id) {
|
|
14013
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id: id });
|
|
14014
|
+
};
|
|
14015
|
+
/**
|
|
14016
|
+
* Update a subscriber's information or status (Admin only).
|
|
14017
|
+
*/
|
|
14018
|
+
Newsletters.updateSubscriber = function (id, data) {
|
|
14019
|
+
return Requests.processRoute(NewslettersRoutes.routes.updateSubscriber, data, { id: id });
|
|
14020
|
+
};
|
|
14021
|
+
/**
|
|
14022
|
+
* Permanently delete a subscriber from the system (Admin only).
|
|
14023
|
+
*/
|
|
14024
|
+
Newsletters.deleteSubscriber = function (id) {
|
|
14025
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteSubscriber, undefined, { id: id });
|
|
14026
|
+
};
|
|
13924
14027
|
return Newsletters;
|
|
13925
14028
|
}());
|
|
13926
14029
|
|