Merge pull request #60 from JJ-Cro/update11122024

v1.0.6 feat(); added new Loan endpoints, updated types as per release notes, added examples for new endpoints

examples/apidoc/CBExchangeClient/getAllConversions.js

@@ -0,0 +1,20 @@
+const { CBExchangeClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /conversions
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new CBExchangeClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getAllConversions(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/acquireOrRepayLoan.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/portfolios/{portfolio}/loans/{asset}
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.acquireOrRepayLoan(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getActiveLoansForPortfolio.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/portfolios/{portfolio}/loans
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getActiveLoansForPortfolio(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getLoanInfoForPortfolioAsset.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/portfolios/{portfolio}/loans/{asset}
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getLoanInfoForPortfolioAsset(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getMaxLoanAvailability.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/portfolios/{portfolio}/loans/{asset}/availability
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getMaxLoanAvailability(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/previewLoanUpdate.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/portfolios/{portfolio}/loans/{asset}/preview
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.previewLoanUpdate(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });