lightspeed-retail-sdk 2.0.9 → 2.0.10

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright 2024, Darryl Morley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,7 +4,7 @@ A JavaScript SDK for interacting with the Lightspeed Retail API. This SDK provid
 
 ## Update
 
-This package has been enhanced to support both CommonJS and module usage.
+This package has been enhanced to support both CommonJS and module usage. I have also added methods for fetching both a gift card, and all gift cards.
 
 ## Features
 

package/index.cjs

@@ -641,6 +641,42 @@ class LightspeedRetailSDK {
       return this.handleError("GET SALE ERROR", error);
     }
   }
+
+  // Fetch all Credit Accounts
+  async getGiftCards(relations) {
+    const options = {
+      url: `${this.baseUrl}/${this.accountID}/CreditAccount.json?giftCard=true`,
+      method: "GET",
+    };
+
+    if (relations) options.url = options.url + `?load_relations=${relations}`;
+
+    try {
+      const response = await this.getAllData(options);
+      return response;
+    } catch (error) {
+      return this.handleError("GET CREDIT ACCOUNTS ERROR", error);
+    }
+  }
+
+  // Fetch a Credit Account by ID
+  async getGiftCard(id, relations) {
+    const options = {
+      url: `${this.baseUrl}/${this.accountID}/CreditAccount.json?giftCard=true&code=${id}`,
+      method: "GET",
+    };
+
+    if (!id) return this.handleError("You need to provide a gift card code");
+
+    if (relations) options.url = options.url + `?load_relations=${relations}`;
+
+    try {
+      const response = await this.getAllData(options);
+      return response;
+    } catch (error) {
+      return this.handleError("GET CREDIT ACCOUNT ERROR", error);
+    }
+  }
 }
 
 module.exports = LightspeedRetailSDK;

package/index.mjs

@@ -52,6 +52,17 @@ class LightspeedRetailSDK {
     }
   }
 
+    // Check if error is retryable
+    isRetryableError = (err) => {
+      if (!err.response) {
+        // No response (network error or timeout)
+        return true;
+      }
+  
+      // Retry for server errors (500-599)
+      return err.response.status >= 500 && err.response.status <= 599;
+    };
+
   // Update the last response
   setLastResponse = (response) => (this.lastResponse = response);
 
@@ -178,17 +189,6 @@ class LightspeedRetailSDK {
     return allData;
   }
 
-  // Check if error is retryable
-  isRetryableError = (err) => {
-    if (!err.response) {
-      // No response (network error or timeout)
-      return true;
-    }
-
-    // Retry for server errors (500-599)
-    return err.response.status >= 500 && err.response.status <= 599;
-  };
-
   // Get customer by ID
   async getCustomer(id, relations) {
     const options = {
@@ -641,6 +641,42 @@ class LightspeedRetailSDK {
       return this.handleError("GET SALE ERROR", error);
     }
   }
+
+  // Fetch all Credit Accounts
+  async getGiftCards(relations) {
+    const options = {
+      url: `${this.baseUrl}/${this.accountID}/CreditAccount.json?giftCard=true`,
+      method: "GET",
+    };
+
+    if (relations) options.url = options.url + `?load_relations=${relations}`;
+
+    try {
+      const response = await this.getAllData(options);
+      return response;
+    } catch (error) {
+      return this.handleError("GET CREDIT ACCOUNTS ERROR", error);
+    }
+  }
+
+  // Fetch a Credit Account by ID
+  async getGiftCard(id, relations) {
+    const options = {
+      url: `${this.baseUrl}/${this.accountID}/CreditAccount.json?giftCard=true&code=${id}`,
+      method: "GET",
+    };
+
+    if (!id) return this.handleError("You need to provide a gift card code");
+
+    if (relations) options.url = options.url + `?load_relations=${relations}`;
+
+    try {
+      const response = await this.getAllData(options);
+      return response;
+    } catch (error) {
+      return this.handleError("GET CREDIT ACCOUNT ERROR", error);
+    }
+  }
 }
 
 export default LightspeedRetailSDK;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lightspeed-retail-sdk",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "description": "Another unofficial Lightspeed Retail API SDK for Node.js",
   "type": "module",
   "main": "index.cjs",
@@ -12,7 +12,7 @@
     }
   },
   "author": "https://github.com/darrylmorley",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "axios": "^1.3.4",
     "dotenv": "^16.4.4"