skikrumb-api 1.3.9 → 1.4.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { apiKeys, Device, Gateways, QueryDevice } from './models';
+import { apiKeys, Device, Gateways, QueryDevice, RateRequest, Rates } from './models';
 export declare const skiKrumb: (options?: {
     apiKey: string;
     supabaseToken: string;
@@ -18,6 +18,7 @@ export declare const skiKrumb: (options?: {
         state?: string;
     }) => Promise<any>;
     createSubscription: (customerId: string, priceId: string, cartId: string, productId: string, registrations: Array<string>) => Promise<any>;
+    updatePaymentIntent: (cartId: string, intentId: string) => Promise<any>;
     updateSubscription: (subscriptionId: string, quantity: number, registrations: Array<string>) => Promise<any>;
     cancelSubscription: (subscriptionId: string) => Promise<any>;
     readApiKeys: () => Promise<apiKeys[]>;
@@ -25,4 +26,5 @@ export declare const skiKrumb: (options?: {
     readDeviceDailyDistance: (serialNumber: string, query: QueryDevice) => Promise<Device[]>;
     readDeviceData: (serialNumber: string, query: QueryDevice) => Promise<Device>;
     readGateways: () => Promise<Gateways>;
+    readShippingRates: (payload: RateRequest) => Promise<Rates[]>;
 };

package/dist/index.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import ky from 'ky';
 export const skiKrumb = (options = {
     apiKey: '',
@@ -28,10 +19,10 @@ export const skiKrumb = (options = {
             ],
         },
     });
-    const createDevice = (deveui, serialNumber) => __awaiter(void 0, void 0, void 0, function* () {
+    const createDevice = async (deveui, serialNumber) => {
         if (!deveui || !serialNumber)
             throw new Error('Must pass Lora MAC (deveui) and Serial Number');
-        return yield api
+        return await api
             .post(`${options.url}/devices`, {
             headers: {
                 'content-type': 'application/json',
@@ -39,8 +30,8 @@ export const skiKrumb = (options = {
             json: { deveui: deveui, serial_number: serialNumber },
         })
             .json();
-    });
-    const createDeviceDownlink = (userId, deveui, type = 'beep') => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const createDeviceDownlink = async (userId, deveui, type = 'beep') => {
         if (!userId || !deveui || !type)
             throw new Error('Must pass userId, Lora MAC (deveui) and message type');
         let message = 'DAgAC04zKE9EPTEwKQ0K';
@@ -49,7 +40,7 @@ export const skiKrumb = (options = {
                 message = 'DBECAAAAAAAAAAAB';
                 break;
         }
-        return yield api
+        return await api
             .post(`${options.url}/devices/downlink`, {
             headers: {
                 'content-type': 'application/json',
@@ -66,11 +57,11 @@ export const skiKrumb = (options = {
             },
         })
             .json();
-    });
-    const sendMobileLocation = (payload) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const sendMobileLocation = async (payload) => {
         if (!payload)
             throw new Error('Payload is required');
-        return yield api
+        return await api
             .post(`${options.url}/devices/location/mobile`, {
             headers: {
                 'content-type': 'application/json',
@@ -78,8 +69,8 @@ export const skiKrumb = (options = {
             json: payload,
         })
             .json();
-    });
-    const createPaymentIntent = (form) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const createPaymentIntent = async (form) => {
         if (!form)
             throw new Error('Form values not posted.');
         return api
@@ -87,13 +78,22 @@ export const skiKrumb = (options = {
             body: form,
         })
             .json();
-    });
-    const getPaymentIntent = (clientSecret) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const getPaymentIntent = async (clientSecret) => {
         if (!clientSecret)
             throw new Error('Client secret is required');
         return api.get(`${options.url}/payments/intent/${clientSecret}`).json();
-    });
-    const createPrePurchaseIntent = (form) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const updatePaymentIntent = async (cartId, intentId) => {
+        if (!cartId || !intentId)
+            throw new Error('Cart Id and IntentId are required');
+        return api.patch(`${options.url}/payments/intent/${intentId}`, {
+            json: {
+                cartId: cartId,
+            }
+        }).json();
+    };
+    const createPrePurchaseIntent = async (form) => {
         if (!form)
             throw new Error('Form values not posted.');
         return api
@@ -101,8 +101,8 @@ export const skiKrumb = (options = {
             body: form,
         })
             .json();
-    });
-    const updateCustomerAddress = (customerId, email, shipping) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const updateCustomerAddress = async (customerId, email, shipping) => {
         if (!customerId || !email || !shipping) {
             throw new Error('Customer ID, email, and shipping details are required');
         }
@@ -111,8 +111,8 @@ export const skiKrumb = (options = {
             json: { customerId, email, shipping },
         })
             .json();
-    });
-    const getTaxCalculation = (amount, reference, quantity, address) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const getTaxCalculation = async (amount, reference, quantity, address) => {
         if (!amount || !reference || !quantity || !address) {
             throw new Error('Amount, reference, quantity, and address are required');
         }
@@ -121,8 +121,8 @@ export const skiKrumb = (options = {
             json: { amount, reference, quantity, address },
         })
             .json();
-    });
-    const createSubscription = (customerId, priceId, cartId, productId, registrations) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const createSubscription = async (customerId, priceId, cartId, productId, registrations) => {
         if (!customerId || !priceId || !cartId || !productId || !registrations) {
             throw new Error('Customer ID, price Id, cart ID, product ID, and registrations are required');
         }
@@ -138,8 +138,8 @@ export const skiKrumb = (options = {
             },
         })
             .json();
-    });
-    const updateSubscription = (subscriptionId, quantity, registrations) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const updateSubscription = async (subscriptionId, quantity, registrations) => {
         if (!subscriptionId) {
             throw new Error('Subscription ID is required');
         }
@@ -152,48 +152,58 @@ export const skiKrumb = (options = {
             },
         })
             .json();
-    });
-    const cancelSubscription = (subscriptionId) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const cancelSubscription = async (subscriptionId) => {
         if (!subscriptionId) {
             throw new Error('Subscription ID is required');
         }
         return api
             .delete(`${options.url}/payments/subscription/${subscriptionId}`)
             .json();
-    });
-    const readDeviceData = (serialNumber, query) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const readDeviceData = async (serialNumber, query) => {
         if (!serialNumber)
             throw new Error('Serial number is required');
         return api
             .get(`${options.url}/devices/data/${serialNumber}`, {
-            searchParams: new URLSearchParams(Object.assign({}, query)),
+            searchParams: new URLSearchParams({ ...query }),
         })
             .json();
-    });
-    const readGateways = () => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const readGateways = async () => {
         return api.get(`${options.url}/gateways`).json();
-    });
-    const readDeviceDailyDistance = (serialNumber, query) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const readDeviceDailyDistance = async (serialNumber, query) => {
         if (!serialNumber)
             throw new Error('Serial number is required');
         return api
             .get(`${options.url}/devices/${serialNumber}/distance`, {
-            searchParams: new URLSearchParams(Object.assign({}, query)),
+            searchParams: new URLSearchParams({ ...query }),
         })
             .json();
-    });
-    const readDataForDevices = (query) => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const readDataForDevices = async (query) => {
         if (!query.serial_numbers)
             throw new Error('Serial number is required');
         return api
             .get(`${options.url}/devices/data`, {
-            searchParams: new URLSearchParams(Object.assign({}, query)),
+            searchParams: new URLSearchParams({ ...query }),
         })
             .json();
-    });
-    const readApiKeys = () => __awaiter(void 0, void 0, void 0, function* () {
+    };
+    const readApiKeys = async () => {
         return api.get(`${options.url}/keys`).json();
-    });
+    };
+    const readShippingRates = async (payload) => {
+        return await api
+            .post(`${options.url}/payments/shipping-rates`, {
+            headers: {
+                'content-type': 'application/json',
+            },
+            json: payload,
+        })
+            .json();
+    };
     return {
         createDevice,
         createDeviceDownlink,
@@ -204,6 +214,7 @@ export const skiKrumb = (options = {
         updateCustomerAddress,
         getTaxCalculation,
         createSubscription,
+        updatePaymentIntent,
         updateSubscription,
         cancelSubscription,
         readApiKeys,
@@ -211,5 +222,6 @@ export const skiKrumb = (options = {
         readDeviceDailyDistance,
         readDeviceData,
         readGateways,
+        readShippingRates
     };
 };

package/dist/models.d.ts

@@ -55,3 +55,45 @@ export interface QueryDevice {
     page?: string;
     timeZone?: string;
 }
+export interface Amount {
+    value: string;
+    currency: string;
+}
+export interface Surcharge {
+    type: string;
+    amount: Amount;
+}
+export interface Tax {
+    type: string;
+    amount: Amount;
+}
+export interface ValidUntil {
+    year: number;
+    month: number;
+    day: number;
+}
+export interface Rates {
+    service_id: string;
+    valid_until: ValidUntil;
+    total: Amount;
+    base: Amount;
+    surcharges: Surcharge[];
+    taxes: Tax[];
+    transit_time_days: number;
+    transit_time_not_available: boolean;
+    carrier_name: string;
+    service_name: string;
+}
+export interface Address {
+    city: string;
+    country: string;
+    line1: string;
+    postal_code: string;
+    state: string;
+}
+export interface RateRequest {
+    name: string;
+    address: Address;
+    email_addresses: string[];
+    quantity: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skikrumb-api",
-  "version": "1.3.9",
+  "version": "1.4.0",
   "description": "Wrapper for the skiKrumb API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,6 +18,6 @@
     "prettier-plugin-organize-attributes": "^1.0.0"
   },
   "dependencies": {
-    "ky": "^0.33.3"
+    "ky": "^1.7.5"
   }
 }

package/readme.md

@@ -52,4 +52,4 @@ Defaults to production skiKrumb API URL. Possible values: `https://api-dev.skikr
 > Requires an API key. Request an API Key by emailing info@skikrumb.ca
 
 > © skiKrumb
-> `2023`
+> `2025`

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2015",
+    "target": "ES2018",
     "module": "ES2020",
     "declaration": true,
     "outDir": "./dist",
@@ -14,4 +14,4 @@
     "dist",
     ".idea"
   ]
-}
+}