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

package/examples/reports-create.ts

@@ -0,0 +1,20 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.reports.create(
+  {
+    currency: "USD",
+    interval_end_at: "2026-01-01T00:00:00Z",
+    interval_start_at: "2026-01-01T00:00:00Z",
+    report_type: "orders_itemized_v1",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.report_id);
+console.log(result.status);

package/examples/reports-get.mjs

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.reports.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.report_id);
+console.log(result.status);

package/examples/reports-get.ts

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.reports.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.report_id);
+console.log(result.status);

package/examples/reports-list.mjs

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.reports.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/reports-list.ts

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.reports.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnDispositions-cancel.mjs

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnDispositions.cancel(
+  "example",
+  {
+    reason: "created_in_error",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnDispositions-cancel.ts

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnDispositions.cancel(
+  "example",
+  {
+    reason: "created_in_error",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnDispositions-get.mjs

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnDispositions.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnDispositions-get.ts

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnDispositions.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnDispositions-list.mjs

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnDispositions.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnDispositions-list.ts

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnDispositions.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnDispositions-retry.mjs

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnDispositions.retry(
+  "example",
+  {
+    reason: "dependency_recovered",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnDispositions-retry.ts

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnDispositions.retry(
+  "example",
+  {
+    reason: "dependency_recovered",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_disposition_id);
+console.log(result.return_id);

package/examples/returnInspections-decideLineItem.mjs

@@ -0,0 +1,20 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnInspections.decideLineItem(
+  "example",
+  "example",
+  {
+    acceptance_decision_reason: "inspection_result",
+    acceptance_status: "accepted",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.location_id);
+console.log(result.return_id);

package/examples/returnInspections-decideLineItem.ts

@@ -0,0 +1,20 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnInspections.decideLineItem(
+  "example",
+  "example",
+  {
+    acceptance_decision_reason: "inspection_result",
+    acceptance_status: "accepted",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.location_id);
+console.log(result.return_id);

package/examples/returnInspections-get.mjs

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnInspections.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.location_id);
+console.log(result.return_id);

package/examples/returnInspections-get.ts

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnInspections.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.location_id);
+console.log(result.return_id);

package/examples/returnInspections-list.mjs

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnInspections.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnInspections-list.ts

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnInspections.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnPolicies-create.mjs

@@ -0,0 +1,24 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.create(
+  {
+    name: "example",
+    revision: {
+      approval_mode: "automatic",
+      eligibility_result: "ineligible",
+      is_merchandise_return_required: true,
+      priority: 1,
+      scope: {},
+    },
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-create.ts

@@ -0,0 +1,24 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.create(
+  {
+    name: "example",
+    revision: {
+      approval_mode: "automatic",
+      eligibility_result: "ineligible",
+      is_merchandise_return_required: true,
+      priority: 1,
+      scope: {},
+    },
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-get.mjs

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-get.ts

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-getRevision.mjs

@@ -0,0 +1,13 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.getRevision(
+  "example",
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.return_policy_id);
+console.log(result.return_policy_revision_id);

package/examples/returnPolicies-getRevision.ts

@@ -0,0 +1,13 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.getRevision(
+  "example",
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.return_policy_id);
+console.log(result.return_policy_revision_id);

package/examples/returnPolicies-list.mjs

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnPolicies-list.ts

@@ -0,0 +1,9 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.list(
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnPolicies-listRevisions.mjs

@@ -0,0 +1,10 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.listRevisions(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnPolicies-listRevisions.ts

@@ -0,0 +1,10 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPolicies.listRevisions(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);

package/examples/returnPolicies-publishRevision.mjs

@@ -0,0 +1,25 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.publishRevision(
+  "example",
+  {
+    expected_current_return_policy_revision_id: "example",
+    revision: {
+      approval_mode: "automatic",
+      eligibility_result: "ineligible",
+      is_merchandise_return_required: true,
+      priority: 1,
+      scope: {},
+    },
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-publishRevision.ts

@@ -0,0 +1,25 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.publishRevision(
+  "example",
+  {
+    expected_current_return_policy_revision_id: "example",
+    revision: {
+      approval_mode: "automatic",
+      eligibility_result: "ineligible",
+      is_merchandise_return_required: true,
+      priority: 1,
+      scope: {},
+    },
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-remove.mjs

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.remove(
+  "example",
+  {
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-remove.ts

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.remove(
+  "example",
+  {
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-update.mjs

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.update(
+  "example",
+  {
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPolicies-update.ts

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnPolicies.update(
+  "example",
+  {
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.current_return_policy_revision_id);
+console.log(result.return_policy_id);

package/examples/returnPreviews-create.mjs

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPreviews.create(
+  {
+    mode: "eligibility",
+    eligibility: {
+      order_id: "example",
+      selection: {
+        selection_type: "all_remaining_fulfilled",
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);

package/examples/returnPreviews-create.ts

@@ -0,0 +1,17 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnPreviews.create(
+  {
+    mode: "eligibility",
+    eligibility: {
+      order_id: "example",
+      selection: {
+        selection_type: "all_remaining_fulfilled",
+      },
+    },
+  },
+  { maxAttempts: 1 },
+);

package/examples/returnReasons-create.mjs

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnReasons.create(
+  {
+    handle: "example",
+    name: "example",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_reason_id);
+console.log(result.status);

package/examples/returnReasons-create.ts

@@ -0,0 +1,18 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+// Reuse this key when retrying the same action.
+const idempotencyKey = crypto.randomUUID();
+
+const result = await client.returnReasons.create(
+  {
+    handle: "example",
+    name: "example",
+    "Idempotency-Key": idempotencyKey,
+  },
+  { maxAttempts: 1 },
+);
+console.log(result.return_reason_id);
+console.log(result.status);

package/examples/returnReasons-get.mjs

@@ -0,0 +1,12 @@
+import { Client } from '@flintpay/node';
+const client = new Client({
+  baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
+  apiKey: process.env.API_KEY ?? '',
+});
+const result = await client.returnReasons.get(
+  "example",
+  {},
+  { maxAttempts: 1 },
+);
+console.log(result.return_reason_id);
+console.log(result.status);