Skip to content

Commit f8a7ad6

Browse files
kfitzgeraldkfitzgerald
committed
- Added article follow route
- Added product follow route - Added article click histogram route - Added product click histogram route - Added article click top-n route - Added product click top-n route - package.json: Bumped version to 4.8.0
1 parent f5267d2 commit f8a7ad6

File tree

5 files changed

+298
-6
lines changed

5 files changed

+298
-6
lines changed

‎dist/client.js

Lines changed: 147 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ function Client(config) {
8282
/**
8383
* SDK Version
8484
*/
85-
Client.Version = '4.7.0';
85+
Client.Version = '4.8.0';
8686

8787
/**
8888
* Expose the Provider base class
@@ -432,6 +432,33 @@ Client.resourceBinders.push(function(Client) {
432432
}, callback);
433433
},
434434

435+
/**
436+
* Follows the article URL.
437+
* @param {string} article_id – ID of the article
438+
* @param {object} [query] - Filter arguments
439+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
440+
* @return {Query} - Compiled query ready for execution
441+
* @memberof Client.articles#
442+
*/
443+
follow: function(article_id, query, callback) {
444+
// Shift optional arguments, if necessary
445+
if (typeof query === "function") {
446+
callback = query;
447+
query = undefined;
448+
}
449+
450+
return Client._makeRequest({
451+
api: 'api',
452+
action: 'article.follow',
453+
method: 'GET',
454+
path: '/articles/{article_id}/follow',
455+
pathParams: {
456+
article_id: article_id
457+
},
458+
query: query
459+
}, callback);
460+
},
461+
435462
/**
436463
* Retrieves an article's content
437464
* @param {alternatives} url_or_id – URL or ID of the article
@@ -963,6 +990,33 @@ Client.resourceBinders.push(function(Client) {
963990
product_id: product_id
964991
}
965992
}, callback);
993+
},
994+
995+
/**
996+
* Follows the purchase URL.
997+
* @param {string} product_id – Object identifier.
998+
* @param {object} [query] - Filter arguments
999+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
1000+
* @return {Query} - Compiled query ready for execution
1001+
* @memberof Client.products#
1002+
*/
1003+
follow: function(product_id, query, callback) {
1004+
// Shift optional arguments, if necessary
1005+
if (typeof query === "function") {
1006+
callback = query;
1007+
query = undefined;
1008+
}
1009+
1010+
return Client._makeRequest({
1011+
api: 'api',
1012+
action: 'product.follow',
1013+
method: 'GET',
1014+
path: '/products/{product_id}/follow',
1015+
pathParams: {
1016+
product_id: product_id
1017+
},
1018+
query: query
1019+
}, callback);
9661020
}
9671021

9681022
};
@@ -1061,6 +1115,52 @@ Client.resourceBinders.push(function(Client) {
10611115
*/
10621116
Client.reporting = {
10631117

1118+
/**
1119+
* Returns a histogram of article clicks in timescale
1120+
* @param {object} [query] - Filter arguments
1121+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
1122+
* @return {Query} - Compiled query ready for execution
1123+
* @memberof Client.reportings#
1124+
*/
1125+
article_click_date_histogram: function(query, callback) {
1126+
// Shift optional arguments, if necessary
1127+
if (typeof query === "function") {
1128+
callback = query;
1129+
query = undefined;
1130+
}
1131+
1132+
return Client._makeRequest({
1133+
api: 'api',
1134+
action: 'reporting.article_click_date_histogram',
1135+
method: 'GET',
1136+
path: '/reporting/articles/clicks/date-histogram',
1137+
query: query
1138+
}, callback);
1139+
},
1140+
1141+
/**
1142+
* Returns the top N results per aggregation group
1143+
* @param {object} [query] - Filter arguments
1144+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
1145+
* @return {Query} - Compiled query ready for execution
1146+
* @memberof Client.reportings#
1147+
*/
1148+
article_click_top_n: function(query, callback) {
1149+
// Shift optional arguments, if necessary
1150+
if (typeof query === "function") {
1151+
callback = query;
1152+
query = undefined;
1153+
}
1154+
1155+
return Client._makeRequest({
1156+
api: 'api',
1157+
action: 'reporting.article_click_top_n',
1158+
method: 'GET',
1159+
path: '/reporting/articles/clicks/top-n',
1160+
query: query
1161+
}, callback);
1162+
},
1163+
10641164
/**
10651165
* Returns a histogram of page metrics in timescale
10661166
* @param {object} [query] - Filter arguments
@@ -1130,6 +1230,52 @@ Client.resourceBinders.push(function(Client) {
11301230
}, callback);
11311231
},
11321232

1233+
/**
1234+
* Returns a histogram of product clicks in timescale
1235+
* @param {object} [query] - Filter arguments
1236+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
1237+
* @return {Query} - Compiled query ready for execution
1238+
* @memberof Client.reportings#
1239+
*/
1240+
product_click_date_histogram: function(query, callback) {
1241+
// Shift optional arguments, if necessary
1242+
if (typeof query === "function") {
1243+
callback = query;
1244+
query = undefined;
1245+
}
1246+
1247+
return Client._makeRequest({
1248+
api: 'api',
1249+
action: 'reporting.product_click_date_histogram',
1250+
method: 'GET',
1251+
path: '/reporting/products/clicks/date-histogram',
1252+
query: query
1253+
}, callback);
1254+
},
1255+
1256+
/**
1257+
* Returns the top N results per aggregation group
1258+
* @param {object} [query] - Filter arguments
1259+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
1260+
* @return {Query} - Compiled query ready for execution
1261+
* @memberof Client.reportings#
1262+
*/
1263+
product_click_top_n: function(query, callback) {
1264+
// Shift optional arguments, if necessary
1265+
if (typeof query === "function") {
1266+
callback = query;
1267+
query = undefined;
1268+
}
1269+
1270+
return Client._makeRequest({
1271+
api: 'api',
1272+
action: 'reporting.product_click_top_n',
1273+
method: 'GET',
1274+
path: '/reporting/products/clicks/top-n',
1275+
query: query
1276+
}, callback);
1277+
},
1278+
11331279
/**
11341280
* Returns a histogram of resource metrics in timescale
11351281
* @param {object} [query] - Filter arguments

‎dist/okanjo-sdk.js

Lines changed: 147 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1919,7 +1919,7 @@ function Client(config) {
19191919
/**
19201920
* SDK Version
19211921
*/
1922-
Client.Version = '4.7.0';
1922+
Client.Version = '4.8.0';
19231923

19241924
/**
19251925
* Expose the Provider base class
@@ -2269,6 +2269,33 @@ Client.resourceBinders.push(function(Client) {
22692269
}, callback);
22702270
},
22712271

2272+
/**
2273+
* Follows the article URL.
2274+
* @param {string} article_id – ID of the article
2275+
* @param {object} [query] - Filter arguments
2276+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
2277+
* @return {Query} - Compiled query ready for execution
2278+
* @memberof Client.articles#
2279+
*/
2280+
follow: function(article_id, query, callback) {
2281+
// Shift optional arguments, if necessary
2282+
if (typeof query === "function") {
2283+
callback = query;
2284+
query = undefined;
2285+
}
2286+
2287+
return Client._makeRequest({
2288+
api: 'api',
2289+
action: 'article.follow',
2290+
method: 'GET',
2291+
path: '/articles/{article_id}/follow',
2292+
pathParams: {
2293+
article_id: article_id
2294+
},
2295+
query: query
2296+
}, callback);
2297+
},
2298+
22722299
/**
22732300
* Retrieves an article's content
22742301
* @param {alternatives} url_or_id – URL or ID of the article
@@ -2800,6 +2827,33 @@ Client.resourceBinders.push(function(Client) {
28002827
product_id: product_id
28012828
}
28022829
}, callback);
2830+
},
2831+
2832+
/**
2833+
* Follows the purchase URL.
2834+
* @param {string} product_id – Object identifier.
2835+
* @param {object} [query] - Filter arguments
2836+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
2837+
* @return {Query} - Compiled query ready for execution
2838+
* @memberof Client.products#
2839+
*/
2840+
follow: function(product_id, query, callback) {
2841+
// Shift optional arguments, if necessary
2842+
if (typeof query === "function") {
2843+
callback = query;
2844+
query = undefined;
2845+
}
2846+
2847+
return Client._makeRequest({
2848+
api: 'api',
2849+
action: 'product.follow',
2850+
method: 'GET',
2851+
path: '/products/{product_id}/follow',
2852+
pathParams: {
2853+
product_id: product_id
2854+
},
2855+
query: query
2856+
}, callback);
28032857
}
28042858

28052859
};
@@ -2898,6 +2952,52 @@ Client.resourceBinders.push(function(Client) {
28982952
*/
28992953
Client.reporting = {
29002954

2955+
/**
2956+
* Returns a histogram of article clicks in timescale
2957+
* @param {object} [query] - Filter arguments
2958+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
2959+
* @return {Query} - Compiled query ready for execution
2960+
* @memberof Client.reportings#
2961+
*/
2962+
article_click_date_histogram: function(query, callback) {
2963+
// Shift optional arguments, if necessary
2964+
if (typeof query === "function") {
2965+
callback = query;
2966+
query = undefined;
2967+
}
2968+
2969+
return Client._makeRequest({
2970+
api: 'api',
2971+
action: 'reporting.article_click_date_histogram',
2972+
method: 'GET',
2973+
path: '/reporting/articles/clicks/date-histogram',
2974+
query: query
2975+
}, callback);
2976+
},
2977+
2978+
/**
2979+
* Returns the top N results per aggregation group
2980+
* @param {object} [query] - Filter arguments
2981+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
2982+
* @return {Query} - Compiled query ready for execution
2983+
* @memberof Client.reportings#
2984+
*/
2985+
article_click_top_n: function(query, callback) {
2986+
// Shift optional arguments, if necessary
2987+
if (typeof query === "function") {
2988+
callback = query;
2989+
query = undefined;
2990+
}
2991+
2992+
return Client._makeRequest({
2993+
api: 'api',
2994+
action: 'reporting.article_click_top_n',
2995+
method: 'GET',
2996+
path: '/reporting/articles/clicks/top-n',
2997+
query: query
2998+
}, callback);
2999+
},
3000+
29013001
/**
29023002
* Returns a histogram of page metrics in timescale
29033003
* @param {object} [query] - Filter arguments
@@ -2967,6 +3067,52 @@ Client.resourceBinders.push(function(Client) {
29673067
}, callback);
29683068
},
29693069

3070+
/**
3071+
* Returns a histogram of product clicks in timescale
3072+
* @param {object} [query] - Filter arguments
3073+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
3074+
* @return {Query} - Compiled query ready for execution
3075+
* @memberof Client.reportings#
3076+
*/
3077+
product_click_date_histogram: function(query, callback) {
3078+
// Shift optional arguments, if necessary
3079+
if (typeof query === "function") {
3080+
callback = query;
3081+
query = undefined;
3082+
}
3083+
3084+
return Client._makeRequest({
3085+
api: 'api',
3086+
action: 'reporting.product_click_date_histogram',
3087+
method: 'GET',
3088+
path: '/reporting/products/clicks/date-histogram',
3089+
query: query
3090+
}, callback);
3091+
},
3092+
3093+
/**
3094+
* Returns the top N results per aggregation group
3095+
* @param {object} [query] - Filter arguments
3096+
* @param {requestCallback} [callback] – Optional callback. When present, the request is executed
3097+
* @return {Query} - Compiled query ready for execution
3098+
* @memberof Client.reportings#
3099+
*/
3100+
product_click_top_n: function(query, callback) {
3101+
// Shift optional arguments, if necessary
3102+
if (typeof query === "function") {
3103+
callback = query;
3104+
query = undefined;
3105+
}
3106+
3107+
return Client._makeRequest({
3108+
api: 'api',
3109+
action: 'reporting.product_click_top_n',
3110+
method: 'GET',
3111+
path: '/reporting/products/clicks/top-n',
3112+
query: query
3113+
}, callback);
3114+
},
3115+
29703116
/**
29713117
* Returns a histogram of resource metrics in timescale
29723118
* @param {object} [query] - Filter arguments

‎dist/okanjo-sdk.min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/okanjo-sdk.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "okanjo",
3-
"version": "4.7.0",
3+
"version": "4.8.0",
44
"description": "Integrate your application with the Okanjo API.",
55
"main": "dist/client.js",
66
"scripts": {

0 commit comments

Comments
 (0)