glitch-javascript-sdk 3.2.16 → 3.2.18
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 +100 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Campaigns.d.ts +19 -0
- package/dist/esm/api/Crm.d.ts +40 -0
- package/dist/esm/index.js +100 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/index.d.ts +59 -0
- package/package.json +1 -1
- package/src/api/Campaigns.ts +28 -0
- package/src/api/Crm.ts +71 -1
- package/src/routes/CampaignsRoute.ts +3 -0
- package/src/routes/CrmRoute.ts +13 -1
|
@@ -73,6 +73,13 @@ declare class Campaigns {
|
|
|
73
73
|
* @returns promise
|
|
74
74
|
*/
|
|
75
75
|
static getPosts<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
76
|
+
/**
|
|
77
|
+
* Get planned influencer content for a campaign calendar.
|
|
78
|
+
*
|
|
79
|
+
* @param campaign_id The campaign id to retrieve calendar posts for.
|
|
80
|
+
* @param params Optional filters such as scheduled_at_from, scheduled_at_to, status, or user_id.
|
|
81
|
+
*/
|
|
82
|
+
static getCampaignCalendar<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
76
83
|
/**
|
|
77
84
|
* Get the associated statistics for the campaign.
|
|
78
85
|
*
|
|
@@ -152,6 +159,10 @@ declare class Campaigns {
|
|
|
152
159
|
* @returns promise
|
|
153
160
|
*/
|
|
154
161
|
static listInfluencerCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
162
|
+
/**
|
|
163
|
+
* List planned influencer content across the authenticated influencer's accepted campaigns.
|
|
164
|
+
*/
|
|
165
|
+
static getInfluencerCalendar<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
155
166
|
/**
|
|
156
167
|
* Create an influencer campaign
|
|
157
168
|
*
|
|
@@ -190,6 +201,14 @@ declare class Campaigns {
|
|
|
190
201
|
* @returns promise
|
|
191
202
|
*/
|
|
192
203
|
static viewInfluencerCampaign<T>(campaign_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
204
|
+
/**
|
|
205
|
+
* Create or update planned campaign content for an influencer.
|
|
206
|
+
*
|
|
207
|
+
* @param campaign_id The campaign id.
|
|
208
|
+
* @param user_id The influencer user id.
|
|
209
|
+
* @param data The posts payload.
|
|
210
|
+
*/
|
|
211
|
+
static saveInfluencerCalendarPosts<T>(campaign_id: string, user_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
193
212
|
/**
|
|
194
213
|
* Mark an influencer campaign as completed.
|
|
195
214
|
*
|
package/dist/esm/api/Crm.d.ts
CHANGED
|
@@ -85,5 +85,45 @@ declare class Crm {
|
|
|
85
85
|
* Remove a contact from a lead.
|
|
86
86
|
*/
|
|
87
87
|
static deleteContact<T>(contact_id: string): AxiosPromise<Response<T>>;
|
|
88
|
+
/**
|
|
89
|
+
* List CRM newsletter and mass-email campaigns.
|
|
90
|
+
*/
|
|
91
|
+
static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
92
|
+
/**
|
|
93
|
+
* Create a CRM campaign draft with filters, exclusions, and optional variants.
|
|
94
|
+
*/
|
|
95
|
+
static createCampaign<T>(data: object): AxiosPromise<Response<T>>;
|
|
96
|
+
/**
|
|
97
|
+
* View a CRM campaign. Pass include_recipients in params for a small recipient sample.
|
|
98
|
+
*/
|
|
99
|
+
static viewCampaign<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
100
|
+
/**
|
|
101
|
+
* Update an editable CRM campaign draft or paused campaign.
|
|
102
|
+
*/
|
|
103
|
+
static updateCampaign<T>(campaign_id: string, data: object): AxiosPromise<Response<T>>;
|
|
104
|
+
/**
|
|
105
|
+
* Delete an unsent CRM campaign draft.
|
|
106
|
+
*/
|
|
107
|
+
static deleteCampaign<T>(campaign_id: string): AxiosPromise<Response<T>>;
|
|
108
|
+
/**
|
|
109
|
+
* Preview campaign audience filters and exclusions without creating recipients.
|
|
110
|
+
*/
|
|
111
|
+
static previewCampaignAudience<T>(data: object): AxiosPromise<Response<T>>;
|
|
112
|
+
/**
|
|
113
|
+
* Materialize and queue a CRM campaign, optionally with a limit or dispatch=false.
|
|
114
|
+
*/
|
|
115
|
+
static sendCampaign<T>(campaign_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
116
|
+
/**
|
|
117
|
+
* Refresh and read CRM campaign engagement, reply, and conversion stats.
|
|
118
|
+
*/
|
|
119
|
+
static getCampaignStats<T>(campaign_id: string): AxiosPromise<Response<T>>;
|
|
120
|
+
/**
|
|
121
|
+
* List campaign recipient audit rows with optional status or variant filters.
|
|
122
|
+
*/
|
|
123
|
+
static listCampaignRecipients<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
124
|
+
/**
|
|
125
|
+
* Import external prospects into CRM leads and contacts for future campaigns.
|
|
126
|
+
*/
|
|
127
|
+
static importCampaignProspects<T>(prospects: object[]): AxiosPromise<Response<T>>;
|
|
88
128
|
}
|
|
89
129
|
export default Crm;
|
package/dist/esm/index.js
CHANGED
|
@@ -13142,6 +13142,7 @@ var CampaignsRoute = /** @class */ (function () {
|
|
|
13142
13142
|
deleteCampaign: { url: '/campaigns/{campaign_id}', method: HTTP_METHODS.DELETE },
|
|
13143
13143
|
getLedger: { url: '/campaigns/{campaign_id}/ledger', method: HTTP_METHODS.GET },
|
|
13144
13144
|
getPosts: { url: '/campaigns/{campaign_id}/posts', method: HTTP_METHODS.GET },
|
|
13145
|
+
getCampaignCalendar: { url: '/campaigns/{campaign_id}/calendar', method: HTTP_METHODS.GET },
|
|
13145
13146
|
statistics: { url: '/campaigns/{campaign_id}/statistics', method: HTTP_METHODS.GET },
|
|
13146
13147
|
streamViewCounts: { url: '/campaigns/{campaign_id}/streamViewCounts', method: HTTP_METHODS.GET },
|
|
13147
13148
|
listCampaignLinks: { url: '/campaigns/{campaign_id}/links', method: HTTP_METHODS.GET },
|
|
@@ -13150,7 +13151,9 @@ var CampaignsRoute = /** @class */ (function () {
|
|
|
13150
13151
|
updateCampaignLink: { url: '/campaigns/{campaign_id}/links/{link_id}', method: HTTP_METHODS.PUT },
|
|
13151
13152
|
createInfluencerCampaign: { url: '/campaigns/{campaign_id}/influencers', method: HTTP_METHODS.POST },
|
|
13152
13153
|
listInfluencerCampaigns: { url: '/campaigns/influencers', method: HTTP_METHODS.GET },
|
|
13154
|
+
getInfluencerCalendar: { url: '/campaigns/influencers/calendar', method: HTTP_METHODS.GET },
|
|
13153
13155
|
viewInfluencerCampaign: { url: '/campaigns/{campaign_id}/influencers/{user_id}', method: HTTP_METHODS.GET },
|
|
13156
|
+
saveInfluencerCalendarPosts: { url: '/campaigns/{campaign_id}/influencers/{user_id}/calendar-posts', method: HTTP_METHODS.POST },
|
|
13154
13157
|
updateInfluencerCampaign: { url: '/campaigns/{campaign_id}/influencers/{user_id}', method: HTTP_METHODS.PUT },
|
|
13155
13158
|
deleteInfluencerCampaign: { url: '/campaigns/{campaign_id}/influencers/{user_id}', method: HTTP_METHODS.DELETE },
|
|
13156
13159
|
markInfluencerCampaignComplete: { url: '/campaigns/{campaign_id}/influencers/{user_id}/setComplete', method: HTTP_METHODS.POST },
|
|
@@ -13331,6 +13334,15 @@ var Campaigns = /** @class */ (function () {
|
|
|
13331
13334
|
Campaigns.getPosts = function (campaign_id, params) {
|
|
13332
13335
|
return Requests.processRoute(CampaignsRoute.routes.getPosts, undefined, { campaign_id: campaign_id }, params);
|
|
13333
13336
|
};
|
|
13337
|
+
/**
|
|
13338
|
+
* Get planned influencer content for a campaign calendar.
|
|
13339
|
+
*
|
|
13340
|
+
* @param campaign_id The campaign id to retrieve calendar posts for.
|
|
13341
|
+
* @param params Optional filters such as scheduled_at_from, scheduled_at_to, status, or user_id.
|
|
13342
|
+
*/
|
|
13343
|
+
Campaigns.getCampaignCalendar = function (campaign_id, params) {
|
|
13344
|
+
return Requests.processRoute(CampaignsRoute.routes.getCampaignCalendar, undefined, { campaign_id: campaign_id }, params);
|
|
13345
|
+
};
|
|
13334
13346
|
/**
|
|
13335
13347
|
* Get the associated statistics for the campaign.
|
|
13336
13348
|
*
|
|
@@ -13428,6 +13440,12 @@ var Campaigns = /** @class */ (function () {
|
|
|
13428
13440
|
Campaigns.listInfluencerCampaigns = function (params) {
|
|
13429
13441
|
return Requests.processRoute(CampaignsRoute.routes.listInfluencerCampaigns, undefined, undefined, params);
|
|
13430
13442
|
};
|
|
13443
|
+
/**
|
|
13444
|
+
* List planned influencer content across the authenticated influencer's accepted campaigns.
|
|
13445
|
+
*/
|
|
13446
|
+
Campaigns.getInfluencerCalendar = function (params) {
|
|
13447
|
+
return Requests.processRoute(CampaignsRoute.routes.getInfluencerCalendar, undefined, undefined, params);
|
|
13448
|
+
};
|
|
13431
13449
|
/**
|
|
13432
13450
|
* Create an influencer campaign
|
|
13433
13451
|
*
|
|
@@ -13474,6 +13492,16 @@ var Campaigns = /** @class */ (function () {
|
|
|
13474
13492
|
Campaigns.viewInfluencerCampaign = function (campaign_id, user_id, params) {
|
|
13475
13493
|
return Requests.processRoute(CampaignsRoute.routes.viewInfluencerCampaign, {}, { campaign_id: campaign_id, user_id: user_id }, params);
|
|
13476
13494
|
};
|
|
13495
|
+
/**
|
|
13496
|
+
* Create or update planned campaign content for an influencer.
|
|
13497
|
+
*
|
|
13498
|
+
* @param campaign_id The campaign id.
|
|
13499
|
+
* @param user_id The influencer user id.
|
|
13500
|
+
* @param data The posts payload.
|
|
13501
|
+
*/
|
|
13502
|
+
Campaigns.saveInfluencerCalendarPosts = function (campaign_id, user_id, data, params) {
|
|
13503
|
+
return Requests.processRoute(CampaignsRoute.routes.saveInfluencerCalendarPosts, data, { campaign_id: campaign_id, user_id: user_id }, params);
|
|
13504
|
+
};
|
|
13477
13505
|
/**
|
|
13478
13506
|
* Mark an influencer campaign as completed.
|
|
13479
13507
|
*
|
|
@@ -18433,6 +18461,17 @@ var CrmRoute = /** @class */ (function () {
|
|
|
18433
18461
|
bulkApprove: { url: '/admin/crm/contacts/bulk-approve', method: HTTP_METHODS.POST },
|
|
18434
18462
|
updateContact: { url: '/admin/crm/contacts/{contact_id}', method: HTTP_METHODS.PUT },
|
|
18435
18463
|
deleteContact: { url: '/admin/crm/contacts/{contact_id}', method: HTTP_METHODS.DELETE },
|
|
18464
|
+
// Newsletter and Campaign Management
|
|
18465
|
+
listCampaigns: { url: '/admin/crm/campaigns', method: HTTP_METHODS.GET },
|
|
18466
|
+
createCampaign: { url: '/admin/crm/campaigns', method: HTTP_METHODS.POST },
|
|
18467
|
+
viewCampaign: { url: '/admin/crm/campaigns/{campaign_id}', method: HTTP_METHODS.GET },
|
|
18468
|
+
updateCampaign: { url: '/admin/crm/campaigns/{campaign_id}', method: HTTP_METHODS.PUT },
|
|
18469
|
+
deleteCampaign: { url: '/admin/crm/campaigns/{campaign_id}', method: HTTP_METHODS.DELETE },
|
|
18470
|
+
previewCampaignAudience: { url: '/admin/crm/campaigns/preview', method: HTTP_METHODS.POST },
|
|
18471
|
+
sendCampaign: { url: '/admin/crm/campaigns/{campaign_id}/send', method: HTTP_METHODS.POST },
|
|
18472
|
+
getCampaignStats: { url: '/admin/crm/campaigns/{campaign_id}/stats', method: HTTP_METHODS.GET },
|
|
18473
|
+
listCampaignRecipients: { url: '/admin/crm/campaigns/{campaign_id}/recipients', method: HTTP_METHODS.GET },
|
|
18474
|
+
importCampaignProspects: { url: '/admin/crm/campaigns/import-prospects', method: HTTP_METHODS.POST },
|
|
18436
18475
|
// Automation Triggers
|
|
18437
18476
|
triggerSourcing: { url: '/admin/crm/automation/source', method: HTTP_METHODS.POST },
|
|
18438
18477
|
triggerSync: { url: '/admin/crm/automation/sync', method: HTTP_METHODS.POST },
|
|
@@ -18573,6 +18612,67 @@ var Crm = /** @class */ (function () {
|
|
|
18573
18612
|
Crm.deleteContact = function (contact_id) {
|
|
18574
18613
|
return Requests.processRoute(CrmRoute.routes.deleteContact, {}, { contact_id: contact_id });
|
|
18575
18614
|
};
|
|
18615
|
+
/**
|
|
18616
|
+
* List CRM newsletter and mass-email campaigns.
|
|
18617
|
+
*/
|
|
18618
|
+
Crm.listCampaigns = function (params) {
|
|
18619
|
+
return Requests.processRoute(CrmRoute.routes.listCampaigns, undefined, undefined, params);
|
|
18620
|
+
};
|
|
18621
|
+
/**
|
|
18622
|
+
* Create a CRM campaign draft with filters, exclusions, and optional variants.
|
|
18623
|
+
*/
|
|
18624
|
+
Crm.createCampaign = function (data) {
|
|
18625
|
+
return Requests.processRoute(CrmRoute.routes.createCampaign, data);
|
|
18626
|
+
};
|
|
18627
|
+
/**
|
|
18628
|
+
* View a CRM campaign. Pass include_recipients in params for a small recipient sample.
|
|
18629
|
+
*/
|
|
18630
|
+
Crm.viewCampaign = function (campaign_id, params) {
|
|
18631
|
+
return Requests.processRoute(CrmRoute.routes.viewCampaign, {}, { campaign_id: campaign_id }, params);
|
|
18632
|
+
};
|
|
18633
|
+
/**
|
|
18634
|
+
* Update an editable CRM campaign draft or paused campaign.
|
|
18635
|
+
*/
|
|
18636
|
+
Crm.updateCampaign = function (campaign_id, data) {
|
|
18637
|
+
return Requests.processRoute(CrmRoute.routes.updateCampaign, data, { campaign_id: campaign_id });
|
|
18638
|
+
};
|
|
18639
|
+
/**
|
|
18640
|
+
* Delete an unsent CRM campaign draft.
|
|
18641
|
+
*/
|
|
18642
|
+
Crm.deleteCampaign = function (campaign_id) {
|
|
18643
|
+
return Requests.processRoute(CrmRoute.routes.deleteCampaign, {}, { campaign_id: campaign_id });
|
|
18644
|
+
};
|
|
18645
|
+
/**
|
|
18646
|
+
* Preview campaign audience filters and exclusions without creating recipients.
|
|
18647
|
+
*/
|
|
18648
|
+
Crm.previewCampaignAudience = function (data) {
|
|
18649
|
+
return Requests.processRoute(CrmRoute.routes.previewCampaignAudience, data);
|
|
18650
|
+
};
|
|
18651
|
+
/**
|
|
18652
|
+
* Materialize and queue a CRM campaign, optionally with a limit or dispatch=false.
|
|
18653
|
+
*/
|
|
18654
|
+
Crm.sendCampaign = function (campaign_id, data) {
|
|
18655
|
+
if (data === void 0) { data = {}; }
|
|
18656
|
+
return Requests.processRoute(CrmRoute.routes.sendCampaign, data, { campaign_id: campaign_id });
|
|
18657
|
+
};
|
|
18658
|
+
/**
|
|
18659
|
+
* Refresh and read CRM campaign engagement, reply, and conversion stats.
|
|
18660
|
+
*/
|
|
18661
|
+
Crm.getCampaignStats = function (campaign_id) {
|
|
18662
|
+
return Requests.processRoute(CrmRoute.routes.getCampaignStats, {}, { campaign_id: campaign_id });
|
|
18663
|
+
};
|
|
18664
|
+
/**
|
|
18665
|
+
* List campaign recipient audit rows with optional status or variant filters.
|
|
18666
|
+
*/
|
|
18667
|
+
Crm.listCampaignRecipients = function (campaign_id, params) {
|
|
18668
|
+
return Requests.processRoute(CrmRoute.routes.listCampaignRecipients, {}, { campaign_id: campaign_id }, params);
|
|
18669
|
+
};
|
|
18670
|
+
/**
|
|
18671
|
+
* Import external prospects into CRM leads and contacts for future campaigns.
|
|
18672
|
+
*/
|
|
18673
|
+
Crm.importCampaignProspects = function (prospects) {
|
|
18674
|
+
return Requests.processRoute(CrmRoute.routes.importCampaignProspects, { prospects: prospects });
|
|
18675
|
+
};
|
|
18576
18676
|
return Crm;
|
|
18577
18677
|
}());
|
|
18578
18678
|
|