# Gr4vy TypeScript SDK

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>
</div>

## Summary

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](#gr4vy-typescript-sdk)
  * [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)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

```bash
npm add @gr4vy/sdk
```

### PNPM

```bash
pnpm add @gr4vy/sdk
```

### Bun

```bash
bun add @gr4vy/sdk
```

### Yarn

```bash
yarn add @gr4vy/sdk
```
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

## SDK Example Usage

### Example

```typescript
import fs from "fs";
import { Gr4vy, withToken } from "@gr4vy/sdk";

async function run() {
    const gr4vy = new Gr4vy({
        server: "sandbox",
        id: "example",
        bearerAuth: withToken({
          privateKey: fs.readFileSync("private_key.pem", "utf8"),
        }),
    });

    const result = await gr4vy.transactions.list({});

    // Handle the result
    console.log(result);
}

run();

```

## Bearer token generation

Alternatively, you can create a token for use with the SDK or with your own client library.

```js
import { getToken } from "@gr4vy/sdk";

async function run() {
    const token = await getToken({
          privateKey: fs.readFileSync("private_key.pem", "utf8"),
    });
    console.log(token);
}

run();
```

> **Note:** This will only create a token once. Use `withToken` to dynamically generate a token
> for every request.


## Embed token generation

Alternatively, you can create a token for use with Embed as follows.

```js
import { Gr4vy, getEmbedToken } from "@gr4vy/sdk";

async function run() {
    const privateKey = fs.readFileSync("private_key.pem", "utf8")

    const gr4vy = new Gr4vy({
        server: "sandbox",
        id: "example",
        bearerAuth: withToken({ privateKey }),
    });

    const checkoutSession = await gr4vy.checkoutSessions.create()

    const token = await getEmbedToken({ 
      privateKey,
      checkoutSessionId: checkoutSession.id,
      embedParams: {
        amount: 1299,
        currency: 'USD',
        buyerExternalIdentifier: 'user-1234',
      }
    });

    console.log(token);
}

run();
```

> **Note:** This will only create a token once. Use `withToken` to dynamically generate a token
> for every request.

### Attaching a checkout session automatically

For Embed, it is recommended to attach a checkout session to every transaction. The
`getEmbedTokenWithCheckoutSession` helper creates a checkout session using your SDK client and
returns an Embed token with the resulting `checkout_session_id` already pinned, in a single call.

```js
import fs from "node:fs";
import { Gr4vy, getEmbedTokenWithCheckoutSession, withToken } from "@gr4vy/sdk";

async function run() {
    const privateKey = fs.readFileSync("private_key.pem", "utf8")

    const gr4vy = new Gr4vy({
        server: "sandbox",
        id: "example",
        bearerAuth: withToken({ privateKey }),
    });

    const token = await getEmbedTokenWithCheckoutSession({
      client: gr4vy,
      privateKey,
      embedParams: {
        amount: 1299,
        currency: 'USD',
        buyerExternalIdentifier: 'user-1234',
      }
    });

    console.log(token);
}

run();
```

You can optionally pass a `checkoutSession` body to seed the session (for example with cart items
or metadata), and a `merchantAccountId` to override the client's configured merchant account.

## Merchant account ID selection

Depending on the key used, you might need to explicitly define a merchant account ID to use. In our API, 
this uses the `X-GR4VY-MERCHANT-ACCOUNT-ID` header. When using the SDK, you can set the `merchantAccountId`
on every request.

```js
const result = await gr4vy.transactions.list({
    merchantAccountId: 'merchant-12345'
})
```

Alternatively, the merchant account ID can also be set when initializing the SDK.

```js
const gr4vy = new Gr4vy({
    server: "sandbox",
    id: "example",
    merchantAccountId: 'merchant-12345',
    bearerAuth: withToken({ privateKey }),
});
```


## Webhooks verification

The SDK provides a `verifyWebhook` method to validate incoming webhook requests from Gr4vy. This ensures that the webhook payload is authentic and has not been tampered with.

```js
import { verifyWebhook } from "@gr4vy/sdk";

const payload = 'your-webhook-payload'
const secret = 'your-webhook-secret'
const signatureHeader = 'signatures-from-header'
const timestampHeader = 'timestamp-from-header'
const timestampTolerance = 300 // optional, in seconds (default: 0)

try {
  verifyWebhook(
    payload,
    secret,
    signatureHeader,
    timestampHeader,
    timestampTolerance
  )
  console.log('Webhook verified successfully!')
} catch (error) {
  console.error('Webhook verification failed:', error.message)
}
```

### Parameters

- **`payload`**: The raw payload string received in the webhook request.
- **`secret`**: The secret used to sign the webhook. This is provided in your Gr4vy dashboard.
- **`signatureHeader`**: The `X-Gr4vy-Signature` header from the webhook request.
- **`timestampHeader`**: The `X-Gr4vy-Timestamp` header from the webhook request.
- **`timestampTolerance`**: _(Optional)_ The maximum allowed difference (in seconds) between the current time and the timestamp in the webhook. Defaults to `0` (no tolerance).


<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [AccountUpdater.Jobs](docs/sdks/jobs/README.md)

* [create](docs/sdks/jobs/README.md#create) - Create account updater job

### [ApiKeyPairs](docs/sdks/apikeypairs/README.md)

* [list](docs/sdks/apikeypairs/README.md#list) - List all API key pairs
* [create](docs/sdks/apikeypairs/README.md#create) - Create an API key pair
* [get](docs/sdks/apikeypairs/README.md#get) - Get an API key pair
* [update](docs/sdks/apikeypairs/README.md#update) - Update an API key pair
* [delete](docs/sdks/apikeypairs/README.md#delete) - Delete an API key pair

### [AuditLogs](docs/sdks/auditlogs/README.md)

* [list](docs/sdks/auditlogs/README.md#list) - List audit log entries

### [Buyers](docs/sdks/buyers/README.md)

* [list](docs/sdks/buyers/README.md#list) - List all buyers
* [create](docs/sdks/buyers/README.md#create) - Add a buyer
* [get](docs/sdks/buyers/README.md#get) - Get a buyer
* [update](docs/sdks/buyers/README.md#update) - Update a buyer
* [delete](docs/sdks/buyers/README.md#delete) - Delete a buyer

#### [Buyers.GiftCards](docs/sdks/gr4vygiftcards/README.md)

* [list](docs/sdks/gr4vygiftcards/README.md#list) - List gift cards for a buyer

#### [Buyers.PaymentMethods](docs/sdks/gr4vypaymentmethods/README.md)

* [list](docs/sdks/gr4vypaymentmethods/README.md#list) - List payment methods for a buyer

#### [Buyers.ShippingDetails](docs/sdks/shippingdetails/README.md)

* [create](docs/sdks/shippingdetails/README.md#create) - Add buyer shipping details
* [list](docs/sdks/shippingdetails/README.md#list) - List a buyer's shipping details
* [get](docs/sdks/shippingdetails/README.md#get) - Get buyer shipping details
* [update](docs/sdks/shippingdetails/README.md#update) - Update a buyer's shipping details
* [delete](docs/sdks/shippingdetails/README.md#delete) - Delete a buyer's shipping details

### [CardSchemeDefinitions](docs/sdks/cardschemedefinitions/README.md)

* [list](docs/sdks/cardschemedefinitions/README.md#list) - List card scheme definitions

### [CheckoutSessions](docs/sdks/checkoutsessions/README.md)

* [create](docs/sdks/checkoutsessions/README.md#create) - Create checkout session
* [update](docs/sdks/checkoutsessions/README.md#update) - Update checkout session
* [get](docs/sdks/checkoutsessions/README.md#get) - Get checkout session
* [delete](docs/sdks/checkoutsessions/README.md#delete) - Delete checkout session

### [DigitalWallets](docs/sdks/digitalwallets/README.md)

* [create](docs/sdks/digitalwallets/README.md#create) - Register digital wallet
* [list](docs/sdks/digitalwallets/README.md#list) - List digital wallets
* [get](docs/sdks/digitalwallets/README.md#get) - Get digital wallet
* [delete](docs/sdks/digitalwallets/README.md#delete) - Delete digital wallet
* [update](docs/sdks/digitalwallets/README.md#update) - Update digital wallet

#### [DigitalWallets.Domains](docs/sdks/domains/README.md)

* [create](docs/sdks/domains/README.md#create) - Register a digital wallet domain
* [delete](docs/sdks/domains/README.md#delete) - Remove a digital wallet domain

#### [DigitalWallets.Sessions](docs/sdks/sessions/README.md)

* [googlePay](docs/sdks/sessions/README.md#googlepay) - Create a Google Pay session
* [applePay](docs/sdks/sessions/README.md#applepay) - Create a Apple Pay session
* [pazeMobileSessionCreate](docs/sdks/sessions/README.md#pazemobilesessioncreate) - Create a Paze mobile session
* [paze](docs/sdks/sessions/README.md#paze) - Create a Paze session
* [pazeMobileSessionReview](docs/sdks/sessions/README.md#pazemobilesessionreview) - Review a Paze session
* [pazeMobileSessionComplete](docs/sdks/sessions/README.md#pazemobilesessioncomplete) - Complete a Paze session
* [clickToPay](docs/sdks/sessions/README.md#clicktopay) - Create a Click to Pay session

### [GiftCards](docs/sdks/giftcards/README.md)

* [get](docs/sdks/giftcards/README.md#get) - Get gift card
* [delete](docs/sdks/giftcards/README.md#delete) - Delete a gift card
* [create](docs/sdks/giftcards/README.md#create) - Create gift card
* [list](docs/sdks/giftcards/README.md#list) - List gift cards

#### [GiftCards.Activations](docs/sdks/activations/README.md)

* [create](docs/sdks/activations/README.md#create) - Activate a gift card

#### [GiftCards.Balances](docs/sdks/balances/README.md)

* [list](docs/sdks/balances/README.md#list) - List gift card balances

#### [GiftCards.Issuances](docs/sdks/issuances/README.md)

* [create](docs/sdks/issuances/README.md#create) - Issue a gift card

### [MerchantAccounts](docs/sdks/merchantaccounts/README.md)

* [list](docs/sdks/merchantaccounts/README.md#list) - List all merchant accounts
* [create](docs/sdks/merchantaccounts/README.md#create) - Create a merchant account
* [get](docs/sdks/merchantaccounts/README.md#get) - Get a merchant account
* [update](docs/sdks/merchantaccounts/README.md#update) - Update a merchant account

#### [MerchantAccounts.ThreeDsConfiguration](docs/sdks/threedsconfiguration/README.md)

* [create](docs/sdks/threedsconfiguration/README.md#create) - Create 3DS configuration for merchant
* [list](docs/sdks/threedsconfiguration/README.md#list) - List 3DS configurations for merchant
* [update](docs/sdks/threedsconfiguration/README.md#update) - Edit 3DS configuration
* [delete](docs/sdks/threedsconfiguration/README.md#delete) - Delete 3DS configuration for a merchant

### [PaymentLinks](docs/sdks/paymentlinks/README.md)

* [create](docs/sdks/paymentlinks/README.md#create) - Add a payment link
* [list](docs/sdks/paymentlinks/README.md#list) - List all payment links
* [expire](docs/sdks/paymentlinks/README.md#expire) - Expire a payment link
* [get](docs/sdks/paymentlinks/README.md#get) - Get payment link

### [PaymentMethods](docs/sdks/paymentmethods/README.md)

* [list](docs/sdks/paymentmethods/README.md#list) - List all payment methods
* [create](docs/sdks/paymentmethods/README.md#create) - Create payment method
* [get](docs/sdks/paymentmethods/README.md#get) - Get payment method
* [update](docs/sdks/paymentmethods/README.md#update) - Update payment method
* [delete](docs/sdks/paymentmethods/README.md#delete) - Delete payment method

#### [PaymentMethods.NetworkTokens](docs/sdks/networktokens/README.md)

* [list](docs/sdks/networktokens/README.md#list) - List network tokens
* [create](docs/sdks/networktokens/README.md#create) - Provision network token
* [suspend](docs/sdks/networktokens/README.md#suspend) - Suspend network token
* [resume](docs/sdks/networktokens/README.md#resume) - Resume network token
* [delete](docs/sdks/networktokens/README.md#delete) - Delete network token

##### [PaymentMethods.NetworkTokens.Cryptogram](docs/sdks/cryptogram/README.md)

* [create](docs/sdks/cryptogram/README.md#create) - Provision network token cryptogram

#### [PaymentMethods.PaymentServiceTokens](docs/sdks/paymentservicetokens/README.md)

* [list](docs/sdks/paymentservicetokens/README.md#list) - List payment service tokens
* [create](docs/sdks/paymentservicetokens/README.md#create) - Create payment service token
* [delete](docs/sdks/paymentservicetokens/README.md#delete) - Delete payment service token

### [PaymentOptions](docs/sdks/paymentoptions/README.md)

* [list](docs/sdks/paymentoptions/README.md#list) - List payment options

### [PaymentServiceDefinitions](docs/sdks/paymentservicedefinitions/README.md)

* [list](docs/sdks/paymentservicedefinitions/README.md#list) - List payment service definitions
* [get](docs/sdks/paymentservicedefinitions/README.md#get) - Get a payment service definition
* [session](docs/sdks/paymentservicedefinitions/README.md#session) - Create a session for a payment service definition

### [PaymentServices](docs/sdks/paymentservices/README.md)

* [list](docs/sdks/paymentservices/README.md#list) - List payment services
* [create](docs/sdks/paymentservices/README.md#create) - Configure a payment service
* [get](docs/sdks/paymentservices/README.md#get) - Get payment service
* [update](docs/sdks/paymentservices/README.md#update) - Update a configured payment service
* [delete](docs/sdks/paymentservices/README.md#delete) - Delete a configured payment service
* [verify](docs/sdks/paymentservices/README.md#verify) - Verify payment service credentials
* [session](docs/sdks/paymentservices/README.md#session) - Create a session for a payment service definition

### [Payouts](docs/sdks/payouts/README.md)

* [list](docs/sdks/payouts/README.md#list) - List payouts created
* [create](docs/sdks/payouts/README.md#create) - Create a payout
* [get](docs/sdks/payouts/README.md#get) - Get a payout

### [Refunds](docs/sdks/refunds/README.md)

* [get](docs/sdks/refunds/README.md#get) - Get refund

### [ReportExecutions](docs/sdks/reportexecutions/README.md)

* [list](docs/sdks/reportexecutions/README.md#list) - List executed reports

### [Reports](docs/sdks/reports/README.md)

* [list](docs/sdks/reports/README.md#list) - List configured reports
* [create](docs/sdks/reports/README.md#create) - Add a report
* [get](docs/sdks/reports/README.md#get) - Get a report
* [put](docs/sdks/reports/README.md#put) - Update a report

#### [Reports.Executions](docs/sdks/executions/README.md)

* [list](docs/sdks/executions/README.md#list) - List executions for report
* [url](docs/sdks/executions/README.md#url) - Create URL for executed report
* [get](docs/sdks/executions/README.md#get) - Get executed report

### [Roles](docs/sdks/roles/README.md)

* [list](docs/sdks/roles/README.md#list) - List all roles

### [ThreeDsScenarios](docs/sdks/threedsscenarios/README.md)

* [create](docs/sdks/threedsscenarios/README.md#create) - Create a 3DS scenario
* [list](docs/sdks/threedsscenarios/README.md#list) - List 3DS scenario
* [update](docs/sdks/threedsscenarios/README.md#update) - Update a 3DS scenario
* [delete](docs/sdks/threedsscenarios/README.md#delete) - Delete a 3DS scenario

### [Transactions](docs/sdks/transactions/README.md)

* [list](docs/sdks/transactions/README.md#list) - List transactions
* [create](docs/sdks/transactions/README.md#create) - Create transaction
* [get](docs/sdks/transactions/README.md#get) - Get transaction
* [update](docs/sdks/transactions/README.md#update) - Manually update a transaction
* [capture](docs/sdks/transactions/README.md#capture) - Capture transaction
* [void](docs/sdks/transactions/README.md#void) - Void transaction
* [cancel](docs/sdks/transactions/README.md#cancel) - Cancel transaction
* [sync](docs/sdks/transactions/README.md#sync) - Sync transaction
* [incrementAuthorization](docs/sdks/transactions/README.md#incrementauthorization) - Increment transaction authorization

#### [Transactions.Actions](docs/sdks/actions/README.md)

* [list](docs/sdks/actions/README.md#list) - List transaction Flow rules

#### [Transactions.Captures](docs/sdks/captures/README.md)

* [list](docs/sdks/captures/README.md#list) - List transaction captures
* [get](docs/sdks/captures/README.md#get) - Get transaction capture

#### [Transactions.Events](docs/sdks/events/README.md)

* [list](docs/sdks/events/README.md#list) - List transaction events

#### [Transactions.RefundSettlements](docs/sdks/refundsettlements/README.md)

* [get](docs/sdks/refundsettlements/README.md#get) - Get transaction refund settlement
* [list](docs/sdks/refundsettlements/README.md#list) - List transaction refund settlements

#### [Transactions.Refunds](docs/sdks/gr4vyrefunds/README.md)

* [list](docs/sdks/gr4vyrefunds/README.md#list) - List transaction refunds
* [create](docs/sdks/gr4vyrefunds/README.md#create) - Create transaction refund
* [get](docs/sdks/gr4vyrefunds/README.md#get) - Get transaction refund

##### [Transactions.Refunds.All](docs/sdks/all/README.md)

* [create](docs/sdks/all/README.md#create) - Create batch transaction refund

#### [Transactions.Settlements](docs/sdks/settlements/README.md)

* [get](docs/sdks/settlements/README.md#get) - Get transaction settlement
* [list](docs/sdks/settlements/README.md#list) - List transaction settlements

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`Gr4vyError`](./src/models/errors/gr4vyerror.ts) is the base class for all HTTP error responses. It has the following properties:

| Property            | Type       | Description                                                                             |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| `error.message`     | `string`   | Error message                                                                           |
| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |

### Example
```typescript
import { Gr4vy, withToken } from "@gr4vy/sdk";
import * as errors from "@gr4vy/sdk/models/errors";
import fs from "fs";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  try {
    const result = await gr4vy.accountUpdater.jobs.create({
      paymentMethodIds: [
        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
        "f29e886e-93cc-4714-b4a3-12b7a718e595",
      ],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.Gr4vyError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      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[]
      }
    }
  }
}

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`.
  * [`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`. *

<details><summary>Less common errors (6)</summary>

<br />

**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.


**Inherit from [`Gr4vyError`](./src/models/errors/gr4vyerror.ts)**:
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.

</details>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Select Server by Name

You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

| Name         | Server                               | Variables | Description |
| ------------ | ------------------------------------ | --------- | ----------- |
| `sandbox`    | `https://api.sandbox.{id}.gr4vy.app` | `id`      |             |
| `production` | `https://api.{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:

| Variable | Parameter    | Default     | Description                            |
| -------- | ------------ | ----------- | -------------------------------------- |
| `id`     | `id: string` | `"example"` | The subdomain for your Gr4vy instance. |

#### Example

```typescript
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create({
    paymentMethodIds: [
      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "f29e886e-93cc-4714-b4a3-12b7a718e595",
    ],
  });

  console.log(result);
}

run();

```

### Override Server URL Per-Client

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";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create({
    paymentMethodIds: [
      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "f29e886e-93cc-4714-b4a3-12b7a718e595",
    ],
  });

  console.log(result);
}

run();

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
client is a thin wrapper around `fetch` and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.

The `HTTPClient` constructor takes an optional `fetcher` argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.

The following example shows how to:
- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors

```typescript
import { Gr4vy } from "@gr4vy/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@gr4vy/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Gr4vy({ httpClient: httpClient });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name         | Type | Scheme      | Environment Variable |
| ------------ | ---- | ----------- | -------------------- |
| `bearerAuth` | http | HTTP Bearer | `GR4VY_BEARER_AUTH`  |

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";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create({
    paymentMethodIds: [
      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "f29e886e-93cc-4714-b4a3-12b7a718e595",
    ],
  });

  console.log(result);
}

run();

```
<!-- End Authentication [security] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

```bash
npm add @gr4vy/sdk
```

### PNPM

```bash
pnpm add @gr4vy/sdk
```

### Bun

```bash
bun add @gr4vy/sdk
```

### Yarn

```bash
yarn add @gr4vy/sdk
```
<!-- End SDK Installation [installation] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create({
    paymentMethodIds: [
      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "f29e886e-93cc-4714-b4a3-12b7a718e595",
    ],
  });

  console.log(result);
}

run();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Pagination [pagination] -->
## Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the [`for await...of`][for-await-of]
syntax.

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

```typescript
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.apiKeyPairs.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

```
<!-- End Pagination [pagination] -->

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

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";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create(
    {
      paymentMethodIds: [
        "ef9496d8-53a5-4aad-8ca2-00eb68334389",
        "f29e886e-93cc-4714-b4a3-12b7a718e595",
      ],
    },
    undefined,
    {
      retries: {
        strategy: "backoff",
        backoff: {
          initialInterval: 1,
          maxInterval: 50,
          exponent: 1.1,
          maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
      },
    },
  );

  console.log(result);
}

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";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  merchantAccountId: "default",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.accountUpdater.jobs.create({
    paymentMethodIds: [
      "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "f29e886e-93cc-4714-b4a3-12b7a718e595",
    ],
  });

  console.log(result);
}

run();

```
<!-- End Retries [retries] -->

<!-- Start Summary [summary] -->
## Summary

Gr4vy: The Gr4vy API.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [Gr4vy TypeScript SDK](#gr4vy-typescript-sdk)
  * [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)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start Standalone functions [standalone-funcs] -->
## Standalone functions

All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).

<details>

<summary>Available standalone functions</summary>

- [`accountUpdaterJobsCreate`](docs/sdks/jobs/README.md#create) - Create account updater job
- [`apiKeyPairsCreate`](docs/sdks/apikeypairs/README.md#create) - Create an API key pair
- [`apiKeyPairsDelete`](docs/sdks/apikeypairs/README.md#delete) - Delete an API key pair
- [`apiKeyPairsGet`](docs/sdks/apikeypairs/README.md#get) - Get an API key pair
- [`apiKeyPairsList`](docs/sdks/apikeypairs/README.md#list) - List all API key pairs
- [`apiKeyPairsUpdate`](docs/sdks/apikeypairs/README.md#update) - Update an API key pair
- [`auditLogsList`](docs/sdks/auditlogs/README.md#list) - List audit log entries
- [`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
- [`buyersGiftCardsList`](docs/sdks/gr4vygiftcards/README.md#list) - List gift cards for a buyer
- [`buyersList`](docs/sdks/buyers/README.md#list) - List all buyers
- [`buyersPaymentMethodsList`](docs/sdks/gr4vypaymentmethods/README.md#list) - List payment methods for a buyer
- [`buyersShippingDetailsCreate`](docs/sdks/shippingdetails/README.md#create) - Add buyer shipping details
- [`buyersShippingDetailsDelete`](docs/sdks/shippingdetails/README.md#delete) - Delete a buyer's shipping details
- [`buyersShippingDetailsGet`](docs/sdks/shippingdetails/README.md#get) - Get buyer shipping details
- [`buyersShippingDetailsList`](docs/sdks/shippingdetails/README.md#list) - List a buyer's shipping details
- [`buyersShippingDetailsUpdate`](docs/sdks/shippingdetails/README.md#update) - Update a buyer's shipping details
- [`buyersUpdate`](docs/sdks/buyers/README.md#update) - Update a buyer
- [`cardSchemeDefinitionsList`](docs/sdks/cardschemedefinitions/README.md#list) - List card scheme definitions
- [`checkoutSessionsCreate`](docs/sdks/checkoutsessions/README.md#create) - Create checkout session
- [`checkoutSessionsDelete`](docs/sdks/checkoutsessions/README.md#delete) - Delete checkout session
- [`checkoutSessionsGet`](docs/sdks/checkoutsessions/README.md#get) - Get checkout session
- [`checkoutSessionsUpdate`](docs/sdks/checkoutsessions/README.md#update) - Update checkout session
- [`digitalWalletsCreate`](docs/sdks/digitalwallets/README.md#create) - Register digital wallet
- [`digitalWalletsDelete`](docs/sdks/digitalwallets/README.md#delete) - Delete digital wallet
- [`digitalWalletsDomainsCreate`](docs/sdks/domains/README.md#create) - Register a digital wallet domain
- [`digitalWalletsDomainsDelete`](docs/sdks/domains/README.md#delete) - Remove a digital wallet domain
- [`digitalWalletsGet`](docs/sdks/digitalwallets/README.md#get) - Get digital wallet
- [`digitalWalletsList`](docs/sdks/digitalwallets/README.md#list) - List digital wallets
- [`digitalWalletsSessionsApplePay`](docs/sdks/sessions/README.md#applepay) - Create a Apple Pay session
- [`digitalWalletsSessionsClickToPay`](docs/sdks/sessions/README.md#clicktopay) - Create a Click to Pay session
- [`digitalWalletsSessionsGooglePay`](docs/sdks/sessions/README.md#googlepay) - Create a Google Pay session
- [`digitalWalletsSessionsPaze`](docs/sdks/sessions/README.md#paze) - Create a Paze session
- [`digitalWalletsSessionsPazeMobileSessionComplete`](docs/sdks/sessions/README.md#pazemobilesessioncomplete) - Complete a Paze session
- [`digitalWalletsSessionsPazeMobileSessionCreate`](docs/sdks/sessions/README.md#pazemobilesessioncreate) - Create a Paze mobile session
- [`digitalWalletsSessionsPazeMobileSessionReview`](docs/sdks/sessions/README.md#pazemobilesessionreview) - Review a Paze session
- [`digitalWalletsUpdate`](docs/sdks/digitalwallets/README.md#update) - Update digital wallet
- [`giftCardsActivationsCreate`](docs/sdks/activations/README.md#create) - Activate a gift card
- [`giftCardsBalancesList`](docs/sdks/balances/README.md#list) - List gift card balances
- [`giftCardsCreate`](docs/sdks/giftcards/README.md#create) - Create gift card
- [`giftCardsDelete`](docs/sdks/giftcards/README.md#delete) - Delete a gift card
- [`giftCardsGet`](docs/sdks/giftcards/README.md#get) - Get gift card
- [`giftCardsIssuancesCreate`](docs/sdks/issuances/README.md#create) - Issue a gift card
- [`giftCardsList`](docs/sdks/giftcards/README.md#list) - List gift cards
- [`merchantAccountsCreate`](docs/sdks/merchantaccounts/README.md#create) - Create a merchant account
- [`merchantAccountsGet`](docs/sdks/merchantaccounts/README.md#get) - Get a merchant account
- [`merchantAccountsList`](docs/sdks/merchantaccounts/README.md#list) - List all merchant accounts
- [`merchantAccountsThreeDsConfigurationCreate`](docs/sdks/threedsconfiguration/README.md#create) - Create 3DS configuration for merchant
- [`merchantAccountsThreeDsConfigurationDelete`](docs/sdks/threedsconfiguration/README.md#delete) - Delete 3DS configuration for a merchant
- [`merchantAccountsThreeDsConfigurationList`](docs/sdks/threedsconfiguration/README.md#list) - List 3DS configurations for merchant
- [`merchantAccountsThreeDsConfigurationUpdate`](docs/sdks/threedsconfiguration/README.md#update) - Edit 3DS configuration
- [`merchantAccountsUpdate`](docs/sdks/merchantaccounts/README.md#update) - Update a merchant account
- [`paymentLinksCreate`](docs/sdks/paymentlinks/README.md#create) - Add a payment link
- [`paymentLinksExpire`](docs/sdks/paymentlinks/README.md#expire) - Expire a payment link
- [`paymentLinksGet`](docs/sdks/paymentlinks/README.md#get) - Get payment link
- [`paymentLinksList`](docs/sdks/paymentlinks/README.md#list) - List all payment links
- [`paymentMethodsCreate`](docs/sdks/paymentmethods/README.md#create) - Create payment method
- [`paymentMethodsDelete`](docs/sdks/paymentmethods/README.md#delete) - Delete payment method
- [`paymentMethodsGet`](docs/sdks/paymentmethods/README.md#get) - Get payment method
- [`paymentMethodsList`](docs/sdks/paymentmethods/README.md#list) - List all payment methods
- [`paymentMethodsNetworkTokensCreate`](docs/sdks/networktokens/README.md#create) - Provision network token
- [`paymentMethodsNetworkTokensCryptogramCreate`](docs/sdks/cryptogram/README.md#create) - Provision network token cryptogram
- [`paymentMethodsNetworkTokensDelete`](docs/sdks/networktokens/README.md#delete) - Delete network token
- [`paymentMethodsNetworkTokensList`](docs/sdks/networktokens/README.md#list) - List network tokens
- [`paymentMethodsNetworkTokensResume`](docs/sdks/networktokens/README.md#resume) - Resume network token
- [`paymentMethodsNetworkTokensSuspend`](docs/sdks/networktokens/README.md#suspend) - Suspend network token
- [`paymentMethodsPaymentServiceTokensCreate`](docs/sdks/paymentservicetokens/README.md#create) - Create payment service token
- [`paymentMethodsPaymentServiceTokensDelete`](docs/sdks/paymentservicetokens/README.md#delete) - Delete payment service token
- [`paymentMethodsPaymentServiceTokensList`](docs/sdks/paymentservicetokens/README.md#list) - List payment service tokens
- [`paymentMethodsUpdate`](docs/sdks/paymentmethods/README.md#update) - Update payment method
- [`paymentOptionsList`](docs/sdks/paymentoptions/README.md#list) - List payment options
- [`paymentServiceDefinitionsGet`](docs/sdks/paymentservicedefinitions/README.md#get) - Get a payment service definition
- [`paymentServiceDefinitionsList`](docs/sdks/paymentservicedefinitions/README.md#list) - List payment service definitions
- [`paymentServiceDefinitionsSession`](docs/sdks/paymentservicedefinitions/README.md#session) - Create a session for a payment service definition
- [`paymentServicesCreate`](docs/sdks/paymentservices/README.md#create) - Configure a payment service
- [`paymentServicesDelete`](docs/sdks/paymentservices/README.md#delete) - Delete a configured payment service
- [`paymentServicesGet`](docs/sdks/paymentservices/README.md#get) - Get payment service
- [`paymentServicesList`](docs/sdks/paymentservices/README.md#list) - List payment services
- [`paymentServicesSession`](docs/sdks/paymentservices/README.md#session) - Create a session for a payment service definition
- [`paymentServicesUpdate`](docs/sdks/paymentservices/README.md#update) - Update a configured payment service
- [`paymentServicesVerify`](docs/sdks/paymentservices/README.md#verify) - Verify payment service credentials
- [`payoutsCreate`](docs/sdks/payouts/README.md#create) - Create a payout
- [`payoutsGet`](docs/sdks/payouts/README.md#get) - Get a payout
- [`payoutsList`](docs/sdks/payouts/README.md#list) - List payouts created
- [`refundsGet`](docs/sdks/refunds/README.md#get) - Get refund
- [`reportExecutionsList`](docs/sdks/reportexecutions/README.md#list) - List executed reports
- [`reportsCreate`](docs/sdks/reports/README.md#create) - Add a report
- [`reportsExecutionsGet`](docs/sdks/executions/README.md#get) - Get executed report
- [`reportsExecutionsList`](docs/sdks/executions/README.md#list) - List executions for report
- [`reportsExecutionsUrl`](docs/sdks/executions/README.md#url) - Create URL for executed report
- [`reportsGet`](docs/sdks/reports/README.md#get) - Get a report
- [`reportsList`](docs/sdks/reports/README.md#list) - List configured reports
- [`reportsPut`](docs/sdks/reports/README.md#put) - Update a report
- [`rolesList`](docs/sdks/roles/README.md#list) - List all roles
- [`threeDsScenariosCreate`](docs/sdks/threedsscenarios/README.md#create) - Create a 3DS scenario
- [`threeDsScenariosDelete`](docs/sdks/threedsscenarios/README.md#delete) - Delete a 3DS scenario
- [`threeDsScenariosList`](docs/sdks/threedsscenarios/README.md#list) - List 3DS scenario
- [`threeDsScenariosUpdate`](docs/sdks/threedsscenarios/README.md#update) - Update a 3DS scenario
- [`transactionsActionsList`](docs/sdks/actions/README.md#list) - List transaction Flow rules
- [`transactionsCancel`](docs/sdks/transactions/README.md#cancel) - Cancel transaction
- [`transactionsCapture`](docs/sdks/transactions/README.md#capture) - Capture transaction
- [`transactionsCapturesGet`](docs/sdks/captures/README.md#get) - Get transaction capture
- [`transactionsCapturesList`](docs/sdks/captures/README.md#list) - List transaction captures
- [`transactionsCreate`](docs/sdks/transactions/README.md#create) - Create transaction
- [`transactionsEventsList`](docs/sdks/events/README.md#list) - List transaction events
- [`transactionsGet`](docs/sdks/transactions/README.md#get) - Get transaction
- [`transactionsIncrementAuthorization`](docs/sdks/transactions/README.md#incrementauthorization) - Increment transaction authorization
- [`transactionsList`](docs/sdks/transactions/README.md#list) - List transactions
- [`transactionsRefundsAllCreate`](docs/sdks/all/README.md#create) - Create batch transaction refund
- [`transactionsRefundsCreate`](docs/sdks/gr4vyrefunds/README.md#create) - Create transaction refund
- [`transactionsRefundSettlementsGet`](docs/sdks/refundsettlements/README.md#get) - Get transaction refund settlement
- [`transactionsRefundSettlementsList`](docs/sdks/refundsettlements/README.md#list) - List transaction refund settlements
- [`transactionsRefundsGet`](docs/sdks/gr4vyrefunds/README.md#get) - Get transaction refund
- [`transactionsRefundsList`](docs/sdks/gr4vyrefunds/README.md#list) - List transaction refunds
- [`transactionsSettlementsGet`](docs/sdks/settlements/README.md#get) - Get transaction settlement
- [`transactionsSettlementsList`](docs/sdks/settlements/README.md#list) - List transaction settlements
- [`transactionsSync`](docs/sdks/transactions/README.md#sync) - Sync transaction
- [`transactionsUpdate`](docs/sdks/transactions/README.md#update) - Manually update a transaction
- [`transactionsVoid`](docs/sdks/transactions/README.md#void) - Void transaction

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches `console`'s interface as an SDK option.

> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

```typescript
import { Gr4vy } from "@gr4vy/sdk";

const sdk = new Gr4vy({ debugLogger: console });
```

You can also enable a default debug logger by setting an environment variable `GR4VY_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# Development

## Testing

The SDK has an end-to-end test suite that runs against the E2E sandbox. Place
the `private_key.pem` for the test environment in the repo root (or export
`PRIVATE_KEY`), then:

```sh
npm install
npx vitest run
```

See **[TESTING.md](TESTING.md)** for the full guide — suite layout, parallelism
and CI sharding, property-based tests, coverage / endpoint-reach reporting, and
how testing ties into the release pipeline.

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)