From 6eaf1e2908f53f360601ff8ac8dc4ff1ff34f5c5 Mon Sep 17 00:00:00 2001 From: fern <126544928+fern-bot@users.noreply.github.com> Date: Tue, 16 Jul 2024 21:29:39 -0400 Subject: [PATCH] Update README.md --- README.md | 180 ------------------------------------------------------ 1 file changed, 180 deletions(-) diff --git a/README.md b/README.md index 7702ce7..8b13789 100644 --- a/README.md +++ b/README.md @@ -1,181 +1 @@ -# Crossmint TypeScript Library -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![npm shield](https://img.shields.io/npm/v/crossmint)](https://www.npmjs.com/package/crossmint) - -The Crossmint TypeScript library provides convenient access to the Crossmint API from TypeScript. - -## Installation - -```sh -npm i -s crossmint -``` - -## Usage - -Instantiate and use the client with the following: - -```typescript -import { CrossmintClient, Crossmint } from "crossmint"; - -const client = new CrossmintClient({ apiKey: "YOUR_API_KEY" }); -await client.checkout.createOrder({ - payment: { - method: Crossmint.EvmPaymentMethods.ArbitrumSepolia, - currency: Crossmint.EvmPaymentCurrency.Eth, - }, - lineItems: { - collectionLocator: "crossmint:", - }, -}); -``` - -## Request And Response Types - -The SDK exports all request and response types as TypeScript interfaces. Simply import them with the -following namespace: - -```typescript -import { Crossmint } from "crossmint"; - -const request: Crossmint.CheckoutCreateOrderRequest = { - ... -}; -``` - -## 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 { CrossmintError } from "crossmint"; - -try { - await client.checkout.createOrder(...); -} catch (err) { - if (err instanceof CrossmintError) { - console.log(err.statusCode); - console.log(err.message); - console.log(err.body); - } -} -``` - -## 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.headless.createOrder(..., { - abortSignal: controller.signal -}); -controller.abort(); // aborts the request -``` - -## Runtime Compatibility - -The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following -runtimes: - -- Node.js 18+ -- Vercel -- Cloudflare Workers -- Deno v1.25+ -- Bun 1.0+ -- React Native - -### Customizing Fetch Client - -The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an -unsupported environment, this provides a way for you to break glass and ensure the SDK works. - -```typescript -import { CrossmintClient } from "crossmint"; - -const client = new CrossmintClient({ - ... - fetcher: // provide your implementation here -}); -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [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/500) (Internal Server Errors) - -Use the `maxRetries` request option to configure this behavior. - -```typescript -const response = await client.checkout.createOrder(..., { - 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.checkout.createOrder(..., { - 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.checkout.createOrder(..., { - abortSignal: controller.signal -}); -controller.abort(); // aborts the request -``` - -### Runtime Compatibility - -The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following -runtimes: - -- Node.js 18+ -- Vercel -- Cloudflare Workers -- Deno v1.25+ -- Bun 1.0+ -- React Native - -### Customizing Fetch Client - -The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an -unsupported environment, this provides a way for you to break glass and ensure the SDK works. - -```typescript -import { CrossmintClient } from "crossmint"; - -const client = new CrossmintClient({ - ... - fetcher: // provide your implementation here -}); -``` - -## 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!