@gr4vy/sdk 1.1.28 → 1.1.30

package/FUNCTIONS.md

@@ -20,27 +20,27 @@ specific category of applications.
 
 ```typescript
 import { Gr4vyCore } from "@gr4vy/sdk/core.js";
-import { withToken } from "@gr4vy/sdk/lib/auth.js";
-import { browsePaymentMethodDefinitionsGet } from "@gr4vy/sdk/funcs/browsePaymentMethodDefinitionsGet.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>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
 });
 
 async function run() {
-  const res = await browsePaymentMethodDefinitionsGet(gr4vy);
+  const res = await accountUpdaterJobsCreate(gr4vy, {
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("browsePaymentMethodDefinitionsGet failed:", res.error);
+    console.log("accountUpdaterJobsCreate failed:", res.error);
   }
 }
 

package/README.md

@@ -315,9 +315,6 @@ try {
 
 * [list](docs/sdks/balances/README.md#list) - List gift card balances
 
-### [Gr4vy SDK](docs/sdks/gr4vy/README.md)
-
-* [browsePaymentMethodDefinitionsGet](docs/sdks/gr4vy/README.md#browsepaymentmethoddefinitionsget) - Browse
 
 ### [merchantAccounts](docs/sdks/merchantaccounts/README.md)
 
@@ -453,13 +450,14 @@ try {
 
 ### Example
 ```typescript
-import { Gr4vy } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
 import * as errors from "@gr4vy/sdk/models/errors";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -467,7 +465,12 @@ const gr4vy = new Gr4vy({
 
 async function run() {
   try {
-    const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+    const result = await gr4vy.accountUpdater.jobs.create({
+      paymentMethodIds: [
+        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+        "f29e886e-93cc-4714-b4a3-12b7a718e595",
+      ],
+    });
 
     console.log(result);
   } catch (error) {
@@ -479,8 +482,12 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.HTTPValidationError) {
-        console.log(error.data$.detail); // ValidationError[]
+      if (error instanceof errors.Error400) {
+        console.log(error.data$.type); // string
+        console.log(error.data$.code); // string
+        console.log(error.data$.status); // number
+        console.log(error.data$.message); // string
+        console.log(error.data$.details); // ErrorDetail[]
       }
     }
   }
@@ -493,18 +500,18 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`Gr4vyError`](./src/models/errors/gr4vyerror.ts): The base class for HTTP error responses.
-  * [`Error400`](./src/models/errors/error400.ts): The request was invalid. Status code `400`. *
-  * [`Error401`](./src/models/errors/error401.ts): The request was unauthorized. Status code `401`. *
-  * [`Error403`](./src/models/errors/error403.ts): The credentials were invalid or the caller did not have permission to act on the resource. Status code `403`. *
-  * [`Error404`](./src/models/errors/error404.ts): The resource was not found. Status code `404`. *
-  * [`Error405`](./src/models/errors/error405.ts): The request method was not allowed. Status code `405`. *
-  * [`Error409`](./src/models/errors/error409.ts): A duplicate record was found. Status code `409`. *
+  * [`Error400`](./src/models/errors/error400.ts): The request was invalid. Status code `400`.
+  * [`Error401`](./src/models/errors/error401.ts): The request was unauthorized. Status code `401`.
+  * [`Error403`](./src/models/errors/error403.ts): The credentials were invalid or the caller did not have permission to act on the resource. Status code `403`.
+  * [`Error404`](./src/models/errors/error404.ts): The resource was not found. Status code `404`.
+  * [`Error405`](./src/models/errors/error405.ts): The request method was not allowed. Status code `405`.
+  * [`Error409`](./src/models/errors/error409.ts): A duplicate record was found. Status code `409`.
+  * [`Error425`](./src/models/errors/error425.ts): The request was too early. Status code `425`.
+  * [`Error429`](./src/models/errors/error429.ts): Too many requests were made. Status code `429`.
+  * [`Error500`](./src/models/errors/error500.ts): The server encountered an error. Status code `500`.
+  * [`Error502`](./src/models/errors/error502.ts): The server encountered an error. Status code `502`.
+  * [`Error504`](./src/models/errors/error504.ts): The server encountered an error. Status code `504`.
   * [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. *
-  * [`Error425`](./src/models/errors/error425.ts): The request was too early. Status code `425`. *
-  * [`Error429`](./src/models/errors/error429.ts): Too many requests were made. Status code `429`. *
-  * [`Error500`](./src/models/errors/error500.ts): The server encountered an error. Status code `500`. *
-  * [`Error502`](./src/models/errors/error502.ts): The server encountered an error. Status code `502`. *
-  * [`Error504`](./src/models/errors/error504.ts): The server encountered an error. Status code `504`. *
 
 <details><summary>Less common errors (6)</summary>
 
@@ -547,21 +554,25 @@ If the selected server has variables, you may override its default values throug
 #### Example
 
 ```typescript
-import { Gr4vy } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  server: "production",
-  id: "<id>",
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   console.log(result);
 }
@@ -574,20 +585,25 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  serverURL: "https://api.sandbox.example.gr4vy.app",
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   console.log(result);
 }
@@ -659,19 +675,25 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
-  merchantAccountId: "<id>",
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   console.log(result);
 }
@@ -720,19 +742,25 @@ yarn add @gr4vy/sdk zod
 ### Example
 
 ```typescript
-import { Gr4vy } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   console.log(result);
 }
@@ -755,12 +783,13 @@ syntax.
 Here's an example of one such pagination call:
 
 ```typescript
-import { Gr4vy } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
@@ -786,19 +815,25 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet({
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  }, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -820,29 +855,25 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  retryConfig: {
-    strategy: "backoff",
-    backoff: {
-      initialInterval: 1,
-      maxInterval: 50,
-      exponent: 1.1,
-      maxElapsedTime: 100,
-    },
-    retryConnectionErrors: false,
-  },
-  merchantAccountId: "<id>",
-  server: "sandbox",
   id: "example",
+  server: "sandbox",
+  merchantAccountId: "default",
   bearerAuth: withToken({
     privateKey: fs.readFileSync("private_key.pem", "utf8"),
   }),
 });
 
 async function run() {
-  const result = await gr4vy.browsePaymentMethodDefinitionsGet();
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   console.log(result);
 }
@@ -903,7 +934,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 - [`accountUpdaterJobsCreate`](docs/sdks/jobs/README.md#create) - Create account updater job
 - [`auditLogsList`](docs/sdks/auditlogs/README.md#list) - List audit log entries
-- [`browsePaymentMethodDefinitionsGet`](docs/sdks/gr4vy/README.md#browsepaymentmethoddefinitionsget) - Browse
 - [`buyersCreate`](docs/sdks/buyers/README.md#create) - Add a buyer
 - [`buyersDelete`](docs/sdks/buyers/README.md#delete) - Delete a buyer
 - [`buyersGet`](docs/sdks/buyers/README.md#get) - Get a buyer

package/docs/sdks/all/README.md

@@ -15,15 +15,16 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+    id: "example",
+    server: "sandbox",
+    merchantAccountId: "default",
+    bearerAuth: withToken({
+      privateKey: fs.readFileSync("private_key.pem", "utf8"),
+    }),
 });
 
 async function run() {
@@ -41,18 +42,13 @@ 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>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
 });
 
 async function run() {

package/docs/sdks/auditlogs/README.md

@@ -15,15 +15,16 @@ Returns a list of activity by dashboard users.
 
 <!-- UsageSnippet language="typescript" operationID="list_audit_logs" method="get" path="/audit-logs" -->
 ```typescript
-import { Gr4vy } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+    id: "example",
+    server: "sandbox",
+    merchantAccountId: "default",
+    bearerAuth: withToken({
+      privateKey: fs.readFileSync("private_key.pem", "utf8"),
+    }),
 });
 
 async function run() {
@@ -43,18 +44,13 @@ 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>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
 });
 
 async function run() {

package/docs/sdks/balances/README.md

@@ -15,15 +15,16 @@ 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 } from "@gr4vy/sdk";
+import { Gr4vy, withToken } from "@gr4vy/sdk";
+import fs from "fs";
 
 const gr4vy = new Gr4vy({
-  merchantAccountId: "<id>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+    id: "example",
+    server: "sandbox",
+    merchantAccountId: "default",
+    bearerAuth: withToken({
+      privateKey: fs.readFileSync("private_key.pem", "utf8"),
+    }),
 });
 
 async function run() {
@@ -54,18 +55,13 @@ 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>",
-  server: "sandbox",
-  id: "example",
-  bearerAuth: withToken({
-    privateKey: fs.readFileSync("private_key.pem", "utf8"),
-  }),
+  bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
 });
 
 async function run() {