Skip to content

Commit 60d3782

Browse files
Merge pull request #373 from plivo/add-campaign-optional-fields
feat: add sample3-5 and policy links to campaign create/update
2 parents 5059498 + a1ccd4f commit 60d3782

File tree

4 files changed

+69
-24
lines changed

4 files changed

+69
-24
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Change Log
2+
## [v4.75.7](https://github.com/plivo/plivo-node/tree/v4.75.7) (2026-02-18)
3+
**Feature - Campaign API optional fields support**
4+
- Added `sample3`, `sample4`, `sample5` optional sample message fields to Campaign `create` and `update` methods
5+
- Added `termsAndConditionsLink` and `privacyPolicyLink` optional fields to Campaign `create` and `update` methods
6+
27
## [v4.75.6](https://github.com/plivo/plivo-node/tree/v4.75.6) (2026-01-21)
38
**Feature - HA Number support**
49
- Added `haEnabled` optional parameter to phone number `buy` method

lib/resources/campaign.js

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -102,29 +102,34 @@ export class LinkUnlinkNumberResponse {
102102
/**
103103
* create Campaign
104104
* @method
105-
* @param {string} brand_id
106-
* @param {string} campaign_alias
107-
* @param {string} vertical
108-
* @param {string} usecase
109-
* @param {list} sub_usecases
110-
* @param {string} description
111-
* @param {boolean} embedded_link
112-
* @param {boolean} embedded_phone
113-
* @param {boolean} age_gated
114-
* @param {boolean} direct_lending
115-
* @param {boolean} subscriber_optin
116-
* @param {boolean} subscriber_optout
117-
* @param {boolean} subscriber_help
105+
* @param {string} brand_id
106+
* @param {string} campaign_alias
107+
* @param {string} vertical
108+
* @param {string} usecase
109+
* @param {list} sub_usecases
110+
* @param {string} description
111+
* @param {boolean} embedded_link
112+
* @param {boolean} embedded_phone
113+
* @param {boolean} age_gated
114+
* @param {boolean} direct_lending
115+
* @param {boolean} subscriber_optin
116+
* @param {boolean} subscriber_optout
117+
* @param {boolean} subscriber_help
118118
* @param {boolean} affiliate_marketing
119-
* @param {string} sample1
120-
* @param {string} sample2
119+
* @param {string} sample1
120+
* @param {string} sample2
121+
* @param {string} sample3
122+
* @param {string} sample4
123+
* @param {string} sample5
121124
* @param {message_flow} message_flow
122125
* @param {help_message} help_message
123126
* @param {optout_message} optout_message
127+
* @param {terms_and_conditions_link} terms_and_conditions_link
128+
* @param {privacy_policy_link} privacy_policy_link
124129
* @promise {object} return {@link PlivoGenericResponse} object
125130
* @fail {Error} return Error
126131
*/
127-
create(brand_id,campaign_alias,vertical,usecase,sub_usecases,description,embedded_link,embedded_phone,age_gated,direct_lending,subscriber_optin,subscriber_optout,subscriber_help,affiliate_marketing,sample1,sample2, message_flow,help_message,optout_message,params = {}) {
132+
create(brand_id,campaign_alias,vertical,usecase,sub_usecases,description,embedded_link,embedded_phone,age_gated,direct_lending,subscriber_optin,subscriber_optout,subscriber_help,affiliate_marketing,sample1,sample2,sample3,sample4,sample5,message_flow,help_message,optout_message,terms_and_conditions_link,privacy_policy_link,params = {}) {
128133
params.brand_id=brand_id;
129134
params.campaign_alias=campaign_alias;
130135
params.vertical=vertical;
@@ -141,9 +146,14 @@ export class LinkUnlinkNumberResponse {
141146
params.affiliate_marketing=affiliate_marketing;
142147
params.sample1=sample1;
143148
params.sample2=sample2;
149+
params.sample3=sample3;
150+
params.sample4=sample4;
151+
params.sample5=sample5;
144152
params.message_flow=message_flow;
145153
params.help_message=help_message;
146154
params.optout_message=optout_message;
155+
params.terms_and_conditions_link=terms_and_conditions_link;
156+
params.privacy_policy_link=privacy_policy_link;
147157
let client = this[clientKey];
148158
return new Promise((resolve, reject) => {
149159
client('POST', action, params)
@@ -173,34 +183,44 @@ export class LinkUnlinkNumberResponse {
173183
/**
174184
* update Campaign
175185
* @method
176-
* @param {string} campaign_id
177-
* @param {string} reseller_id
178-
* @param {string} description
179-
* @param {string} sample1
180-
* @param {string} sample2
186+
* @param {string} campaign_id
187+
* @param {string} reseller_id
188+
* @param {string} description
189+
* @param {string} sample1
190+
* @param {string} sample2
191+
* @param {string} sample3
192+
* @param {string} sample4
193+
* @param {string} sample5
181194
* @param {string} message_flow
182195
* @param {string} help_message
183196
* @param {string} optin_keywords
184197
* @param {string} optin_message
185198
* @param {string} optout_keywords
186199
* @param {string} optout_message
187200
* @param {string} help_keywords
201+
* @param {string} terms_and_conditions_link
202+
* @param {string} privacy_policy_link
188203
* @promise {object} return {@link PlivoGenericResponse} object
189204
* @fail {Error} return Error
190205
*/
191-
update(campaign_id,reseller_id,description,sample1,sample2,message_flow,help_message,optin_keywords,optin_message,optout_keywords,optout_message,help_keywords,params = {}) {
206+
update(campaign_id,reseller_id,description,sample1,sample2,sample3,sample4,sample5,message_flow,help_message,optin_keywords,optin_message,optout_keywords,optout_message,help_keywords,terms_and_conditions_link,privacy_policy_link,params = {}) {
192207
params.reseller_id=reseller_id;
193208
params.description=description;
194209
params.sample1=sample1;
195210
params.sample2=sample2;
211+
params.sample3=sample3;
212+
params.sample4=sample4;
213+
params.sample5=sample5;
196214
params.message_flow=message_flow;
197215
params.help_message=help_message;
198216
params.optin_keywords=optin_keywords;
199217
params.optin_message=optin_message;
200218
params.optout_keywords=optout_keywords;
201219
params.optout_message=optout_message;
202220
params.help_keywords=help_keywords;
203-
221+
params.terms_and_conditions_link=terms_and_conditions_link;
222+
params.privacy_policy_link=privacy_policy_link;
223+
204224
return super.customexecuteAction(action+campaign_id + '/', 'POST', params);
205225
}
206226

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "plivo",
3-
"version": "4.75.6",
3+
"version": "4.75.7",
44
"description": "A Node.js SDK to make voice calls and send SMS using Plivo and to generate Plivo XML",
55
"homepage": "https://github.com/plivo/plivo-node",
66
"files": [

types/resources/campaign.d.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,14 @@ export class CampaignInterface extends PlivoResource {
7171
* @param {boolean} affiliate_marketing
7272
* @param {string} sample1
7373
* @param {string} sample2
74+
* @param {string} sample3
75+
* @param {string} sample4
76+
* @param {string} sample5
7477
* @param {string} message_flow
7578
* @param {string} help_message
7679
* @param {string} optout_message
80+
* @param {string} terms_and_conditions_link
81+
* @param {string} privacy_policy_link
7782
* @param {object} params - additional params
7883
* @promise {object} return {@link CampaignCreateResponse} object
7984
* @fail {Error} return Error
@@ -95,9 +100,14 @@ export class CampaignInterface extends PlivoResource {
95100
affiliate_marketing: boolean,
96101
sample1: string,
97102
sample2: string,
103+
sample3: string,
104+
sample4: string,
105+
sample5: string,
98106
message_flow: string,
99107
help_message: string,
100108
optout_message: string,
109+
terms_and_conditions_link: string,
110+
privacy_policy_link: string,
101111
params?: {}
102112
): Promise<CampaignCreateResponse>;
103113

@@ -124,13 +134,18 @@ export class CampaignInterface extends PlivoResource {
124134
* @param {string} description
125135
* @param {string} sample1
126136
* @param {string} sample2
137+
* @param {string} sample3
138+
* @param {string} sample4
139+
* @param {string} sample5
127140
* @param {string} message_flow
128141
* @param {string} help_message
129142
* @param {string} optin_keywords
130143
* @param {string} optin_message
131144
* @param {string} optout_keywords
132145
* @param {string} optout_message
133146
* @param {string} help_keywords
147+
* @param {string} terms_and_conditions_link
148+
* @param {string} privacy_policy_link
134149
* @param {object} params - additional params
135150
* @promise {object} return {@link PlivoGenericResponse} object
136151
* @fail {Error} return Error
@@ -141,13 +156,18 @@ export class CampaignInterface extends PlivoResource {
141156
description: string,
142157
sample1: string,
143158
sample2: string,
159+
sample3: string,
160+
sample4: string,
161+
sample5: string,
144162
message_flow: string,
145163
help_message: string,
146164
optin_keywords: string,
147165
optin_message: string,
148166
optout_keywords: string,
149167
optout_message: string,
150168
help_keywords: string,
169+
terms_and_conditions_link: string,
170+
privacy_policy_link: string,
151171
params?: {}
152172
): Promise<any>;
153173

0 commit comments

Comments
 (0)