@8ms/helpers 1.35.3 → 1.36.2

package/api/index.d.ts

@@ -1,4 +1,5 @@
 export declare enum State {
+    CANCELLED = "CANCELLED",
     ERROR = "ERROR",
     IDLE = "IDLE",
     PENDING = "PENDING",

package/api/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.unexpectedError = exports.State = void 0;
 var State;
 (function (State) {
+    State["CANCELLED"] = "CANCELLED";
     State["ERROR"] = "ERROR";
     State["IDLE"] = "IDLE";
     State["PENDING"] = "PENDING";

package/axios/delete.d.ts

@@ -0,0 +1,11 @@
+import ApiResponse from '../api/ApiResponse';
+export type Delete = {
+    config?: object;
+    url: string;
+};
+/**
+ * Make a DELETE request.
+ * Cant use the function name delete as its reserved
+ */
+declare const deleteRequest: (props: Delete) => Promise<ApiResponse>;
+export default deleteRequest;

package/axios/delete.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
+/**
+ * Make a DELETE request.
+ * Cant use the function name delete as its reserved
+ */
+const deleteRequest = async (props) => {
+    const response = await axios_1.default.delete(props.url, props?.config ?? {})
+        .then(async (response) => {
+        // Is API response
+        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
+            return new ApiResponse_1.default(response.data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new ApiResponse_1.default()).setToSuccess({
+                body: response.data,
+            });
+        }
+        // Error
+        return (new ApiResponse_1.default()).setToError({
+            body: response.data,
+            error: response.statusText,
+        });
+    })
+        .catch(error => {
+        // Error
+        return (new ApiResponse_1.default()).setToError({
+            error: error.message,
+        });
+    });
+    return response;
+};
+exports.default = deleteRequest;

package/googleAds/keywordPlanner/index.js

@@ -222,7 +222,6 @@ var Country;
     Country[Country["YEMEN"] = 2887] = "YEMEN";
     Country[Country["ZAMBIA"] = 2894] = "ZAMBIA";
 })(Country || (exports.Country = Country = {}));
-;
 var Month;
 (function (Month) {
     Month["JANUARY"] = "JANUARY";

package/googleAds/keywordPlanner/request.d.ts

@@ -1,17 +1,18 @@
 import { Country, Month, Network } from "./";
 export type Request = {
-    customerId: string;
-    geoTargetConstants?: Country[];
+    countries?: Country[] | null;
+    customerId?: string;
     historicalMetricsOptions?: {
-        start_month: Month;
-        start_year: number;
-        end_month: Month;
-        end_year: number;
+        startMonth: Month;
+        startYear: number;
+        endMonth: Month;
+        endYear: number;
     };
     includeAdultKeywords?: boolean;
     keywordPlanNetwork?: Network;
-    keywords: string[];
-    language?: null;
+    queries?: string[];
+    language?: number | null;
+    url?: string;
 };
 declare const request: Request;
 export default request;

package/googleAds/keywordPlanner/request.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const _1 = require("./");
 const request = {
-    customerId: '',
-    geoTargetConstants: [],
+    countries: [],
+    customerId: "",
     historicalMetricsOptions: null,
     includeAdultKeywords: false,
     keywordPlanNetwork: _1.Network.GOOGLE_SEARCH_ONLY,
-    keywords: [],
+    queries: [],
     language: null,
 };
 exports.default = request;

package/googleAds/keywordPlanner/response.d.ts

@@ -6,6 +6,7 @@ type Month = {
     year: number;
 };
 type Keyword = {
+    payload: object;
     keyword: string;
     avgCpc: number;
     avgSearchVolume: number;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.35.3",
+	"version":         "1.36.2",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"