@shippo/shippo-mcp 0.5.0

package/demo/generate-pnl.ts

@@ -0,0 +1,410 @@
+#!/usr/bin/env tsx
+/**
+ * P&L Analysis for Shippo Transactions
+ * 
+ * This demo script generates a Profit & Loss statement from Shippo transactions.
+ * 
+ * Assumptions:
+ * - Each delivered package has a sale price of $140
+ * - Each delivered package has a COGS of $50
+ * - Shipping costs are actual costs from Shippo transactions
+ * - In production, revenue and COGS would come from GL system via MCP
+ */
+
+import { SDKCore } from "../src/core.js";
+import { transactionsList } from "../src/funcs/transactionsList.js";
+
+// Business assumptions (would come from GL in production)
+const REVENUE_PER_PACKAGE = 140.00;
+const COGS_PER_PACKAGE = 50.00;
+
+// Estimated shipping costs for demo purposes
+// In production, this would come from the actual rate objects
+const ESTIMATED_SHIPPING_COST_MIN = 8.00;
+const ESTIMATED_SHIPPING_COST_MAX = 18.00;
+
+// Get API token from environment
+function getApiToken(): string {
+  // Check environment variables
+  const token = process.env.SHIPPO_API_TOKEN 
+    || process.env.SHIPPO_API_KEY 
+    || process.env.API_KEY_HEADER;
+  
+  if (!token) {
+    console.error("❌ Error: Shippo API token not found!");
+    console.error("Please set one of the following environment variables:");
+    console.error("  - SHIPPO_API_TOKEN");
+    console.error("  - SHIPPO_API_KEY");
+    console.error("  - API_KEY_HEADER");
+    console.error("\nExample:");
+    console.error('  export SHIPPO_API_TOKEN="ShippoToken shippo_test_..."');
+    process.exit(1);
+  }
+  
+  return token;
+}
+
+interface PNLMetrics {
+  totalRevenue: number;
+  totalCOGS: number;
+  totalShippingCosts: number;
+  grossProfit: number;
+  grossMargin: number;
+  netProfit: number;
+  netMargin: number;
+  packageCount: number;
+  deliveredCount: number;
+  averageShippingCost: number;
+  averageRevenuePerPackage: number;
+  averageProfitPerPackage: number;
+}
+
+interface TransactionSummary {
+  transactionId: string;
+  trackingNumber: string;
+  carrier: string;
+  servicelevel: string;
+  rate: number;
+  currency: string;
+  status: string;
+  createdAt: string;
+  revenue: number;
+  cogs: number;
+  profit: number;
+}
+
+async function fetchAllTransactions() {
+  const apiToken = getApiToken();
+  const client = new SDKCore({
+    security: {
+      APIKeyHeader: apiToken,
+    },
+    serverURL: process.env.SHIPPO_SERVER_URL || "https://api.goshippo.com",
+    shippoApiVersion: "2018-02-08",
+  });
+
+  console.log("Fetching Shippo transactions...");
+  
+  const transactions = [];
+  let page = 1;
+  let hasMore = true;
+
+  while (hasMore) {
+    try {
+      const responsePromise = transactionsList(client, {
+        page,
+        results: 100,
+      });
+
+      // Handle the Result type - $inspect returns [Result, APICall]
+      const [result] = await responsePromise.$inspect();
+      
+      if (!result.ok) {
+        console.error(`Error fetching page ${page}:`, result.error.message);
+        hasMore = false;
+        continue;
+      }
+
+      const data = result.value;
+      
+      if (data.TransactionPaginatedList?.results && data.TransactionPaginatedList.results.length > 0) {
+        transactions.push(...data.TransactionPaginatedList.results);
+        console.log(`Fetched page ${page}: ${data.TransactionPaginatedList.results.length} transactions`);
+        
+        // Check if there are more pages
+        hasMore = !!data.TransactionPaginatedList.next;
+        page++;
+      } else {
+        hasMore = false;
+      }
+    } catch (error) {
+      console.error(`Error fetching page ${page}:`, error);
+      hasMore = false;
+    }
+  }
+
+  console.log(`Total transactions fetched: ${transactions.length}\n`);
+  return transactions;
+}
+
+function calculatePNL(transactions: any[]): { metrics: PNLMetrics; details: TransactionSummary[] } {
+  const details: TransactionSummary[] = [];
+  
+  let totalRevenue = 0;
+  let totalCOGS = 0;
+  let totalShippingCosts = 0;
+  let deliveredCount = 0;
+
+  for (const txn of transactions) {
+    // Only count successful transactions
+    if (txn.status !== "SUCCESS") {
+      continue;
+    }
+
+    // Estimate shipping cost for demo purposes
+    // In production, we would fetch the actual rate object using the rate ID
+    // For now, we use a randomized estimate between min and max
+    const shippingCost = ESTIMATED_SHIPPING_COST_MIN + 
+      Math.random() * (ESTIMATED_SHIPPING_COST_MAX - ESTIMATED_SHIPPING_COST_MIN);
+    
+    // Parse rate info if available
+    let rateId = '';
+    let carrier = '';
+    let servicelevel = '';
+    
+    if (typeof txn.rate === 'object' && txn.rate !== null) {
+      // Rate object is included (e.g., from instalabel)
+      carrier = (txn.rate as any).provider || '';
+      servicelevel = (txn.rate as any).servicelevel_name || '';
+      rateId = (txn.rate as any).object_id || '';
+    } else if (typeof txn.rate === 'string') {
+      // Rate is just an ID string
+      rateId = txn.rate;
+    }
+    
+    const currency = "USD";
+    
+    // For delivered packages, add to P&L
+    // In reality, we'd check tracking_status for "DELIVERED"
+    const isDelivered = txn.status === "SUCCESS";
+    
+    const revenue = isDelivered ? REVENUE_PER_PACKAGE : 0;
+    const cogs = isDelivered ? COGS_PER_PACKAGE : 0;
+    const profit = revenue - cogs - shippingCost;
+
+    if (isDelivered) {
+      deliveredCount++;
+      totalRevenue += revenue;
+      totalCOGS += cogs;
+    }
+    
+    totalShippingCosts += shippingCost;
+
+    details.push({
+      transactionId: txn.object_id || "",
+      trackingNumber: txn.tracking_number || "",
+      carrier: carrier || "Est.",
+      servicelevel: servicelevel || "Standard (estimated)",
+      rate: shippingCost,
+      currency: currency,
+      status: txn.status || "",
+      createdAt: txn.object_created || "",
+      revenue: revenue,
+      cogs: cogs,
+      profit: profit,
+    });
+  }
+
+  const grossProfit = totalRevenue - totalCOGS;
+  const netProfit = grossProfit - totalShippingCosts;
+  const grossMargin = totalRevenue > 0 ? (grossProfit / totalRevenue) * 100 : 0;
+  const netMargin = totalRevenue > 0 ? (netProfit / totalRevenue) * 100 : 0;
+  const averageShippingCost = deliveredCount > 0 ? totalShippingCosts / deliveredCount : 0;
+
+  const metrics: PNLMetrics = {
+    totalRevenue,
+    totalCOGS,
+    totalShippingCosts,
+    grossProfit,
+    grossMargin,
+    netProfit,
+    netMargin,
+    packageCount: transactions.length,
+    deliveredCount,
+    averageShippingCost,
+    averageRevenuePerPackage: deliveredCount > 0 ? totalRevenue / deliveredCount : 0,
+    averageProfitPerPackage: deliveredCount > 0 ? netProfit / deliveredCount : 0,
+  };
+
+  return { metrics, details };
+}
+
+function formatCurrency(amount: number): string {
+  return `$${amount.toFixed(2)}`;
+}
+
+function formatPercent(percent: number): string {
+  return `${percent.toFixed(2)}%`;
+}
+
+function generateMarkdownReport(metrics: PNLMetrics, details: TransactionSummary[]): string {
+  const timestamp = new Date().toISOString();
+  
+  let md = `# Shippo Transaction P&L Report\n\n`;
+  md += `**Generated:** ${timestamp}\n\n`;
+  md += `**Note:** This is a demo report. In production, revenue and COGS would be sourced from a GL system via MCP.\n\n`;
+  
+  md += `## Business Assumptions\n\n`;
+  md += `- Revenue per delivered package: ${formatCurrency(REVENUE_PER_PACKAGE)}\n`;
+  md += `- COGS per delivered package: ${formatCurrency(COGS_PER_PACKAGE)}\n`;
+  md += `- Shipping costs: Estimated at ${formatCurrency(ESTIMATED_SHIPPING_COST_MIN)}-${formatCurrency(ESTIMATED_SHIPPING_COST_MAX)} per package\n`;
+  md += `  *(In production, actual costs would be fetched from rate objects)*\n\n`;
+  
+  md += `## Executive Summary\n\n`;
+  md += `| Metric | Value |\n`;
+  md += `|--------|-------|\n`;
+  md += `| Total Packages | ${metrics.packageCount} |\n`;
+  md += `| Delivered Packages | ${metrics.deliveredCount} |\n`;
+  md += `| Total Revenue | ${formatCurrency(metrics.totalRevenue)} |\n`;
+  md += `| Total COGS | ${formatCurrency(metrics.totalCOGS)} |\n`;
+  md += `| Total Shipping Costs | ${formatCurrency(metrics.totalShippingCosts)} |\n`;
+  md += `| **Gross Profit** | **${formatCurrency(metrics.grossProfit)}** |\n`;
+  md += `| **Gross Margin** | **${formatPercent(metrics.grossMargin)}** |\n`;
+  md += `| **Net Profit** | **${formatCurrency(metrics.netProfit)}** |\n`;
+  md += `| **Net Margin** | **${formatPercent(metrics.netMargin)}** |\n\n`;
+  
+  md += `## Per Package Metrics\n\n`;
+  md += `| Metric | Value |\n`;
+  md += `|--------|-------|\n`;
+  md += `| Average Revenue | ${formatCurrency(metrics.averageRevenuePerPackage)} |\n`;
+  md += `| Average Shipping Cost | ${formatCurrency(metrics.averageShippingCost)} |\n`;
+  md += `| Average Profit per Package | ${formatCurrency(metrics.averageProfitPerPackage)} |\n\n`;
+  
+  md += `## Detailed P&L Statement\n\n`;
+  md += `\`\`\`\n`;
+  md += `Revenue\n`;
+  md += `  Gross Sales (${metrics.deliveredCount} packages @ $${REVENUE_PER_PACKAGE.toFixed(2)})    ${formatCurrency(metrics.totalRevenue).padStart(15)}\n`;
+  md += `\n`;
+  md += `Cost of Goods Sold\n`;
+  md += `  Product Costs (${metrics.deliveredCount} packages @ $${COGS_PER_PACKAGE.toFixed(2)})       ${formatCurrency(metrics.totalCOGS).padStart(15)}\n`;
+  md += `                                                    ________________\n`;
+  md += `Gross Profit                                      ${formatCurrency(metrics.grossProfit).padStart(15)}\n`;
+  md += `Gross Margin                                      ${formatPercent(metrics.grossMargin).padStart(15)}\n`;
+  md += `\n`;
+  md += `Operating Expenses\n`;
+  md += `  Shipping & Fulfillment                          ${formatCurrency(metrics.totalShippingCosts).padStart(15)}\n`;
+  md += `                                                    ________________\n`;
+  md += `Net Profit                                        ${formatCurrency(metrics.netProfit).padStart(15)}\n`;
+  md += `Net Margin                                        ${formatPercent(metrics.netMargin).padStart(15)}\n`;
+  md += `\`\`\`\n\n`;
+  
+  md += `## Top 20 Most Profitable Transactions\n\n`;
+  md += `| Transaction ID | Tracking Number | Carrier | Service | Shipping Cost | Revenue | COGS | Profit |\n`;
+  md += `|----------------|-----------------|---------|---------|---------------|---------|------|--------|\n`;
+  
+  const topTransactions = details
+    .filter(d => d.revenue > 0)
+    .sort((a, b) => b.profit - a.profit)
+    .slice(0, 20);
+  
+  for (const txn of topTransactions) {
+    const shortId = txn.transactionId.substring(0, 8);
+    const shortTracking = txn.trackingNumber.substring(0, 16);
+    md += `| ${shortId}... | ${shortTracking}... | ${txn.carrier} | ${txn.servicelevel.substring(0, 20)} | ${formatCurrency(txn.rate)} | ${formatCurrency(txn.revenue)} | ${formatCurrency(txn.cogs)} | ${formatCurrency(txn.profit)} |\n`;
+  }
+  
+  md += `\n## Cost Analysis by Carrier\n\n`;
+  
+  // Group by carrier
+  const carrierStats = new Map<string, { count: number; totalCost: number; revenue: number; profit: number }>();
+  
+  for (const txn of details) {
+    if (txn.revenue > 0) {
+      const carrier = txn.carrier || "Unknown";
+      const stats = carrierStats.get(carrier) || { count: 0, totalCost: 0, revenue: 0, profit: 0 };
+      stats.count++;
+      stats.totalCost += txn.rate;
+      stats.revenue += txn.revenue;
+      stats.profit += txn.profit;
+      carrierStats.set(carrier, stats);
+    }
+  }
+  
+  md += `| Carrier | Packages | Total Shipping Cost | Avg Cost | Total Revenue | Total Profit | Profit Margin |\n`;
+  md += `|---------|----------|---------------------|----------|---------------|--------------|---------------|\n`;
+  
+  const sortedCarriers = Array.from(carrierStats.entries())
+    .sort((a, b) => b[1].totalCost - a[1].totalCost);
+  
+  for (const [carrier, stats] of sortedCarriers) {
+    const avgCost = stats.totalCost / stats.count;
+    const margin = stats.revenue > 0 ? (stats.profit / stats.revenue) * 100 : 0;
+    md += `| ${carrier} | ${stats.count} | ${formatCurrency(stats.totalCost)} | ${formatCurrency(avgCost)} | ${formatCurrency(stats.revenue)} | ${formatCurrency(stats.profit)} | ${formatPercent(margin)} |\n`;
+  }
+  
+  md += `\n---\n\n`;
+  md += `*Note: In a production environment, this report would be enhanced with:*\n`;
+  md += `- *Real-time revenue data from GL system via MCP*\n`;
+  md += `- *Actual COGS per SKU from inventory system*\n`;
+  md += `- *Tracking status verification for delivery confirmation*\n`;
+  md += `- *Returns and refunds processing*\n`;
+  md += `- *Additional operating expenses allocation*\n`;
+  
+  return md;
+}
+
+function generateCSV(details: TransactionSummary[]): string {
+  let csv = "Transaction ID,Tracking Number,Carrier,Service Level,Shipping Cost,Currency,Status,Created At,Revenue,COGS,Profit\n";
+  
+  for (const txn of details) {
+    csv += `"${txn.transactionId}","${txn.trackingNumber}","${txn.carrier}","${txn.servicelevel}",${txn.rate},"${txn.currency}","${txn.status}","${txn.createdAt}",${txn.revenue},${txn.cogs},${txn.profit}\n`;
+  }
+  
+  return csv;
+}
+
+async function main() {
+  try {
+    console.log("=".repeat(60));
+    console.log("Shippo Transaction P&L Analysis");
+    console.log("=".repeat(60));
+    console.log();
+
+    // Fetch transactions
+    const transactions = await fetchAllTransactions();
+    
+    if (transactions.length === 0) {
+      console.log("No transactions found. Exiting.");
+      return;
+    }
+
+    // Calculate P&L
+    console.log("Calculating P&L metrics...");
+    const { metrics, details } = calculatePNL(transactions);
+    
+    // Generate reports
+    console.log("Generating reports...\n");
+    
+    const markdown = generateMarkdownReport(metrics, details);
+    const csv = generateCSV(details);
+    
+    // Write files
+    const fs = await import("fs/promises");
+    const path = await import("path");
+    
+    const demoDir = path.dirname(new URL(import.meta.url).pathname);
+    const markdownPath = path.join(demoDir, "pnl-report.md");
+    const csvPath = path.join(demoDir, "pnl-transactions.csv");
+    const metricsPath = path.join(demoDir, "pnl-metrics.json");
+    
+    await fs.writeFile(markdownPath, markdown);
+    await fs.writeFile(csvPath, csv);
+    await fs.writeFile(metricsPath, JSON.stringify(metrics, null, 2));
+    
+    console.log("Reports generated successfully:");
+    console.log(`  📊 ${markdownPath}`);
+    console.log(`  📄 ${csvPath}`);
+    console.log(`  📈 ${metricsPath}`);
+    console.log();
+    
+    // Print summary
+    console.log("=".repeat(60));
+    console.log("P&L SUMMARY");
+    console.log("=".repeat(60));
+    console.log(`Packages Delivered:      ${metrics.deliveredCount}`);
+    console.log(`Total Revenue:           ${formatCurrency(metrics.totalRevenue)}`);
+    console.log(`Total COGS:              ${formatCurrency(metrics.totalCOGS)}`);
+    console.log(`Total Shipping:          ${formatCurrency(metrics.totalShippingCosts)}`);
+    console.log(`Gross Profit:            ${formatCurrency(metrics.grossProfit)} (${formatPercent(metrics.grossMargin)})`);
+    console.log(`Net Profit:              ${formatCurrency(metrics.netProfit)} (${formatPercent(metrics.netMargin)})`);
+    console.log(`Avg Profit/Package:      ${formatCurrency(metrics.averageProfitPerPackage)}`);
+    console.log("=".repeat(60));
+    
+  } catch (error) {
+    console.error("Error generating P&L report:", error);
+    process.exit(1);
+  }
+}
+
+main();
+

package/demo/pnl-metrics.json

@@ -0,0 +1,14 @@
+{
+  "totalRevenue": 37100,
+  "totalCOGS": 13250,
+  "totalShippingCosts": 3442.7896250152357,
+  "grossProfit": 23850,
+  "grossMargin": 64.28571428571429,
+  "netProfit": 20407.210374984763,
+  "netMargin": 55.00595788405597,
+  "packageCount": 754,
+  "deliveredCount": 265,
+  "averageShippingCost": 12.991658962321644,
+  "averageRevenuePerPackage": 140,
+  "averageProfitPerPackage": 77.00834103767835
+}

package/esm/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class ShippoSDKCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/esm/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,SAAS;CAAG"}

package/esm/core.js

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export class ShippoSDKCore extends ClientSDK {
+}
+//# sourceMappingURL=core.js.map

package/esm/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;CAAG"}

package/esm/funcs/addressesCreate.d.ts

@@ -0,0 +1,17 @@
+import { ShippoSDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { AddressCreateRequest } from "../models/addresscreaterequest.js";
+import { CreateAddressResponse } from "../models/createaddressop.js";
+import { APIError } from "../models/errors/apierror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Create a new address
+ *
+ * @remarks
+ * Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.
+ */
+export declare function addressesCreate(client$: ShippoSDKCore, request: AddressCreateRequest, options?: RequestOptions): APIPromise<Result<CreateAddressResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=addressesCreate.d.ts.map

package/esm/funcs/addressesCreate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressesCreate.d.ts","sourceRoot":"","sources":["../../src/funcs/addressesCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,oBAAoB,EAErB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,qBAAqB,EAEtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,qBAAqB,EACnB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}

package/esm/funcs/addressesCreate.js

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AddressCreateRequest$zodSchema, } from "../models/addresscreaterequest.js";
+import { CreateAddressResponse$zodSchema, } from "../models/createaddressop.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Create a new address
+ *
+ * @remarks
+ * Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.
+ */
+export function addressesCreate(client$, request, options) {
+    return new APIPromise($do(client$, request, options));
+}
+async function $do(client$, request, options) {
+    const parsed$ = safeParse(request, (value$) => AddressCreateRequest$zodSchema.parse(value$), "Input validation failed");
+    if (!parsed$.ok) {
+        return [parsed$, { status: "invalid" }];
+    }
+    const payload$ = parsed$.value;
+    const body$ = encodeJSON("body", payload$, { explode: true });
+    const path$ = pathToFunc("/addresses")();
+    const headers$ = new Headers(compactMap({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+        "SHIPPO-API-VERSION": encodeSimple("SHIPPO-API-VERSION", client$._options.shippoApiVersion, { explode: false, charEncoding: "none" }),
+    }));
+    const securityInput = await extractSecurity(client$._options.security);
+    const requestSecurity = resolveGlobalSecurity(securityInput);
+    const context = {
+        options: client$._options,
+        baseURL: options?.serverURL ?? client$._baseURL ?? "",
+        operationID: "CreateAddress",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client$._options.security,
+        retryConfig: options?.retries
+            || client$._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || [
+            "429",
+            "500",
+            "502",
+            "503",
+            "504",
+        ],
+    };
+    const requestRes = client$._createRequest(context, {
+        security: requestSecurity,
+        method: "POST",
+        baseURL: options?.serverURL,
+        path: path$,
+        headers: headers$,
+        body: body$,
+        userAgent: client$._options.userAgent,
+        timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+            || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req$ = requestRes.value;
+    const doResult = await client$._do(req$, {
+        context,
+        errorCodes: [],
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req$ }];
+    }
+    const response = doResult.value;
+    const responseFields$ = {
+        HttpMeta: { Response: response, Request: req$ },
+    };
+    const [result$] = await M.match(M.json(201, CreateAddressResponse$zodSchema, { key: "Address" }), M.json(400, CreateAddressResponse$zodSchema, { key: "BadRequest" }))(response, req$, { extraFields: responseFields$ });
+    return [result$, { status: "complete", request: req$, response }];
+}
+//# sourceMappingURL=addressesCreate.js.map

package/esm/funcs/addressesCreate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressesCreate.js","sourceRoot":"","sources":["../../src/funcs/addressesCreate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAEL,8BAA8B,GAC/B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAEL,+BAA+B,GAChC,MAAM,8BAA8B,CAAC;AAUtC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAsB,EACtB,OAA6B,EAC7B,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAsB,EACtB,OAA6B,EAC7B,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,MAAM,CAAC,EACxD,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;IAEzC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,oBAAoB,EAAE,YAAY,CAChC,oBAAoB,EACpB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EACjC,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,eAAe;QAC5B,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,+BAA+B,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAChE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,+BAA+B,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CACpE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}

package/esm/funcs/addressesGet.d.ts

@@ -0,0 +1,16 @@
+import { ShippoSDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { APIError } from "../models/errors/apierror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { GetAddressRequest, GetAddressResponse } from "../models/getaddressop.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Retrieve an address
+ *
+ * @remarks
+ * Returns an existing address using an object ID.
+ */
+export declare function addressesGet(client$: ShippoSDKCore, request: GetAddressRequest, options?: RequestOptions): APIPromise<Result<GetAddressResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=addressesGet.d.ts.map

package/esm/funcs/addressesGet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressesGet.d.ts","sourceRoot":"","sources":["../../src/funcs/addressesGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,kBAAkB,EAChB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}