-
Notifications
You must be signed in to change notification settings - Fork 2
/
location_sample.js
297 lines (270 loc) · 8.58 KB
/
location_sample.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
#!/usr/bin/env node
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
const apiHelper = require('./lib/api_helper');
const {delay, printHeader, printObjectEntities} = require('./shared_utils');
main();
/**
* Initiates the Location Sample which makes multiple requests against
* the Business Communications API. The requests this sample
* makes are:
*
* - Creates a test location
* - Gets a location
* - Updates a location
* - Lists locations for a brand
* - Delete the created location
*/
async function main() {
const agentName = process.argv[2];
const regex = 'brands/\\S+/agents/\\S+';
if ((process.argv.length != 3) || (agentName.match(regex) == null)) {
console.log('Usage: <AGENT_NAME>');
return;
}
const brandName = agentName.slice(0, agentName.indexOf('/agents'));
printHeader('Location script for agent - ' + agentName);
// Using Googleplex for placeId sample.
const placeId = 'ChIJj61dQgK6j4AR4GeTYWZsKWw';
printHeader('Create Location');
const newLocation = await createLocation(brandName, agentName, placeId);
await delay(3000);
printHeader('Get Location Details');
let location = await getLocation(newLocation.name);
await delay(3000);
// updateLocation will modify the agentName associated with the location
// NOTE: This call will fail unless the agentName parameter is a valid value
printHeader('Updating Location');
await updateLocation(location, '/brands/BRAND_ID/agents/AGENT_ID');
await delay(3000);
printHeader('List Locations');
await listLocations(brandName);
await delay(3000);
printHeader('Deleting Location');
deleteLocation(location.name);
}
/**
* Creates a new location associated with a brand and agent.
*
* @param {string} brandName The brand associated with the location.
* @param {string} agentName The agent associated with the location.
* @param {string} placeId The placeId associated with the location.
* @return {object} Returns a promise resolving the data returned from the API.
*/
function createLocation(brandName, agentName, placeId) {
const locationObject = {
placeId: placeId,
agent: agentName,
defaultLocale: 'en', // Must match a conversational setting locale
conversationalSettings: {
en: {
privacyPolicy: {url: 'http://www.company.com/privacy'},
welcomeMessage: {text: 'Welcome! How can I help?'},
offlineMessage: {text: 'This location is currently offline, please leave a message and we will get back to you as soon as possible.'},
conversationStarters: [
{
suggestion: {
reply: {
text: 'Chip #1',
postbackData: 'chip_1',
},
},
},
{
suggestion: {
reply: {
text: 'Chip #2',
postbackData: 'chip_2',
},
},
},
{
suggestion: {
reply: {
text: 'Chip #3',
postbackData: 'chip_3',
},
},
},
{
suggestion: {
reply: {
text: 'Chip #4',
postbackData: 'chip_4',
},
},
},
{
suggestion: {
action: {
text: 'Chip #5',
postbackData: 'chip_5',
openUrlAction: {url: 'https://www.google.com'},
},
},
},
],
},
},
locationEntryPointConfigs: [
{allowedEntryPoint: 'PLACESHEET'},
{allowedEntryPoint: 'MAPS_TACTILE'},
],
};
return new Promise((resolve, reject) => {
const apiConnector = apiHelper.init();
apiConnector.then((apiObject) => {
// setup the parameters for the API call
const apiParams = {
auth: apiObject.authClient,
parent: brandName,
resource: locationObject,
};
apiObject.bcApi.brands.locations.create(apiParams, {},
(err, response) => {
if (err !== undefined && err !== null) {
console.log('Error:');
console.log(err);
reject(err);
} else {
printObjectEntities(response.data);
resolve(response.data);
}
});
});
});
}
/**
* Based on the location name, looks up and returns the location details.
*
* @param {string} locationName The location to be updated.
* @return {object} Returns a promise resolving the data returned from the API.
*/
function getLocation(locationName) {
return new Promise((resolve, reject) => {
const apiConnector = apiHelper.init();
apiConnector.then((apiObject) => {
// setup the parameters for the API call
const apiParams = {
auth: apiObject.authClient,
name: locationName,
};
apiObject.bcApi.brands.locations.get(apiParams, {},
(err, response) => {
if (err !== undefined && err !== null) {
console.log('Error:');
console.log(err);
reject(err);
} else {
printObjectEntities(response.data);
resolve(response.data);
}
},
);
});
});
}
/**
* Updates the agent associated with the passed in location.
*
* @param {string} locationObj The location that needs to be updated.
* @param {string} newAgentName The new agent to associate with the location.
* @return {object} Returns a promise resolving the data returned from the API.
*/
function updateLocation(locationObj, newAgentName) {
locationObj.agent = newAgentName;
return new Promise((resolve, reject) => {
const apiConnector = apiHelper.init();
apiConnector.then((apiObject) => {
// setup the parameters for the API call
const apiParams = {
auth: apiObject.authClient,
name: locationObj.name,
resource: locationObj,
updateMask: 'agent',
};
apiObject.bcApi.brands.locations.patch(apiParams, {},
(err, response) => {
if (err !== undefined && err !== null) {
console.log('Error:');
console.log(err);
reject(err);
} else {
printObjectEntities(response.data);
resolve(response.data);
}
},
);
}).catch((err) => {
console.log(err);
reject(err);
});
});
}
/**
* Lists locations associated with a brand.
*
* @param {string} brandName The brand name associated with locations.
* @return {object} A JSON object representing the selected entry points.
*/
function listLocations(brandName) {
return new Promise((resolve, reject) => {
const apiConnector = apiHelper.init();
apiConnector.then((apiObject) => {
// setup the parameters for the API call
const apiParams = {
auth: apiObject.authClient,
parent: brandName,
};
apiObject.bcApi.brands.locations.list(apiParams, {},
(err, response) => {
if (err !== undefined && err !== null) {
console.log('Error:');
console.log(err);
reject(err);
} else {
printObjectEntities(response.data);
resolve(response.data);
}
},
);
});
});
}
/**
* Based on the location name, deletes the location. Only a non-verified location can be deleted.
*
* @param {string} locationName The location to be deleted.
* @return {obj} A promise which resolves to the agent object return
* by the api.
*/
function deleteLocation(locationName) {
return new Promise((resolve, reject) => {
const apiConnector = apiHelper.init();
apiConnector.then((apiObject) => {
const apiParams = {
auth: apiObject.authClient,
name: locationName,
};
apiObject.bcApi.brands.locations.delete(apiParams, {}, (err, response) => {
if (err !== undefined && err !== null) {
reject(err);
} else {
printObjectEntities(response.data);
resolve(response.data);
}
});
});
});
}