@flintpay/node 0.2.0-beta.1 → 0.2.0-beta.2

package/README.md

@@ -1,43 +1,122 @@
 # Flint Public API SDK (node)
 
-Package 0.2.0-beta.1; generated for API 2026-09-07.
+Package 0.2.0-beta.2; generated for API 2026-09-07.
 
-Requires Node.js 22+; TypeScript 5.9+. ESM JavaScript and declarations ship together.
-
-Install: `npm install @flintpay/node`
-
-Start with [the quickstart](examples/api-addOrderCharge.mjs). Set API_BASE_URL explicitly. Legacy authentication examples use API_TOKEN; composed-mode examples name each required API_MODE_SCHEME credential variable. Examples target a placeholder sandbox and make one attempt. Provider example values must match your sandbox. Run examples from the generated package: for Node use node examples/NAME.mjs; for PHP run composer install in the generated php/ directory, then php examples/NAME.php. When copying a PHP example into an application, point its require statement at that application's vendor/autoload.php.
-
-## Client and request options
-
-Construct a client with baseUrl and, for legacy authenticated operations, token. Composed clients accept authMode and credentials keyed by mode and scheme; requests can select a mode with request-local credentials. A combined scheme set must be complete. The SDK does not discover credentials or read environment variables; the operation example scripts read API_BASE_URL and their named credential variables explicitly. Pass per-request options as the second method argument: a plain object in Node, or RequestOptions in PHP. Defaults are timeoutMs: 10000 per attempt and deadlineMs: 30000 for the overall duration (not an absolute timestamp). Request values override client defaults. maxAttempts defaults to the operation's declared limit, or one when no retries are declared; overrides cannot exceed that limit. Request headers carry tenant context without shared mutable state.
-
-Results expose data, meta and explicit raw response access. JSON raw values are text; PDF data/raw are Uint8Array in Node and binary-safe strings in PHP. SSE data is a closeable iterable carrying event names, IDs, decoded data and rawData. Node metadata uses properties; PHP metadata uses array keys. SdkError exposes kind, outcome, retryAllowed and optional metadata; provider codes use code in Node and errorCode in PHP. outcome is not_sent, response or unknown. Reconcile an unknown mutation outcome with the provider and the original persisted idempotency key before resubmitting.
-
-## Behavior and ownership
-
-Optional properties distinguish omission from null. PHP inputs use presence-aware typed input objects constructed from arrays: omit a key to omit it; include a key with null to clear only where permitted. PHP models expose presence through has()/get(); typed getters unwrap nested models and getters for omitted optional fields throw. In object/array alternatives, PHP lists (including []) represent JSON arrays; use (object) [] for an empty JSON object. Numeric enum inputs use exact strings for number/int64/uint64 schemas; membership compares exact values, so equivalent decimal/exponent spellings are accepted. Numeric anyOf branches merge equivalent values exactly and preserve the request token; oneOf still requires exactly one matching branch. Numeric conversions supported only by branches that stop matching fail validation before dispatch. Mutually dependent numeric alternatives use joint matching, limited to 256 combinations per value path; exceeding this limit fails validation. Large integers (int64) and decimals use exact strings, including numeric JSON wire values. When the provider enables explicit numeric unions, ambiguous numeric inputs use new ExactNumber("1.2500") and plain strings retain their JSON string meaning. Integer responses accept integral decimal/exponent notation without rounding. Sparse Node input arrays fail before dispatch. Timestamps remain strings. Unknown response fields, enum members, and tagged variants are retained. PHP response class names include status codes and, for tagged alternatives, branch positions. Adding a status can introduce a new return class even with an identical JSON shape; consult migration notes before upgrading class-based dispatch. Portable digit/word pattern escapes retain their ASCII ECMAScript meaning in both targets, including inside character classes. Full request encoding checks run locally; server business effects require provider tests.
+Use the Flint Pay SDK to integrate with the Flint API from your server. See the [Flint Pay SDK documentation](https://developers.withflintpay.com/docs/guides/sdks) for setup and integration guides.
 
-Retries count total attempts, include jitter and Retry-After, and never exceed the declared policy. Persist an idempotency key across process restarts and submissions within the server's documented retention/scope. Automatic keys cover one SDK call only. Explicit keys from operation inputs, request headers or idempotencyKey are preserved; conflicting values fail before dispatch. A timeout after dispatch can leave the remote outcome unknown; inspect SdkError.outcome. Disable nested transport/application retries to avoid multiplied attempts. 409/412 are distinct conflicts and never automatically overwritten.
+Generated with [Flint's SDK generator](https://github.com/flint-pay/sdk-generator). Submit fixes and pull requests to the generator; this distribution repository does not accept pull requests.
 
-Timeout is per attempt, including buffered body consumption. For SSE, timeout/deadline bound connection setup; streamIdleTimeoutMs controls idle reads and streamLifetimeMs optionally bounds stream lifetime. Close result.data or the client to release a stream; breaking iteration also closes it. Unknown event names retain raw strings. Reconnect and persist resume cursors explicitly; no yielded event is retried automatically. Deadline covers attempts and waits; pagination and polling share an overall deadline. Cancellation stops local work, not the remote operation. Node uses AbortSignal. PHP uses a Cancellation token checked during cURL progress and between waits; synchronous calls need an external signal handler to cancel while blocked. Pagination is lazy, supports maxPages/maxItems, and does not guarantee a stable snapshot or durable continuation. Generation rejects incompatible continuation/query representations, including an int64/uint64 continuation with an ordinary integer query parameter. Configured money helpers reject whitespace, including trailing newlines, and excess precision when converting exact major-unit strings to minor units.
+[API reference and operation examples](REFERENCE.md)
 
-Explicit allowedOrigins govern all destinations, including pagination. HTTPS is required unless allowInsecureHttp is set for local tests. Declared 302/307 responses return Location metadata without following redirects; undeclared redirects are rejected. Authentication is attached only after destination validation. API version headers are pinned when configured; changing them does not update generated types.
+## Installation
 
-Clients perform no network I/O at import/construction. Node clients reuse the runtime's fetch connection pool; injected transports remain caller-owned and must honor AbortSignal and disable redirects/retries. PHP owns a reusable cURL handle, released by close()/destruction; a client supports sequential calls within one PHP execution context. Do not concurrently share a PHP client across threads/fibers. Node requests keep headers/context local and support concurrent calls. No SDK telemetry is sent. Requests use the media type selected by the provider profile. Schema validation counts encoded object properties, including explicit nulls, after optional-field omission. Requests identify the selected package name/version and runtime through an overridable User-Agent header.
-
-Diagnostics run once per attempted HTTP request, including transport failures, with operation, request ID, status, timing, attempt count and error kind only; hook failures are ignored. Bodies and credentials are excluded. Raw response text/headers and structured error details are privileged explicit access. Binary/stream result inspection omits raw headers and URLs; event inspection omits payloads. Node Model.toJSON() and PHP model accessors return defensive copies. To change an input, edit the Node toJSON() or PHP toInputArray()/toInputValue() copy and construct a new model; the PHP input exports preserve exact numeric kinds. Model debug printing redacts declared sensitive fields and additional field names supplied in ClientOptions.redactFields; printing arbitrary raw values is application responsibility. Injected transports are privileged and see credentials/bodies.
-
-## Schema helpers
-
-The package exports serialize(value, schema), new Model(value, schema), and redact(value, schema) for application-supplied schemas. These helpers use the package's local value execution rules and require no generator installation or schema registry service. Generated methods and factories use the codecs included in the package. For a null-only schema, use {"type":"null"}. The legacy form {"type":["null"]} also permits non-null values in Node; PHP rejects them.
-
-## Package upgrades
-
-Review provider release notes before upgrading. Compatibility checks account for public declarations, required response values and PHP class identities. Complex schema changes can still require manual review.
-
-## Webhooks and recovery
-
-Verification uses the configured HMAC-SHA256 signature format, signed headers and original body bytes, with timestamp tolerance and overlapping secrets. Preserve raw request bytes; never verify reserialized JSON. Verification is not durable deduplication. In one database transaction, insert a unique provider event ID and durable work record before acknowledging. Workers should fetch authoritative current state for out-of-order events; commit business side effects idempotently. Unknown event types must not be treated as known success.
+Requires Node.js 22+; TypeScript 5.9+. ESM JavaScript and declarations ship together.
 
-Custom helpers belong in custom/; they survive regeneration. Multi-call helpers are not atomic and must expose partial completion. See [reference](REFERENCE.md).
+Install: `npm install @flintpay/node@0.2.0-beta.2`
+
+## Quickstart
+
+Set `API_BASE_URL` to your API environment and replace the sample IDs below with values from your account. Set `API_TOKEN` for token authentication; named authentication modes use the `API_MODE_SCHEME` environment variables shown in each example. The example scripts read these variables explicitly.
+
+Copy an example into an ESM application, or run a packaged script with `node examples/RESOURCE-METHOD.mjs`. TypeScript examples are included alongside the JavaScript files. Examples use a placeholder base URL and one request attempt.
+
+Replace sample IDs with values from your account. For idempotent mutations, create and save a unique key with the business action before sending the request; reload that same key when retrying. Use a different key for each new action.
+
+### api.createPaymentIntent
+
+Creates a standalone payment intent for the authenticated merchant. Create order-owned payment intents with POST /v1/orders/{order_id}/payment-intents.
+
+```typescript
+import { SdkError, Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+
+// Load the key already saved with this business action.
+const idempotencyKey = process.env.API_IDEMPOTENCY_KEY;
+if (!idempotencyKey) throw new Error('Set API_IDEMPOTENCY_KEY to the saved key');
+
+try {
+  const result = await client.api.createPaymentIntent(
+    {
+      body: {
+        amount_money: {
+          amount: "0",
+          currency: "USD",
+        },
+        payment_options: ["card"],
+      },
+      "Idempotency-Key": idempotencyKey,
+    },
+    { maxAttempts: 1 },
+  );
+  console.log(result.data.data.payment_intent.payment_intent_id);
+  console.log(result.data.data.payment_intent.status);
+  console.log(result.meta.requestId);
+} catch (error) {
+  if (!(error instanceof SdkError)) throw error;
+  console.error(error.kind, error.code, error.meta?.requestId);
+  if (error.outcome === 'unknown') {
+    // Reconcile with the API before resubmitting this action.
+    console.error('The request may have succeeded; check its current state.');
+  }
+  throw error;
+}
+```
+
+[Run the standalone example](examples/api-createPaymentIntent.mjs)
+
+## More examples
+
+Reuse the client above. Each recipe represents a separate business action.
+
+### api.getPaymentIntent
+
+Returns a single payment intent by ID.
+
+```typescript
+const apiGetPaymentIntentResult = await client.api.getPaymentIntent(
+  {
+    payment_intent_id: "example",
+  },
+  { maxAttempts: 1 },
+);
+console.log(apiGetPaymentIntentResult.data.data.payment_intent_id);
+console.log(apiGetPaymentIntentResult.data.data.status);
+console.log(apiGetPaymentIntentResult.meta.requestId);
+```
+
+[Run the standalone example](examples/api-getPaymentIntent.mjs)
+
+### api.createRefund
+
+Creates a refund for an order or payment intent. This is a financial operation.
+
+```typescript
+// Load the key already saved with this business action.
+const apiCreateRefundIdempotencyKey = process.env.API_API_CREATEREFUND_IDEMPOTENCY_KEY;
+if (!apiCreateRefundIdempotencyKey) throw new Error('Set API_API_CREATEREFUND_IDEMPOTENCY_KEY to the saved key');
+
+const apiCreateRefundResult = await client.api.createRefund(
+  {
+    body: {
+      order_id: "example",
+    },
+    "Idempotency-Key": apiCreateRefundIdempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(apiCreateRefundResult.data.data.refund_id);
+console.log(apiCreateRefundResult.data.data.status);
+console.log(apiCreateRefundResult.meta.requestId);
+```
+
+[Run the standalone example](examples/api-createRefund.mjs)
+
+Close the client when finished with `await client.close()`. For retry and error details, see the [runtime guide](RUNTIME.md).
+
+## More documentation
+
+- [API reference and all operation examples](REFERENCE.md)
+- [Runtime guide](RUNTIME.md): request options, errors, retries, pagination and webhooks.

package/REFERENCE.md

@@ -1,6 +1,6 @@
 # Flint Public API API reference
 
-Package 0.2.0-beta.1; API 2026-09-07.
+Package 0.2.0-beta.2; API 2026-09-07.
 
 ## api.addOrderCharge
 

package/RUNTIME.md

@@ -0,0 +1,69 @@
+# Flint Public API runtime guide (node)
+
+Package 0.2.0-beta.2; API 2026-09-07.
+
+[Back to the quickstart](README.md) · [API reference](REFERENCE.md)
+
+## Client and request options
+
+Construct a client with baseUrl and, for legacy authenticated operations, token. Composed clients accept authMode and credentials keyed by mode and scheme; requests can select a mode with request-local credentials. A combined scheme set must be complete. The SDK does not discover credentials or read environment variables; the operation example scripts read API_BASE_URL and their named credential variables explicitly. Pass per-request options as the second method argument: a plain object in Node, or RequestOptions in PHP. Defaults are timeoutMs: 10000 per attempt and deadlineMs: 30000 for the overall duration (not an absolute timestamp). Request values override client defaults. maxAttempts defaults to the operation's declared limit, or one when no retries are declared; overrides cannot exceed that limit. Request headers carry tenant context without shared mutable state.
+
+## Responses and errors
+
+Results expose data, meta and explicit raw response access. JSON raw values are text; PDF data/raw are Uint8Array in Node and binary-safe strings in PHP. SSE data is a closeable iterable carrying event names, IDs, decoded data and rawData. Node metadata uses properties; PHP metadata uses array keys. SdkError exposes kind, outcome, retryAllowed and optional metadata; provider codes use code in Node and errorCode in PHP. outcome is not_sent, response or unknown. Reconcile an unknown mutation outcome with the provider and the original persisted idempotency key before resubmitting.
+
+## Input and response values
+
+Optional properties distinguish omission from null. PHP inputs use presence-aware typed input objects constructed from arrays: omit a key to omit it; include a key with null to clear only where permitted. PHP models expose presence through has()/get(); typed getters unwrap nested models and getters for omitted optional fields throw. In object/array alternatives, PHP lists (including []) represent JSON arrays; use (object) [] for an empty JSON object.
+
+Numeric enum inputs use exact strings for number/int64/uint64 schemas; membership compares exact values, so equivalent decimal/exponent spellings are accepted. Numeric anyOf branches merge equivalent values exactly and preserve the request token; oneOf still requires exactly one matching branch. Numeric conversions supported only by branches that stop matching fail validation before dispatch. Mutually dependent numeric alternatives use joint matching, limited to 256 combinations per value path; exceeding this limit fails validation.
+
+Large integers (int64) and decimals use exact strings, including numeric JSON wire values. When the provider enables explicit numeric unions, ambiguous numeric inputs use new ExactNumber("1.2500") and plain strings retain their JSON string meaning. Integer responses accept integral decimal/exponent notation without rounding. Sparse Node input arrays fail before dispatch. Timestamps remain strings. Unknown response fields, enum members, and tagged variants are retained.
+
+PHP response class names include status codes and, for tagged alternatives, branch positions. Adding a status can introduce a new return class even with an identical JSON shape; consult migration notes before upgrading class-based dispatch.
+
+Portable digit/word pattern escapes retain their ASCII ECMAScript meaning in both targets, including inside character classes. Full request encoding checks run locally; server business effects require provider tests.
+
+## Retries and idempotency
+
+Retries count total attempts, include jitter and Retry-After, and never exceed the declared policy. Persist an idempotency key across process restarts and submissions within the server's documented retention/scope. Automatic keys cover one SDK call only. Explicit keys from operation inputs, request headers or idempotencyKey are preserved; conflicting values fail before dispatch. A timeout after dispatch can leave the remote outcome unknown; inspect SdkError.outcome. Disable nested transport/application retries to avoid multiplied attempts. 409/412 are distinct conflicts and never automatically overwritten.
+
+## Timeouts, streaming and cancellation
+
+Timeout is per attempt, including buffered body consumption. For SSE, timeout/deadline bound connection setup; streamIdleTimeoutMs controls idle reads and streamLifetimeMs optionally bounds stream lifetime. Close result.data or the client to release a stream; breaking iteration also closes it. Unknown event names retain raw strings. Reconnect and persist resume cursors explicitly; no yielded event is retried automatically.
+
+Deadline covers attempts and waits; pagination and polling share an overall deadline. Cancellation stops local work, not the remote operation. Node uses AbortSignal. PHP uses a Cancellation token checked during cURL progress and between waits; synchronous calls need an external signal handler to cancel while blocked.
+
+### Pagination and polling
+
+Pagination is lazy, supports maxPages/maxItems, and does not guarantee a stable snapshot or durable continuation. Generation rejects incompatible continuation/query representations, including an int64/uint64 continuation with an ordinary integer query parameter. Configured money helpers reject whitespace, including trailing newlines, and excess precision when converting exact major-unit strings to minor units.
+
+## Destinations and API versions
+
+Explicit allowedOrigins govern all destinations, including pagination. HTTPS is required unless allowInsecureHttp is set for local tests. Declared 302/307 responses return Location metadata without following redirects; undeclared redirects are rejected. Authentication is attached only after destination validation. API version headers are pinned when configured; changing them does not update generated types.
+
+## Client lifecycle and transports
+
+Clients perform no network I/O at import/construction. Node clients reuse the runtime's fetch connection pool; injected transports remain caller-owned and must honor AbortSignal and disable redirects/retries. PHP owns a reusable cURL handle, released by close()/destruction; a client supports sequential calls within one PHP execution context. Do not concurrently share a PHP client across threads/fibers. Node requests keep headers/context local and support concurrent calls. No SDK telemetry is sent. Requests use the media type selected by the provider profile. Schema validation counts encoded object properties, including explicit nulls, after optional-field omission. Requests identify the selected package name/version and runtime through an overridable User-Agent header.
+
+## Diagnostics and sensitive data
+
+Diagnostics run once per attempted HTTP request, including transport failures, with operation, request ID, status, timing, attempt count and error kind only; hook failures are ignored. Bodies and credentials are excluded. Raw response text/headers and structured error details are privileged explicit access. Binary/stream result inspection omits raw headers and URLs; event inspection omits payloads.
+
+Node Model.toJSON() and PHP model accessors return defensive copies. To change an input, edit the Node toJSON() or PHP toInputArray()/toInputValue() copy and construct a new model; the PHP input exports preserve exact numeric kinds. Model debug printing redacts declared sensitive fields and additional field names supplied in ClientOptions.redactFields; printing arbitrary raw values is application responsibility. Injected transports are privileged and see credentials/bodies.
+
+## Schema helpers
+
+The package exports serialize(value, schema), new Model(value, schema), and redact(value, schema) for application-supplied schemas. These helpers use the package's local value execution rules and require no generator installation or schema registry service. Generated methods and factories use the codecs included in the package. For a null-only schema, use {"type":"null"}. The legacy form {"type":["null"]} also permits non-null values in Node; PHP rejects them.
+
+## Package upgrades
+
+Review provider release notes before upgrading. Compatibility checks account for public declarations, required response values and PHP class identities. Complex schema changes can still require manual review.
+
+## Webhooks and recovery
+
+Verification uses the configured HMAC-SHA256 signature format, signed headers and original body bytes, with timestamp tolerance and overlapping secrets. Preserve raw request bytes; never verify reserialized JSON. Verification is not durable deduplication. In one database transaction, insert a unique provider event ID and durable work record before acknowledging. Workers should fetch authoritative current state for out-of-order events; commit business side effects idempotently. Unknown event types must not be treated as known success.
+
+## Custom helpers
+
+Custom helpers belong in custom/; they survive regeneration. Multi-call helpers are not atomic and must expose partial completion. See [reference](REFERENCE.md).

package/contract.d.ts

@@ -191,6 +191,7 @@ export interface Config {
     documentation?: {
         overview?: string;
         guides?: Record<string, string>;
+        examples?: string[];
     };
     release?: {
         baseUrl?: string;

package/examples/api-addOrderCharge.mjs

@@ -1,16 +1,24 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addOrderCharge({
-  "order_id": "example",
-  "body": {
-    "charge": {
-      "name": "example",
-      "type": "service_fee",
-      "amount_money": {
-        "amount": "0",
-        "currency": "USD"
-      }
-    }
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addOrderCharge(
+  {
+    order_id: "example",
+    body: {
+      charge: {
+        name: "example",
+        type: "service_fee",
+        amount_money: {
+          amount: "0",
+          currency: "USD",
+        },
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-addOrderCharge.ts

@@ -1,16 +1,24 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addOrderCharge({
-  "order_id": "example",
-  "body": {
-    "charge": {
-      "name": "example",
-      "type": "service_fee",
-      "amount_money": {
-        "amount": "0",
-        "currency": "USD"
-      }
-    }
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addOrderCharge(
+  {
+    order_id: "example",
+    body: {
+      charge: {
+        name: "example",
+        type: "service_fee",
+        amount_money: {
+          amount: "0",
+          currency: "USD",
+        },
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-addOrderLineItems.mjs

@@ -1,13 +1,21 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addOrderLineItems({
-  "order_id": "example",
-  "body": {
-    "line_items": [
-      {
-        "variant_id": "example"
-      }
-    ]
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addOrderLineItems(
+  {
+    order_id: "example",
+    body: {
+      line_items: [
+        {
+          variant_id: "example",
+        },
+      ],
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-addOrderLineItems.ts

@@ -1,13 +1,21 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addOrderLineItems({
-  "order_id": "example",
-  "body": {
-    "line_items": [
-      {
-        "variant_id": "example"
-      }
-    ]
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addOrderLineItems(
+  {
+    order_id: "example",
+    body: {
+      line_items: [
+        {
+          variant_id: "example",
+        },
+      ],
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-addReturnLineItem.mjs

@@ -1,13 +1,21 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addReturnLineItem({
-  "return_id": "example",
-  "body": {
-    "line_item": {
-      "order_line_item_id": "example",
-      "requested_quantity": "100",
-      "return_reason_id": "example"
-    }
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addReturnLineItem(
+  {
+    return_id: "example",
+    body: {
+      line_item: {
+        order_line_item_id: "example",
+        requested_quantity: "100",
+        return_reason_id: "example",
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.return_id);
 console.log(result.meta.requestId);

package/examples/api-addReturnLineItem.ts

@@ -1,13 +1,21 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addReturnLineItem({
-  "return_id": "example",
-  "body": {
-    "line_item": {
-      "order_line_item_id": "example",
-      "requested_quantity": "100",
-      "return_reason_id": "example"
-    }
-  }
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addReturnLineItem(
+  {
+    return_id: "example",
+    body: {
+      line_item: {
+        order_line_item_id: "example",
+        requested_quantity: "100",
+        return_reason_id: "example",
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.order_id);
+console.log(result.data.data.return_id);
 console.log(result.meta.requestId);

package/examples/api-addRiskListItems.mjs

@@ -1,11 +1,15 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addRiskListItems({
-  "body": {
-    "values": [
-      "sdk-example"
-    ]
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addRiskListItems(
+  {
+    body: {
+      values: ["sdk-example"],
+    },
+    risk_list_id: "example",
   },
-  "risk_list_id": "example"
-}, { maxAttempts: 1 });
+  { maxAttempts: 1 },
+);
 console.log(result.meta.requestId);

package/examples/api-addRiskListItems.ts

@@ -1,11 +1,15 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.addRiskListItems({
-  "body": {
-    "values": [
-      "sdk-example"
-    ]
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.addRiskListItems(
+  {
+    body: {
+      values: ["sdk-example"],
+    },
+    risk_list_id: "example",
   },
-  "risk_list_id": "example"
-}, { maxAttempts: 1 });
+  { maxAttempts: 1 },
+);
 console.log(result.meta.requestId);

package/examples/api-advanceOnboarding.mjs

@@ -1,6 +1,14 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.advanceOnboarding({
-  "body": {}
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.advanceOnboarding(
+  {
+    body: {},
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.merchant_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-advanceOnboarding.ts

@@ -1,6 +1,14 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.advanceOnboarding({
-  "body": {}
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.advanceOnboarding(
+  {
+    body: {},
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.merchant_id);
+console.log(result.data.data.status);
 console.log(result.meta.requestId);

package/examples/api-applyInventoryCount.mjs

@@ -1,8 +1,16 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.applyInventoryCount({
-  "Idempotency-Key": "example",
-  "inventory_count_id": "example",
-  "body": {}
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.applyInventoryCount(
+  {
+    "Idempotency-Key": "example",
+    inventory_count_id: "example",
+    body: {},
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.inventory_count.inventory_count_id);
+console.log(result.data.data.inventory_count.location_id);
 console.log(result.meta.requestId);

package/examples/api-applyInventoryCount.ts

@@ -1,8 +1,16 @@
 import { Client } from '@flintpay/node';
-const client = new Client({ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid', allowInsecureHttp: process.env.API_ALLOW_INSECURE_HTTP === '1', authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } } });
-const result = await client.api.applyInventoryCount({
-  "Idempotency-Key": "example",
-  "inventory_count_id": "example",
-  "body": {}
-}, { maxAttempts: 1 });
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  authMode: "merchant", credentials: { ["merchant"]: { ["BearerAuth"]: process.env.API_MERCHANT_BEARERAUTH ?? '' } },
+});
+const result = await client.api.applyInventoryCount(
+  {
+    "Idempotency-Key": "example",
+    inventory_count_id: "example",
+    body: {},
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.data.data.inventory_count.inventory_count_id);
+console.log(result.data.data.inventory_count.location_id);
 console.log(result.meta.requestId);