@volter/twin-polar 2.0.37 → 3.0.0

package/spec/doc-examples.json

@@ -0,0 +1,681 @@
+[
+  {
+    "title": "Production product list",
+    "source": "https://polar.sh/docs/api-reference/introduction",
+    "operation": "products:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/products/"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body."
+  },
+  {
+    "title": "Sandbox product list",
+    "source": "https://polar.sh/docs/api-reference/introduction",
+    "operation": "products:list",
+    "request": {
+      "method": "GET",
+      "url": "https://sandbox-api.polar.sh/v1/products/"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body."
+  },
+  {
+    "title": "SDK checkout",
+    "source": "https://polar.sh/docs/features/checkout/session",
+    "operation": "checkouts:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body.",
+    "input": {
+      "products": [
+        "productId"
+      ]
+    },
+    "placeholders": {
+      "names": [
+        "productId"
+      ],
+      "quote": "For this you'll need at least your Product ID."
+    }
+  },
+  {
+    "title": "Ad-hoc checkout",
+    "source": "https://polar.sh/docs/features/checkout/session",
+    "operation": "checkouts:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body.",
+    "input": {
+      "products": [
+        "productId"
+      ],
+      "prices": {
+        "productId": [
+          {
+            "amount_type": "fixed",
+            "price_amount": 10000,
+            "price_currency": "usd"
+          }
+        ]
+      }
+    },
+    "placeholders": {
+      "names": [
+        "productId"
+      ],
+      "quote": "For this you'll need at least your Product ID."
+    }
+  },
+  {
+    "title": "Authenticated portal link",
+    "source": "https://polar.sh/docs/features/customer-portal/navigate-customers",
+    "operation": "customer-sessions:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/customer-sessions/"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body.",
+    "input": {
+      "customer_id": "<value>"
+    }
+  },
+  {
+    "title": "SDK ingestion",
+    "source": "https://polar.sh/docs/features/usage-based-billing/event-ingestion",
+    "operation": "events:ingest",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/events/ingest"
+    },
+    "output": {},
+    "means": "Published request; this page publishes no response body.",
+    "input": {
+      "events": [
+        {
+          "name": "<value>",
+          "external_customer_id": "<id>",
+          "metadata": {
+            "key": "value"
+          }
+        }
+      ]
+    }
+  },
+  {
+    "title": "OpenAPI SDK subscriptions:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "subscriptions:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/subscriptions/?page=1&limit=10&sorting=-started_at"
+    },
+    "output": {},
+    "means": "List Subscriptions. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.subscriptions.iter_list(\n    page=1,\n    limit=10,\n    sorting=['-started_at'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.subscriptions.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-started_at\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK webhooks:list_webhook_endpoints",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "webhooks:list_webhook_endpoints",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/webhooks/endpoints?page=1&limit=10"
+    },
+    "output": {},
+    "means": "List Webhook Endpoints. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.webhooks.iter_list_webhook_endpoints(\n    page=1,\n    limit=10,\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.webhooks.iterListWebhookEndpoints(\n  {\n    \"page\": 1,\n    \"limit\": 10\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK webhooks:create_webhook_endpoint",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "webhooks:create_webhook_endpoint",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/webhooks/endpoints"
+    },
+    "output": {},
+    "means": "Create Webhook Endpoint. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.webhooks.create_webhook_endpoint(\n    url='https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',\n    format='raw',\n    events=['checkout.created'],\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.webhooks.createWebhookEndpoint(\n  {\n    \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n    \"format\": \"raw\",\n    \"events\": [\n      \"checkout.created\"\n    ]\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
+      "format": "raw",
+      "events": [
+        "checkout.created"
+      ]
+    }
+  },
+  {
+    "title": "OpenAPI SDK products:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "products:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/products/?page=1&limit=10&sorting=-created_at"
+    },
+    "output": {},
+    "means": "List Products. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.products.iter_list(\n    page=1,\n    limit=10,\n    sorting=['-created_at'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.products.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-created_at\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK products:create",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "products:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/products/"
+    },
+    "output": {},
+    "means": "Create Product. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.products.create(\n    name='string',\n    prices=[{'amount_type': 'fixed', 'price_amount': 0}],\n    recurring_interval='day',\n    recurring_interval_count=1,\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.products.create(\n  {\n    \"name\": \"string\",\n    \"prices\": [\n      {\n        \"amount_type\": \"fixed\",\n        \"price_amount\": 0\n      }\n    ],\n    \"recurring_interval\": \"day\",\n    \"recurring_interval_count\": 1\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "name": "string",
+      "prices": [
+        {
+          "amount_type": "fixed",
+          "price_amount": 0
+        }
+      ],
+      "recurring_interval": "day",
+      "recurring_interval_count": 1
+    }
+  },
+  {
+    "title": "OpenAPI SDK orders:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "orders:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/orders/?page=1&limit=10&sorting=-created_at"
+    },
+    "output": {},
+    "means": "List Orders. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.orders.iter_list(\n    page=1,\n    limit=10,\n    sorting=['-created_at'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.orders.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-created_at\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK checkouts:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "checkouts:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/checkouts/?page=1&limit=10&sorting=-created_at"
+    },
+    "output": {},
+    "means": "List Checkout Sessions. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.checkouts.iter_list(\n    page=1,\n    limit=10,\n    sorting=['-created_at'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.checkouts.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-created_at\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK checkouts:create",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "checkouts:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/"
+    },
+    "output": {},
+    "means": "Create Checkout Session. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.checkouts.create(\n    allow_discount_codes=True,\n    require_billing_address=False,\n    allow_trial=True,\n    is_business_customer=False,\n    products=['00000000-0000-4000-8000-000000000000'],\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.checkouts.create(\n  {\n    \"allow_discount_codes\": true,\n    \"require_billing_address\": false,\n    \"allow_trial\": true,\n    \"is_business_customer\": false,\n    \"products\": [\n      \"00000000-0000-4000-8000-000000000000\"\n    ]\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "allow_discount_codes": true,
+      "require_billing_address": false,
+      "allow_trial": true,
+      "is_business_customer": false,
+      "products": [
+        "00000000-0000-4000-8000-000000000000"
+      ]
+    }
+  },
+  {
+    "title": "OpenAPI SDK checkouts:get",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "checkouts:get",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/checkouts/00000000-0000-4000-8000-000000000000"
+    },
+    "output": {},
+    "means": "Get Checkout Session. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.checkouts.get(\n    '00000000-0000-4000-8000-000000000000',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.checkouts.get(\n  \"00000000-0000-4000-8000-000000000000\",\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK checkouts:client_get",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "checkouts:client_get",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/checkouts/client/string"
+    },
+    "output": {},
+    "means": "Get Checkout Session from Client. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.checkouts.client_get(\n    'string',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.checkouts.clientGet(\n  \"string\",\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK checkouts:client_confirm",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "checkouts:client_confirm",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/client/string/confirm"
+    },
+    "output": {},
+    "means": "Confirm Checkout Session from Client. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.checkouts.client_confirm(\n    'string',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.checkouts.clientConfirm(\n  \"string\",\n  {},\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK customers:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "customers:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/customers/?page=1&limit=10&sorting=-created_at"
+    },
+    "output": {},
+    "means": "List Customers. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.customers.iter_list(\n    page=1,\n    limit=10,\n    sorting=['-created_at'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.customers.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-created_at\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK customers:create",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "customers:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/customers/"
+    },
+    "output": {},
+    "means": "Create Customer. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.customers.create(\n    external_id='usr_1337',\n    type='individual',\n    email='customer@example.com',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.customers.create(\n  {\n    \"external_id\": \"usr_1337\",\n    \"type\": \"individual\",\n    \"email\": \"customer@example.com\"\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "external_id": "usr_1337",
+      "type": "individual",
+      "email": "customer@example.com"
+    }
+  },
+  {
+    "title": "OpenAPI SDK customers:get",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "customers:get",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/customers/00000000-0000-4000-8000-000000000000"
+    },
+    "output": {},
+    "means": "Get Customer. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.customers.get(\n    '00000000-0000-4000-8000-000000000000',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.customers.get(\n  \"00000000-0000-4000-8000-000000000000\",\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK customers:get_state_external",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "customers:get_state_external",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/customers/external/string/state"
+    },
+    "output": {},
+    "means": "Get Customer State by External ID. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.customers.get_state_external(\n    'string',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.customers.getStateExternal(\n  \"string\",\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK customer-sessions:create",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "customer-sessions:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/customer-sessions/"
+    },
+    "output": {},
+    "means": "Create Customer Session. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.customer_sessions.create(\n    return_url='https://example.com/account',\n    customer_id='00000000-0000-4000-8000-000000000000',\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.customerSessions.create(\n  {\n    \"return_url\": \"https://example.com/account\",\n    \"customer_id\": \"00000000-0000-4000-8000-000000000000\"\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "return_url": "https://example.com/account",
+      "customer_id": "00000000-0000-4000-8000-000000000000"
+    }
+  },
+  {
+    "title": "OpenAPI SDK events:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "events:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/events/?page=1&limit=10&sorting=-timestamp"
+    },
+    "output": {},
+    "means": "List Events. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.events.list(\n    page=1,\n    limit=10,\n    sorting=['-timestamp'],\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.events.list(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"-timestamp\"\n    ]\n  },\n);\nconsole.log(response);\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK events:ingest",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "events:ingest",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/events/ingest"
+    },
+    "output": {},
+    "means": "Ingest Events. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.events.ingest(\n    events=[{'name': 'string',\n      'customer_id': '00000000-0000-4000-8000-000000000000'}],\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.events.ingest(\n  {\n    \"events\": [\n      {\n        \"name\": \"string\",\n        \"customer_id\": \"00000000-0000-4000-8000-000000000000\"\n      }\n    ]\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "events": [
+        {
+          "name": "string",
+          "customer_id": "00000000-0000-4000-8000-000000000000"
+        }
+      ]
+    }
+  },
+  {
+    "title": "OpenAPI SDK meters:list",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "meters:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/meters/?page=1&limit=10&sorting=name"
+    },
+    "output": {},
+    "means": "List Meters. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.meters.iter_list(\n    page=1,\n    limit=10,\n    sorting=['name'],\n):\n    print(item)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.meters.iterList(\n  {\n    \"page\": 1,\n    \"limit\": 10,\n    \"sorting\": [\n      \"name\"\n    ]\n  },\n)) {\n  console.log(item);\n}\n"
+      }
+    ]
+  },
+  {
+    "title": "OpenAPI SDK meters:create",
+    "source": "https://polar.sh/docs/openapi.json",
+    "operation": "meters:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/meters/"
+    },
+    "output": {},
+    "means": "Create Meter. Both SDK spellings issue the same first-page wire request.",
+    "spellings": [
+      {
+        "lang": "Python (New SDK)",
+        "source": "from polar.v2026_04 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.meters.create(\n    name='string',\n    filter={'conjunction': 'and',\n     'clauses': [{'property': 'string',\n                  'operator': 'eq',\n                  'value': 'string'}]},\n    aggregation={'func': 'count'},\n)\nprint(response)\n"
+      },
+      {
+        "lang": "TypeScript (New SDK)",
+        "source": "import { createPolar } from \"@polar-sh/sdk/2026-04\";\n\nconst polar = createPolar({\n  accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.meters.create(\n  {\n    \"name\": \"string\",\n    \"filter\": {\n      \"conjunction\": \"and\",\n      \"clauses\": [\n        {\n          \"property\": \"string\",\n          \"operator\": \"eq\",\n          \"value\": \"string\"\n        }\n      ]\n    },\n    \"aggregation\": {\n      \"func\": \"count\"\n    }\n  },\n);\nconsole.log(response);\n"
+      }
+    ],
+    "input": {
+      "name": "string",
+      "filter": {
+        "conjunction": "and",
+        "clauses": [
+          {
+            "property": "string",
+            "operator": "eq",
+            "value": "string"
+          }
+        ]
+      },
+      "aggregation": {
+        "func": "count"
+      }
+    }
+  },
+  {
+    "title": "API overview external customer state",
+    "source": "https://polar.sh/docs/api-reference/introduction",
+    "operation": "customers:get_state_external",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/customers/external/customer_external_id/state"
+    },
+    "output": {},
+    "means": "Published SDK/HTTP request; no literal response body is published."
+  },
+  {
+    "title": "Forward the connecting customer IP",
+    "source": "https://polar.sh/docs/features/checkout/session",
+    "operation": "checkouts:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/"
+    },
+    "output": {},
+    "means": "Published SDK/HTTP request; no literal response body is published.",
+    "input": {
+      "products": [
+        "productId"
+      ],
+      "customer_ip_address": "<client_ip>"
+    },
+    "placeholders": {
+      "names": [
+        "productId",
+        "<client_ip>"
+      ],
+      "quote": "forward the customer's IP address as customer_ip_address in the request body"
+    }
+  },
+  {
+    "title": "Python checkout legacy product_id spelling",
+    "source": "https://polar.sh/docs/features/checkout/session",
+    "operation": "checkouts:create",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/checkouts/"
+    },
+    "output": {},
+    "means": "Published SDK/HTTP request; no literal response body is published.",
+    "input": {
+      "allow_discount_codes": true,
+      "product_id": "<value>"
+    },
+    "status": 201
+  },
+  {
+    "title": "Concrete ai_usage event",
+    "source": "https://polar.sh/docs/features/usage-based-billing/event-ingestion",
+    "operation": "events:ingest",
+    "request": {
+      "method": "POST",
+      "url": "https://api.polar.sh/v1/events/ingest"
+    },
+    "output": {},
+    "means": "Published SDK/HTTP request; no literal response body is published.",
+    "input": {
+      "events": [
+        {
+          "name": "ai_usage",
+          "external_customer_id": "cus_123",
+          "metadata": {
+            "model": "gpt-4.1-nano",
+            "requests": 1,
+            "total_tokens": 77,
+            "request_tokens": 58,
+            "response_tokens": 19
+          }
+        }
+      ]
+    }
+  },
+  {
+    "title": "Paged product request and 250-product illustration",
+    "source": "https://polar.sh/docs/api-reference/introduction",
+    "operation": "products:list",
+    "request": {
+      "method": "GET",
+      "url": "https://api.polar.sh/v1/products/?page=1&limit=100"
+    },
+    "output": {},
+    "means": "total_count=250 indicates there are 250 total products; limit=100 means each page contains up to100 products; max_page=3 means three pages. The displayed JSON uses ellipses and is an abridged illustration."
+  }
+]