glitch-javascript-sdk 2.6.3 → 2.6.5
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 +51 -55
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Campaigns.d.ts +15 -0
- package/dist/esm/api/Newsletters.d.ts +17 -45
- package/dist/esm/index.js +51 -55
- package/dist/esm/index.js.map +1 -1
- package/dist/index.d.ts +32 -45
- package/package.json +1 -1
- package/src/api/Campaigns.ts +15 -0
- package/src/api/Newsletters.ts +30 -54
- package/src/routes/CampaignsRoute.ts +4 -0
- package/src/routes/NewslettersRoutes.ts +18 -13
|
@@ -741,5 +741,20 @@ declare class Campaigns {
|
|
|
741
741
|
stages?: string[];
|
|
742
742
|
status?: string;
|
|
743
743
|
}): AxiosPromise<Response<T>>;
|
|
744
|
+
/**
|
|
745
|
+
* Find and save Fansly creators for a specific campaign.
|
|
746
|
+
*
|
|
747
|
+
* @see CampaignCreatorSourcingController@findAndSaveFanslyCreators
|
|
748
|
+
*
|
|
749
|
+
* @param campaign_id The UUID of the campaign.
|
|
750
|
+
* @param data Parameters for sourcing.
|
|
751
|
+
* @param data.query The search term (e.g., 'gaming', 'cosplay'). Defaults to 'gaming'.
|
|
752
|
+
* @param data.pages Number of pages to crawl (25 results per page). Defaults to 10.
|
|
753
|
+
* @returns promise
|
|
754
|
+
*/
|
|
755
|
+
static sourcingFindAndSaveFanslyCreators<T>(campaign_id: string, data: {
|
|
756
|
+
query?: string;
|
|
757
|
+
pages?: number;
|
|
758
|
+
}): AxiosPromise<Response<T>>;
|
|
744
759
|
}
|
|
745
760
|
export default Campaigns;
|
|
@@ -32,87 +32,59 @@ declare class Newsletters {
|
|
|
32
32
|
static joinDiscordMarketplaceWaitlist<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
33
33
|
/**
|
|
34
34
|
* List all newsletter campaigns (Admin only).
|
|
35
|
-
*
|
|
36
|
-
* @param params Query parameters for pagination and filtering.
|
|
37
|
-
* @returns Promise
|
|
38
35
|
*/
|
|
39
36
|
static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
40
37
|
/**
|
|
41
38
|
* Create a new newsletter campaign draft (Admin only).
|
|
42
|
-
*
|
|
43
|
-
* @param data { subject, content_html, content_json }
|
|
44
|
-
* @returns Promise
|
|
45
39
|
*/
|
|
46
40
|
static createCampaign<T>(data: object): AxiosPromise<Response<T>>;
|
|
47
41
|
/**
|
|
48
42
|
* Retrieve a specific newsletter campaign (Admin only).
|
|
49
|
-
*
|
|
50
|
-
* @param id The UUID of the campaign.
|
|
51
|
-
* @returns Promise
|
|
52
43
|
*/
|
|
53
44
|
static viewCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
54
45
|
/**
|
|
55
46
|
* Update a newsletter campaign draft (Admin only).
|
|
56
|
-
*
|
|
57
|
-
* @param id The UUID of the campaign.
|
|
58
|
-
* @param data The updated campaign data.
|
|
59
|
-
* @returns Promise
|
|
60
47
|
*/
|
|
61
48
|
static updateCampaign<T>(id: string, data: object): AxiosPromise<Response<T>>;
|
|
62
49
|
/**
|
|
63
|
-
*
|
|
64
|
-
* Returns open rates, click rates, and human vs proxy metrics.
|
|
65
|
-
*
|
|
66
|
-
* @param id The UUID of the campaign.
|
|
67
|
-
* @returns Promise
|
|
50
|
+
* Delete a newsletter campaign (Admin only).
|
|
68
51
|
*/
|
|
69
|
-
static
|
|
52
|
+
static deleteCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
70
53
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* @param id The UUID of the campaign.
|
|
74
|
-
* @returns Promise
|
|
54
|
+
* Get high-level analytics for a specific campaign (Admin only).
|
|
75
55
|
*/
|
|
76
|
-
static
|
|
56
|
+
static getCampaignStats<T>(id: string): AxiosPromise<Response<T>>;
|
|
77
57
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* @param params Query parameters for pagination and filtering.
|
|
81
|
-
* @returns Promise
|
|
58
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
82
59
|
*/
|
|
83
|
-
static
|
|
60
|
+
static getCampaignLogs<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
84
61
|
/**
|
|
85
|
-
*
|
|
62
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
86
63
|
*/
|
|
87
|
-
static
|
|
64
|
+
static sendCampaign<T>(id: string): AxiosPromise<Response<T>>;
|
|
88
65
|
/**
|
|
89
66
|
* Send a test email of a campaign to a specific address (Admin only).
|
|
90
67
|
*/
|
|
91
68
|
static sendTestEmail<T>(id: string, email: string): AxiosPromise<Response<T>>;
|
|
92
69
|
/**
|
|
93
|
-
*
|
|
70
|
+
* List all newsletter subscribers (Admin only).
|
|
94
71
|
*/
|
|
95
|
-
static
|
|
72
|
+
static listSubscribers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
96
73
|
/**
|
|
97
|
-
* Manually create a new subscriber (Admin only).
|
|
74
|
+
* Manually create a new newsletter subscriber (Admin only).
|
|
98
75
|
*/
|
|
99
76
|
static createSubscriber<T>(data: object): AxiosPromise<Response<T>>;
|
|
100
77
|
/**
|
|
101
|
-
*
|
|
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).
|
|
102
83
|
*/
|
|
103
84
|
static updateSubscriber<T>(id: string, data: object): AxiosPromise<Response<T>>;
|
|
104
85
|
/**
|
|
105
|
-
*
|
|
86
|
+
* Permanently delete a subscriber from the system (Admin only).
|
|
106
87
|
*/
|
|
107
88
|
static deleteSubscriber<T>(id: string): AxiosPromise<Response<T>>;
|
|
108
|
-
/**
|
|
109
|
-
* Retrieve a specific subscriber's details (Admin only).
|
|
110
|
-
*
|
|
111
|
-
* @see https://api.glitch.fun/api/documentation#/Newsletter%20Admin/showNewsletterSubscriber
|
|
112
|
-
*
|
|
113
|
-
* @param id The UUID of the subscriber.
|
|
114
|
-
* @returns Promise
|
|
115
|
-
*/
|
|
116
|
-
static viewSubscriber<T>(id: string): AxiosPromise<Response<T>>;
|
|
117
89
|
}
|
|
118
90
|
export default Newsletters;
|
package/dist/esm/index.js
CHANGED
|
@@ -12290,6 +12290,10 @@ var CampaignsRoute = /** @class */ (function () {
|
|
|
12290
12290
|
url: '/campaigns/{campaign_id}/influencers/invites/export',
|
|
12291
12291
|
method: HTTP_METHODS.POST
|
|
12292
12292
|
},
|
|
12293
|
+
sourcingFindAndSaveFanslyCreators: {
|
|
12294
|
+
url: '/campaigns/{campaign_id}/sourcing/find-save-fansly-creators',
|
|
12295
|
+
method: HTTP_METHODS.POST
|
|
12296
|
+
},
|
|
12293
12297
|
};
|
|
12294
12298
|
return CampaignsRoute;
|
|
12295
12299
|
}());
|
|
@@ -13180,6 +13184,20 @@ var Campaigns = /** @class */ (function () {
|
|
|
13180
13184
|
Campaigns.exportInfluencerInvites = function (campaign_id, data) {
|
|
13181
13185
|
return Requests.processRoute(CampaignsRoute.routes.exportInfluencerInvites, data, { campaign_id: campaign_id });
|
|
13182
13186
|
};
|
|
13187
|
+
/**
|
|
13188
|
+
* Find and save Fansly creators for a specific campaign.
|
|
13189
|
+
*
|
|
13190
|
+
* @see CampaignCreatorSourcingController@findAndSaveFanslyCreators
|
|
13191
|
+
*
|
|
13192
|
+
* @param campaign_id The UUID of the campaign.
|
|
13193
|
+
* @param data Parameters for sourcing.
|
|
13194
|
+
* @param data.query The search term (e.g., 'gaming', 'cosplay'). Defaults to 'gaming'.
|
|
13195
|
+
* @param data.pages Number of pages to crawl (25 results per page). Defaults to 10.
|
|
13196
|
+
* @returns promise
|
|
13197
|
+
*/
|
|
13198
|
+
Campaigns.sourcingFindAndSaveFanslyCreators = function (campaign_id, data) {
|
|
13199
|
+
return Requests.processRoute(CampaignsRoute.routes.sourcingFindAndSaveFanslyCreators, data, { campaign_id: campaign_id });
|
|
13200
|
+
};
|
|
13183
13201
|
return Campaigns;
|
|
13184
13202
|
}());
|
|
13185
13203
|
|
|
@@ -13877,15 +13895,19 @@ var NewslettersRoutes = /** @class */ (function () {
|
|
|
13877
13895
|
joinCourseWaitlist: { url: '/newsletters/joinCourseWaitlist', method: HTTP_METHODS.POST },
|
|
13878
13896
|
joinRaffleWaitlist: { url: '/newsletters/joinRaffleWaitlist', method: HTTP_METHODS.POST },
|
|
13879
13897
|
joinDiscordMarketplaceWaitlist: { url: '/newsletters/joinDiscordMarketplaceWaitlist', method: HTTP_METHODS.POST },
|
|
13880
|
-
// ---
|
|
13898
|
+
// --- Admin Campaign Management ---
|
|
13881
13899
|
listCampaigns: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.GET },
|
|
13882
13900
|
createCampaign: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.POST },
|
|
13883
13901
|
viewCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.GET },
|
|
13884
13902
|
updateCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.PUT },
|
|
13885
|
-
|
|
13903
|
+
deleteCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.DELETE },
|
|
13904
|
+
// --- Admin Campaign Actions & Analytics ---
|
|
13905
|
+
getCampaignStats: { url: '/admin/newsletters/campaigns/{id}/stats', method: HTTP_METHODS.GET },
|
|
13906
|
+
getCampaignLogs: { url: '/admin/newsletters/campaigns/{id}/logs', method: HTTP_METHODS.GET },
|
|
13886
13907
|
sendCampaign: { url: '/admin/newsletters/campaigns/{id}/send', method: HTTP_METHODS.POST },
|
|
13908
|
+
sendTest: { url: '/admin/newsletters/campaigns/{id}/test', method: HTTP_METHODS.POST },
|
|
13909
|
+
// --- Admin Subscriber Management ---
|
|
13887
13910
|
listSubscribers: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.GET },
|
|
13888
|
-
// --- Subscriber Management (Admin) ---
|
|
13889
13911
|
createSubscriber: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.POST },
|
|
13890
13912
|
viewSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.GET },
|
|
13891
13913
|
updateSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.PUT },
|
|
@@ -13934,76 +13956,54 @@ var Newsletters = /** @class */ (function () {
|
|
|
13934
13956
|
Newsletters.joinDiscordMarketplaceWaitlist = function (data, params) {
|
|
13935
13957
|
return Requests.processRoute(NewslettersRoutes.routes.joinDiscordMarketplaceWaitlist, data, undefined, params);
|
|
13936
13958
|
};
|
|
13959
|
+
// --- ADMINISTRATIVE CAMPAIGN METHODS ---
|
|
13937
13960
|
/**
|
|
13938
13961
|
* List all newsletter campaigns (Admin only).
|
|
13939
|
-
*
|
|
13940
|
-
* @param params Query parameters for pagination and filtering.
|
|
13941
|
-
* @returns Promise
|
|
13942
13962
|
*/
|
|
13943
13963
|
Newsletters.listCampaigns = function (params) {
|
|
13944
13964
|
return Requests.processRoute(NewslettersRoutes.routes.listCampaigns, undefined, undefined, params);
|
|
13945
13965
|
};
|
|
13946
13966
|
/**
|
|
13947
13967
|
* Create a new newsletter campaign draft (Admin only).
|
|
13948
|
-
*
|
|
13949
|
-
* @param data { subject, content_html, content_json }
|
|
13950
|
-
* @returns Promise
|
|
13951
13968
|
*/
|
|
13952
13969
|
Newsletters.createCampaign = function (data) {
|
|
13953
13970
|
return Requests.processRoute(NewslettersRoutes.routes.createCampaign, data);
|
|
13954
13971
|
};
|
|
13955
13972
|
/**
|
|
13956
13973
|
* Retrieve a specific newsletter campaign (Admin only).
|
|
13957
|
-
*
|
|
13958
|
-
* @param id The UUID of the campaign.
|
|
13959
|
-
* @returns Promise
|
|
13960
13974
|
*/
|
|
13961
13975
|
Newsletters.viewCampaign = function (id) {
|
|
13962
13976
|
return Requests.processRoute(NewslettersRoutes.routes.viewCampaign, undefined, { id: id });
|
|
13963
13977
|
};
|
|
13964
13978
|
/**
|
|
13965
13979
|
* Update a newsletter campaign draft (Admin only).
|
|
13966
|
-
*
|
|
13967
|
-
* @param id The UUID of the campaign.
|
|
13968
|
-
* @param data The updated campaign data.
|
|
13969
|
-
* @returns Promise
|
|
13970
13980
|
*/
|
|
13971
13981
|
Newsletters.updateCampaign = function (id, data) {
|
|
13972
13982
|
return Requests.processRoute(NewslettersRoutes.routes.updateCampaign, data, { id: id });
|
|
13973
13983
|
};
|
|
13974
13984
|
/**
|
|
13975
|
-
*
|
|
13976
|
-
* Returns open rates, click rates, and human vs proxy metrics.
|
|
13977
|
-
*
|
|
13978
|
-
* @param id The UUID of the campaign.
|
|
13979
|
-
* @returns Promise
|
|
13985
|
+
* Delete a newsletter campaign (Admin only).
|
|
13980
13986
|
*/
|
|
13981
|
-
Newsletters.
|
|
13982
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
13987
|
+
Newsletters.deleteCampaign = function (id) {
|
|
13988
|
+
return Requests.processRoute(NewslettersRoutes.routes.deleteCampaign, undefined, { id: id });
|
|
13983
13989
|
};
|
|
13984
13990
|
/**
|
|
13985
|
-
*
|
|
13986
|
-
*
|
|
13987
|
-
* @param id The UUID of the campaign.
|
|
13988
|
-
* @returns Promise
|
|
13991
|
+
* Get high-level analytics for a specific campaign (Admin only).
|
|
13989
13992
|
*/
|
|
13990
|
-
Newsletters.
|
|
13991
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
13993
|
+
Newsletters.getCampaignStats = function (id) {
|
|
13994
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignStats, undefined, { id: id });
|
|
13992
13995
|
};
|
|
13993
13996
|
/**
|
|
13994
|
-
*
|
|
13995
|
-
*
|
|
13996
|
-
* @param params Query parameters for pagination and filtering.
|
|
13997
|
-
* @returns Promise
|
|
13997
|
+
* Get detailed delivery and open logs for a campaign (Admin only).
|
|
13998
13998
|
*/
|
|
13999
|
-
Newsletters.
|
|
14000
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
13999
|
+
Newsletters.getCampaignLogs = function (id, params) {
|
|
14000
|
+
return Requests.processRoute(NewslettersRoutes.routes.getCampaignLogs, undefined, { id: id }, params);
|
|
14001
14001
|
};
|
|
14002
14002
|
/**
|
|
14003
|
-
*
|
|
14003
|
+
* Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
|
|
14004
14004
|
*/
|
|
14005
|
-
Newsletters.
|
|
14006
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
14005
|
+
Newsletters.sendCampaign = function (id) {
|
|
14006
|
+
return Requests.processRoute(NewslettersRoutes.routes.sendCampaign, undefined, { id: id });
|
|
14007
14007
|
};
|
|
14008
14008
|
/**
|
|
14009
14009
|
* Send a test email of a campaign to a specific address (Admin only).
|
|
@@ -14011,41 +14011,37 @@ var Newsletters = /** @class */ (function () {
|
|
|
14011
14011
|
Newsletters.sendTestEmail = function (id, email) {
|
|
14012
14012
|
return Requests.processRoute(NewslettersRoutes.routes.sendTest, { email: email }, { id: id });
|
|
14013
14013
|
};
|
|
14014
|
+
// --- ADMINISTRATIVE SUBSCRIBER METHODS ---
|
|
14014
14015
|
/**
|
|
14015
|
-
*
|
|
14016
|
+
* List all newsletter subscribers (Admin only).
|
|
14016
14017
|
*/
|
|
14017
|
-
Newsletters.
|
|
14018
|
-
return Requests.processRoute(NewslettersRoutes.routes.
|
|
14018
|
+
Newsletters.listSubscribers = function (params) {
|
|
14019
|
+
return Requests.processRoute(NewslettersRoutes.routes.listSubscribers, undefined, undefined, params);
|
|
14019
14020
|
};
|
|
14020
14021
|
/**
|
|
14021
|
-
* Manually create a new subscriber (Admin only).
|
|
14022
|
+
* Manually create a new newsletter subscriber (Admin only).
|
|
14022
14023
|
*/
|
|
14023
14024
|
Newsletters.createSubscriber = function (data) {
|
|
14024
14025
|
return Requests.processRoute(NewslettersRoutes.routes.createSubscriber, data);
|
|
14025
14026
|
};
|
|
14026
14027
|
/**
|
|
14027
|
-
*
|
|
14028
|
+
* Retrieve a specific subscriber's details (Admin only).
|
|
14029
|
+
*/
|
|
14030
|
+
Newsletters.viewSubscriber = function (id) {
|
|
14031
|
+
return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id: id });
|
|
14032
|
+
};
|
|
14033
|
+
/**
|
|
14034
|
+
* Update a subscriber's information or status (Admin only).
|
|
14028
14035
|
*/
|
|
14029
14036
|
Newsletters.updateSubscriber = function (id, data) {
|
|
14030
14037
|
return Requests.processRoute(NewslettersRoutes.routes.updateSubscriber, data, { id: id });
|
|
14031
14038
|
};
|
|
14032
14039
|
/**
|
|
14033
|
-
*
|
|
14040
|
+
* Permanently delete a subscriber from the system (Admin only).
|
|
14034
14041
|
*/
|
|
14035
14042
|
Newsletters.deleteSubscriber = function (id) {
|
|
14036
14043
|
return Requests.processRoute(NewslettersRoutes.routes.deleteSubscriber, undefined, { id: id });
|
|
14037
14044
|
};
|
|
14038
|
-
/**
|
|
14039
|
-
* Retrieve a specific subscriber's details (Admin only).
|
|
14040
|
-
*
|
|
14041
|
-
* @see https://api.glitch.fun/api/documentation#/Newsletter%20Admin/showNewsletterSubscriber
|
|
14042
|
-
*
|
|
14043
|
-
* @param id The UUID of the subscriber.
|
|
14044
|
-
* @returns Promise
|
|
14045
|
-
*/
|
|
14046
|
-
Newsletters.viewSubscriber = function (id) {
|
|
14047
|
-
return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id: id });
|
|
14048
|
-
};
|
|
14049
14045
|
return Newsletters;
|
|
14050
14046
|
}());
|
|
14051
14047
|
|