pkg-sdk-test 0.0.14 → 0.0.15

package/README.md

@@ -0,0 +1,295 @@
+# Suward TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fcrylabsorg%2Fsuward-sdk-ts)
+[![npm shield](https://img.shields.io/npm/v/pkg-sdk-test)](https://www.npmjs.com/package/pkg-sdk-test)
+
+The Suward TypeScript library provides convenient access to the Suward APIs from TypeScript.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Request and Response Types](#request-and-response-types)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Subpackage Exports](#subpackage-exports)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query String Parameters](#additional-query-string-parameters)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Aborting Requests](#aborting-requests)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Logging](#logging)
+  - [Custom Fetch](#custom-fetch)
+  - [Runtime Compatibility](#runtime-compatibility)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+npm i -s pkg-sdk-test
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/crylabsorg/suward-sdk-ts/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { SuwardSDKClient } from "pkg-sdk-test";
+
+const client = new SuwardSDKClient({ environment: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
+await client.payments.createPayment();
+```
+
+## Request and Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { SuwardSDK } from "pkg-sdk-test";
+
+const request: SuwardSDK.GetV1PaymentsRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { SuwardSDKError } from "pkg-sdk-test";
+
+try {
+    await client.payments.createPayment(...);
+} catch (err) {
+    if (err instanceof SuwardSDKError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+        console.log(err.rawResponse);
+    }
+}
+```
+
+## Advanced
+
+### Subpackage Exports
+
+This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.
+
+```typescript
+import { PaymentsClient } from 'pkg-sdk-test/payments';
+
+const client = new PaymentsClient({...});
+```
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+import { SuwardSDKClient } from "pkg-sdk-test";
+
+const client = new SuwardSDKClient({
+    ...
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+
+const response = await client.payments.createPayment(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.payments.createPayment(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.payments.createPayment(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.payments.createPayment(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.payments.createPayment(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.payments.createPayment(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### Logging
+
+The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
+
+```typescript
+import { SuwardSDKClient, logging } from "pkg-sdk-test";
+
+const client = new SuwardSDKClient({
+    ...
+    logging: {
+        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
+        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
+        silent: false, // defaults to true, set to false to enable logging
+    }
+});
+```
+The `logging` object can have the following properties:
+- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
+- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
+- `silent`: Whether to silence the logger. Defaults to `true`.
+
+The `level` property can be one of the following values:
+- `logging.LogLevel.Debug`
+- `logging.LogLevel.Info`
+- `logging.LogLevel.Warn`
+- `logging.LogLevel.Error`
+
+To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
+
+<details>
+<summary>Custom logger examples</summary>
+
+Here's an example using the popular `winston` logging library.
+```ts
+import winston from 'winston';
+
+const winstonLogger = winston.createLogger({...});
+
+const logger: logging.ILogger = {
+    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
+    info: (msg, ...args) => winstonLogger.info(msg, ...args),
+    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
+    error: (msg, ...args) => winstonLogger.error(msg, ...args),
+};
+```
+
+Here's an example using the popular `pino` logging library.
+
+```ts
+import pino from 'pino';
+
+const pinoLogger = pino({...});
+
+const logger: logging.ILogger = {
+  debug: (msg, ...args) => pinoLogger.debug(args, msg),
+  info: (msg, ...args) => pinoLogger.info(args, msg),
+  warn: (msg, ...args) => pinoLogger.warn(args, msg),
+  error: (msg, ...args) => pinoLogger.error(args, msg),
+};
+```
+</details>
+
+
+### Custom Fetch
+
+The SDK provides a low-level `fetch` method for making custom HTTP requests while still
+benefiting from SDK-level configuration like authentication, retries, timeouts, and logging.
+This is useful for calling API endpoints not yet supported in the SDK.
+
+```typescript
+const response = await client.fetch("/v1/custom/endpoint", {
+    method: "GET",
+}, {
+    timeoutInSeconds: 30,
+    maxRetries: 3,
+    headers: {
+        "X-Custom-Header": "custom-value",
+    },
+});
+
+const data = await response.json();
+```
+
+### Runtime Compatibility
+
+
+The SDK works in the following runtimes:
+
+
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/dist/cjs/BaseClient.js

@@ -42,9 +42,9 @@ const core = __importStar(require("./core/index.js"));
 function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
-        "X-Fern-SDK-Name": "@suward/sdk",
-        "X-Fern-SDK-Version": "0.0.14",
-        "User-Agent": "@suward/sdk/0.0.14",
+        "X-Fern-SDK-Name": "pkg-sdk-test",
+        "X-Fern-SDK-Version": "0.0.15",
+        "User-Agent": "pkg-sdk-test/0.0.15",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/Client.d.ts

@@ -3,16 +3,16 @@ import { StaticWalletsClient } from "./api/resources/staticWallets/client/Client
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
 import * as core from "./core/index.js";
-export declare namespace SuwardApiClient {
+export declare namespace SuwardSDKClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class SuwardApiClient {
-    protected readonly _options: NormalizedClientOptionsWithAuth<SuwardApiClient.Options>;
+export declare class SuwardSDKClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SuwardSDKClient.Options>;
     protected _payments: PaymentsClient | undefined;
     protected _staticWallets: StaticWalletsClient | undefined;
-    constructor(options: SuwardApiClient.Options);
+    constructor(options: SuwardSDKClient.Options);
     get payments(): PaymentsClient;
     get staticWallets(): StaticWalletsClient;
     /**

package/dist/cjs/Client.js

@@ -43,12 +43,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SuwardApiClient = void 0;
+exports.SuwardSDKClient = void 0;
 const Client_js_1 = require("./api/resources/payments/client/Client.js");
 const Client_js_2 = require("./api/resources/staticWallets/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
-class SuwardApiClient {
+class SuwardSDKClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
@@ -85,4 +85,4 @@ class SuwardApiClient {
         });
     }
 }
-exports.SuwardApiClient = SuwardApiClient;
+exports.SuwardSDKClient = SuwardSDKClient;

package/dist/cjs/api/errors/BadRequestError.d.ts

@@ -1,6 +1,6 @@
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as SuwardApi from "../index.js";
-export declare class BadRequestError extends errors.SuwardApiError {
-    constructor(body: SuwardApi.ControllerErrorResponse, rawResponse?: core.RawResponse);
+import type * as SuwardSDK from "../index.js";
+export declare class BadRequestError extends errors.SuwardSDKError {
+    constructor(body: SuwardSDK.ControllerErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/cjs/api/errors/BadRequestError.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const errors = __importStar(require("../../errors/index.js"));
-class BadRequestError extends errors.SuwardApiError {
+class BadRequestError extends errors.SuwardSDKError {
     constructor(body, rawResponse) {
         super({
             message: "BadRequestError",

package/dist/cjs/api/errors/InternalServerError.d.ts

@@ -1,6 +1,6 @@
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as SuwardApi from "../index.js";
-export declare class InternalServerError extends errors.SuwardApiError {
-    constructor(body: SuwardApi.ControllerErrorResponse, rawResponse?: core.RawResponse);
+import type * as SuwardSDK from "../index.js";
+export declare class InternalServerError extends errors.SuwardSDKError {
+    constructor(body: SuwardSDK.ControllerErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/cjs/api/errors/InternalServerError.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
 const errors = __importStar(require("../../errors/index.js"));
-class InternalServerError extends errors.SuwardApiError {
+class InternalServerError extends errors.SuwardSDKError {
     constructor(body, rawResponse) {
         super({
             message: "InternalServerError",

package/dist/cjs/api/errors/NotFoundError.d.ts

@@ -1,6 +1,6 @@
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as SuwardApi from "../index.js";
-export declare class NotFoundError extends errors.SuwardApiError {
-    constructor(body: SuwardApi.ControllerErrorResponse, rawResponse?: core.RawResponse);
+import type * as SuwardSDK from "../index.js";
+export declare class NotFoundError extends errors.SuwardSDKError {
+    constructor(body: SuwardSDK.ControllerErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/cjs/api/errors/NotFoundError.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
 const errors = __importStar(require("../../errors/index.js"));
-class NotFoundError extends errors.SuwardApiError {
+class NotFoundError extends errors.SuwardSDKError {
     constructor(body, rawResponse) {
         super({
             message: "NotFoundError",

package/dist/cjs/api/errors/UnauthorizedError.d.ts

@@ -1,6 +1,6 @@
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as SuwardApi from "../index.js";
-export declare class UnauthorizedError extends errors.SuwardApiError {
-    constructor(body: SuwardApi.ControllerErrorResponse, rawResponse?: core.RawResponse);
+import type * as SuwardSDK from "../index.js";
+export declare class UnauthorizedError extends errors.SuwardSDKError {
+    constructor(body: SuwardSDK.ControllerErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/cjs/api/errors/UnauthorizedError.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
 const errors = __importStar(require("../../errors/index.js"));
-class UnauthorizedError extends errors.SuwardApiError {
+class UnauthorizedError extends errors.SuwardSDKError {
     constructor(body, rawResponse) {
         super({
             message: "UnauthorizedError",

package/dist/cjs/api/resources/payments/client/Client.d.ts

@@ -1,7 +1,7 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
-import * as SuwardApi from "../../../index.js";
+import * as SuwardSDK from "../../../index.js";
 export declare namespace PaymentsClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -13,80 +13,80 @@ export declare class PaymentsClient {
     /**
      * List payments for a project
      *
-     * @param {SuwardApi.GetV1PaymentsRequest} request
+     * @param {SuwardSDK.GetV1PaymentsRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link SuwardApi.BadRequestError}
-     * @throws {@link SuwardApi.UnauthorizedError}
-     * @throws {@link SuwardApi.InternalServerError}
+     * @throws {@link SuwardSDK.BadRequestError}
+     * @throws {@link SuwardSDK.UnauthorizedError}
+     * @throws {@link SuwardSDK.InternalServerError}
      *
      * @example
      *     await client.payments.listPayments()
      */
-    listPayments(request?: SuwardApi.GetV1PaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardApi.CryptopayListPaymentsResponse>;
+    listPayments(request?: SuwardSDK.GetV1PaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardSDK.CryptopayListPaymentsResponse>;
     private __listPayments;
     /**
      * Create a new payment
      *
-     * @param {SuwardApi.CryptopayCreatePaymentRequest} request
+     * @param {SuwardSDK.CryptopayCreatePaymentRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link SuwardApi.BadRequestError}
-     * @throws {@link SuwardApi.UnauthorizedError}
-     * @throws {@link SuwardApi.InternalServerError}
+     * @throws {@link SuwardSDK.BadRequestError}
+     * @throws {@link SuwardSDK.UnauthorizedError}
+     * @throws {@link SuwardSDK.InternalServerError}
      *
      * @example
      *     await client.payments.createPayment()
      */
-    createPayment(request?: SuwardApi.CryptopayCreatePaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardApi.CryptopayPaymentResponse>;
+    createPayment(request?: SuwardSDK.CryptopayCreatePaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardSDK.CryptopayPaymentResponse>;
     private __createPayment;
     /**
      * Returns full payment details when called with an API key (merchant view).
      * Returns limited payment details when called without an API key (customer view).
      *
-     * @param {SuwardApi.GetV1PaymentsPaymentIdRequest} request
+     * @param {SuwardSDK.GetV1PaymentsPaymentIdRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link SuwardApi.InternalServerError}
+     * @throws {@link SuwardSDK.InternalServerError}
      *
      * @example
      *     await client.payments.getPayment({
      *         paymentId: "paymentId"
      *     })
      */
-    getPayment(request: SuwardApi.GetV1PaymentsPaymentIdRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardApi.GetV1PaymentsPaymentIdResponse>;
+    getPayment(request: SuwardSDK.GetV1PaymentsPaymentIdRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardSDK.GetV1PaymentsPaymentIdResponse>;
     private __getPayment;
     /**
      * Cancel a payment
      *
-     * @param {SuwardApi.PostV1PaymentsPaymentIdCancelRequest} request
+     * @param {SuwardSDK.PostV1PaymentsPaymentIdCancelRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link SuwardApi.UnauthorizedError}
-     * @throws {@link SuwardApi.InternalServerError}
+     * @throws {@link SuwardSDK.UnauthorizedError}
+     * @throws {@link SuwardSDK.InternalServerError}
      *
      * @example
      *     await client.payments.cancelPayment({
      *         paymentId: "paymentId"
      *     })
      */
-    cancelPayment(request: SuwardApi.PostV1PaymentsPaymentIdCancelRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardApi.CryptopayPaymentResponse>;
+    cancelPayment(request: SuwardSDK.PostV1PaymentsPaymentIdCancelRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardSDK.CryptopayPaymentResponse>;
     private __cancelPayment;
     /**
      * Simulate payment status change (test mode only)
      *
-     * @param {SuwardApi.CryptopaySimulatePaymentRequest} request
+     * @param {SuwardSDK.CryptopaySimulatePaymentRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link SuwardApi.BadRequestError}
-     * @throws {@link SuwardApi.UnauthorizedError}
-     * @throws {@link SuwardApi.InternalServerError}
+     * @throws {@link SuwardSDK.BadRequestError}
+     * @throws {@link SuwardSDK.UnauthorizedError}
+     * @throws {@link SuwardSDK.InternalServerError}
      *
      * @example
      *     await client.payments.simulatePayment({
      *         paymentId: "paymentId"
      *     })
      */
-    simulatePayment(request: SuwardApi.CryptopaySimulatePaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardApi.CryptopayPaymentResponse>;
+    simulatePayment(request: SuwardSDK.CryptopaySimulatePaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<SuwardSDK.CryptopayPaymentResponse>;
     private __simulatePayment;
 }