@gr4vy/sdk 0.18.19 → 1.0.0-beta.10

package/FUNCTIONS.md

@@ -40,7 +40,7 @@ async function run() {
       "ef9496d8-53a5-4aad-8ca2-00eb68334389",
       "f29e886e-93cc-4714-b4a3-12b7a718e595",
     ],
-  }, 1, "default");
+  });
 
   switch (true) {
     case res.ok:

package/README.md

@@ -1,12 +1,57 @@
 # Gr4vy Typescript SDK (Beta)
 
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage the **Gr4vy** API.
+
+
 <div align="left">
+    <a href="https://www.npmjs.com/package/@gr4vy/sdk"><img alt="NPM Version" src="https://img.shields.io/npm/v/%40gr4vy%2Fsdk?style=for-the-badge" /></a>
     <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
-    <a href="https://opensource.org/licenses/MIT">
-        <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge&labelColor=black" style="width: 100px; height: 28px;" />
-    </a>
 </div>
 
+## Summary
+
+Gr4vy Typescript SDK
+
+The official Gr4vy SDK for Typescript provides a convenient way to interact with the Gr4vy API from your server-side application. This SDK allows you to seamlessly integrate Gr4vy's powerful payment orchestration capabilities, including:
+
+* Creating Transactions: Initiate and process payments with various payment methods and services.
+* Managing Buyers: Store and manage buyer information securely.
+* Storing Payment Methods: Securely store and tokenize payment methods for future use.
+* Handling Webhooks: Easily process and respond to webhook events from Gr4vy.
+* And much more: Access the full suite of Gr4vy API payment features.
+
+This SDK is designed to simplify development, reduce boilerplate code, and help you get up and running with Gr4vy quickly and efficiently. It handles authentication, request signing, and provides easy-to-use methods for most API endpoints.
+
+<!-- No Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Gr4vy Typescript SDK (Beta)](#gr4vy-typescript-sdk-beta)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Bearer token generation](#bearer-token-generation)
+  * [Embed token generation](#embed-token-generation)
+  * [Merchant account ID selection](#merchant-account-id-selection)
+  * [Webhooks verification](#webhooks-verification)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [SDK Installation](#sdk-installation-1)
+  * [SDK Example Usage](#sdk-example-usage-1)
+  * [Pagination](#pagination)
+  * [Retries](#retries)
+  * [Standalone functions](#standalone-functions)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Testing](#testing)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
 
 ## SDK Installation
 
@@ -45,7 +90,7 @@ async function run() {
         }),
     });
 
-    const result = await gr4vy.transactions.listTransactions({});
+    const result = await gr4vy.transactions.list({});
 
     // Handle the result
     console.log(result);
@@ -351,8 +396,6 @@ Some methods specify known errors which can be thrown. All the known errors are
 | errors.Error400            | 400         | application/json |
 | errors.Error401            | 401         | application/json |
 | errors.Error403            | 403         | application/json |
-| errors.Error403Forbidden   | 403         | application/json |
-| errors.Error403Active      | 403         | application/json |
 | errors.Error404            | 404         | application/json |
 | errors.Error405            | 405         | application/json |
 | errors.Error409            | 409         | application/json |
@@ -372,8 +415,6 @@ import {
   Error400,
   Error401,
   Error403,
-  Error403Active,
-  Error403Forbidden,
   Error404,
   Error405,
   Error409,
@@ -397,16 +438,12 @@ const gr4vy = new Gr4vy({
 async function run() {
   let result;
   try {
-    result = await gr4vy.accountUpdater.jobs.create(
-      {
-        paymentMethodIds: [
-          "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-          "f29e886e-93cc-4714-b4a3-12b7a718e595",
-        ],
-      },
-      1,
-      "default",
-    );
+    result = await gr4vy.accountUpdater.jobs.create({
+      paymentMethodIds: [
+        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+        "f29e886e-93cc-4714-b4a3-12b7a718e595",
+      ],
+    });
 
     // Handle the result
     console.log(result);
@@ -432,14 +469,7 @@ async function run() {
       }
       case (err instanceof Error403): {
         // Handle err.data$: Error403Data
-        return;
-      }
-      case (err instanceof Error403Forbidden): {
-        // Handle err.data$: Error403ForbiddenData
-        return;
-      }
-      case (err instanceof Error403Active): {
-        // Handle err.data$: Error403ActiveData
+        console.error(err);
         return;
       }
       case (err instanceof Error404): {
@@ -521,7 +551,7 @@ You can override the default server globally by passing a server name to the `se
 
 | Name         | Server                               | Variables | Description |
 | ------------ | ------------------------------------ | --------- | ----------- |
-| `production` | `https://api.example.gr4vy.app`      | `id`      |             |
+| `production` | `https://api.{id}.gr4vy.app`         | `id`      |             |
 | `sandbox`    | `https://api.sandbox.{id}.gr4vy.app` | `id`      |             |
 
 If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
@@ -546,16 +576,12 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-  );
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -581,16 +607,12 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-  );
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -674,16 +696,12 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-  );
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -831,16 +849,12 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-  );
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -910,28 +924,23 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-    {
-      retries: {
-        strategy: "backoff",
-        backoff: {
-          initialInterval: 1,
-          maxInterval: 50,
-          exponent: 1.1,
-          maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
       },
+      retryConnectionErrors: false,
     },
-  );
+  });
 
   // Handle the result
   console.log(result);
@@ -964,16 +973,12 @@ const gr4vy = new Gr4vy({
 });
 
 async function run() {
-  const result = await gr4vy.accountUpdater.jobs.create(
-    {
-      paymentMethodIds: [
-        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
-        "f29e886e-93cc-4714-b4a3-12b7a718e595",
-      ],
-    },
-    1,
-    "default",
-  );
+  const result = await gr4vy.accountUpdater.jobs.create({
+    paymentMethodIds: [
+      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
+      "f29e886e-93cc-4714-b4a3-12b7a718e595",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -1140,7 +1145,7 @@ You can also enable a default debug logger by setting an environment variable `G
 
 ## Testing
 
-To run the tests, install NPM and run the following.
+To run the tests, install NPM, ensure to download the `private_key.pem` for the test environment, and run the following.
 
 ```sh
 npm install