@gr4vy/sdk 1.1.30 → 1.1.32

package/FUNCTIONS.md

@@ -20,13 +20,18 @@ specific category of applications.
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { accountUpdaterJobsCreate } from "@gr4vy/sdk/funcs/accountUpdaterJobsCreate.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {

package/README.md

@@ -450,14 +450,13 @@ try {
 
 ### Example
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
+import { Gr4vy } from "@gr4vy/sdk";
 import * as errors from "@gr4vy/sdk/models/errors";
-import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -554,13 +553,14 @@ If the selected server has variables, you may override its default values throug
 #### Example
 
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  server: "production",
+  id: "<id>",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -585,13 +585,13 @@ run();
 
 The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  serverURL: "https://api.sandbox.example.gr4vy.app",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -675,16 +675,15 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
+  merchantAccountId: "<id>",
 });
 
 async function run() {
@@ -742,13 +741,12 @@ yarn add @gr4vy/sdk zod
 ### Example
 
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -783,13 +781,12 @@ syntax.
 Here's an example of one such pagination call:
 
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -815,13 +812,12 @@ Some of the endpoints in this SDK support retries.  If you use the SDK without a
 
 To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -855,13 +851,22 @@ run();
 
 If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-  id: "example",
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  merchantAccountId: "<id>",
   server: "sandbox",
-  merchantAccountId: "default",
+  id: "example",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),

package/docs/sdks/all/README.md

@@ -15,16 +15,15 @@ Create a refund for all instruments on a transaction.
 
 <!-- UsageSnippet language="typescript" operationID="create_full_transaction_refund" method="post" path="/transactions/{transaction_id}/refunds/all" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -42,13 +41,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { transactionsRefundsAllCreate } from "@gr4vy/sdk/funcs/transactionsRefundsAllCreate.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {

package/docs/sdks/auditlogs/README.md

@@ -15,16 +15,15 @@ Returns a list of activity by dashboard users.
 
 <!-- UsageSnippet language="typescript" operationID="list_audit_logs" method="get" path="/audit-logs" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -44,13 +43,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { auditLogsList } from "@gr4vy/sdk/funcs/auditLogsList.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {

package/docs/sdks/balances/README.md

@@ -15,16 +15,15 @@ Fetch the balances for one or more gift cards.
 
 <!-- UsageSnippet language="typescript" operationID="list_gift_card_balances" method="post" path="/gift-cards/balances" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -55,13 +54,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { giftCardsBalancesList } from "@gr4vy/sdk/funcs/giftCardsBalancesList.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {

package/docs/sdks/buyers/README.md

@@ -19,16 +19,15 @@ List all buyers or search for a specific buyer.
 
 <!-- UsageSnippet language="typescript" operationID="list_buyers" method="get" path="/buyers" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -48,13 +47,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { buyersList } from "@gr4vy/sdk/funcs/buyersList.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -111,16 +115,15 @@ Create a new buyer record.
 
 <!-- UsageSnippet language="typescript" operationID="add_buyer" method="post" path="/buyers" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -138,13 +141,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { buyersCreate } from "@gr4vy/sdk/funcs/buyersCreate.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -200,16 +208,15 @@ Fetches a buyer by its ID.
 
 <!-- UsageSnippet language="typescript" operationID="get_buyer" method="get" path="/buyers/{buyer_id}" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -227,13 +234,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { buyersGet } from "@gr4vy/sdk/funcs/buyersGet.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -289,16 +301,15 @@ Updates a buyer record.
 
 <!-- UsageSnippet language="typescript" operationID="update_buyer" method="put" path="/buyers/{buyer_id}" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -316,13 +327,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { buyersUpdate } from "@gr4vy/sdk/funcs/buyersUpdate.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -379,16 +395,15 @@ Permanently removes a buyer record.
 
 <!-- UsageSnippet language="typescript" operationID="delete_buyer" method="delete" path="/buyers/{buyer_id}" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -406,13 +421,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { buyersDelete } from "@gr4vy/sdk/funcs/buyersDelete.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {

package/docs/sdks/cardschemedefinitions/README.md

@@ -15,16 +15,15 @@ Fetch a list of the definitions of each card scheme.
 
 <!-- UsageSnippet language="typescript" operationID="list_card_scheme_definitions" method="get" path="/card-scheme-definitions" -->
 ```typescript
-import { Gr4vy, withToken } from "@gr4vy/sdk";
-import fs from "fs";
+import { Gr4vy } from "@gr4vy/sdk";
 
 const gr4vy = new Gr4vy({
-    id: "example",
-    server: "sandbox",
-    merchantAccountId: "default",
-    bearerAuth: withToken({
-      privateKey: fs.readFileSync("private_key.pem", "utf8"),
-    }),
+  merchantAccountId: "<id>",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {
@@ -42,13 +41,18 @@ The standalone function version of this method:
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
+import { withToken } from "@gr4vy/sdk/lib/auth.js";
 import { cardSchemeDefinitionsList } from "@gr4vy/sdk/funcs/cardSchemeDefinitionsList.js";
 
 // Use `Gr4vyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const gr4vy = new Gr4vyCore({
   merchantAccountId: "<id>",
-  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
+  server: "sandbox",
+  id: "example",
+  bearerAuth: withToken({
+    privateKey: fs.readFileSync("private_key.pem", "utf8"),
+  }),
 });
 
 async function run() {