@polar-sh/sdk 0.40.1 → 0.40.3

package/docs/sdks/wallets/README.md

@@ -0,0 +1,256 @@
+# Wallets
+(*wallets*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List Wallets
+* [get](#get) - Get Wallet
+* [topUp](#topup) - Top-Up Wallet
+
+## list
+
+List wallets.
+
+**Scopes**: `wallets:read`
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="wallets:list" method="get" path="/v1/wallets/" -->
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.wallets.list({
+    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { walletsList } from "@polar-sh/sdk/funcs/walletsList.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await walletsList(polar, {
+    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
+    console.log(page);
+  }
+  } else {
+    console.log("walletsList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.WalletsListRequest](../../models/operations/walletslistrequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.WalletsListResponse](../../models/operations/walletslistresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get
+
+Get a wallet by ID.
+
+**Scopes**: `wallets:read`
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="wallets:get" method="get" path="/v1/wallets/{id}" -->
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.wallets.get({
+    id: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { walletsGet } from "@polar-sh/sdk/funcs/walletsGet.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await walletsGet(polar, {
+    id: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("walletsGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.WalletsGetRequest](../../models/operations/walletsgetrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.Wallet](../../models/components/wallet.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ResourceNotFound    | 404                        | application/json           |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## topUp
+
+Top-up a wallet by adding funds to its balance.
+
+The customer should have a valid payment method on file.
+
+**Scopes**: `wallets:write`
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="wallets:top_up" method="post" path="/v1/wallets/{id}/top-up" -->
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.wallets.topUp({
+    id: "<value>",
+    walletTopUpCreate: {
+      amount: 2000,
+      currency: "Venezuelan bolívar",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { walletsTopUp } from "@polar-sh/sdk/funcs/walletsTopUp.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await walletsTopUp(polar, {
+    id: "<value>",
+    walletTopUpCreate: {
+      amount: 2000,
+      currency: "Venezuelan bolívar",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("walletsTopUp failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.WalletsTopUpRequest](../../models/operations/walletstopuprequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.Wallet](../../models/components/wallet.md)\>**
+
+### Errors
+
+| Error Type                       | Status Code                      | Content Type                     |
+| -------------------------------- | -------------------------------- | -------------------------------- |
+| errors.PaymentIntentFailedError  | 400                              | application/json                 |
+| errors.MissingPaymentMethodError | 402                              | application/json                 |
+| errors.ResourceNotFound          | 404                              | application/json                 |
+| errors.HTTPValidationError       | 422                              | application/json                 |
+| errors.SDKError                  | 4XX, 5XX                         | \*/\*                            |

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@polar-sh/sdk",
-      "version": "0.40.1",
+      "version": "0.40.3",
       "dependencies": {
         "standardwebhooks": "^1.0.0",
         "zod": "^3.25.76"

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@polar-sh/sdk",
-  "version": "0.40.1",
+  "version": "0.40.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polar-sh/sdk",
-  "version": "0.40.1",
+  "version": "0.40.3",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/funcs/customerPortalBenefitGrantsList.ts

@@ -123,7 +123,6 @@ async function $do(
     "checkout_id": payload.checkout_id,
     "limit": payload.limit,
     "order_id": payload.order_id,
-    "organization_id": payload.organization_id,
     "page": payload.page,
     "sorting": payload.sorting,
     "subscription_id": payload.subscription_id,

package/src/funcs/customerPortalDownloadablesList.ts

@@ -119,7 +119,6 @@ async function $do(
   const query = encodeFormQuery({
     "benefit_id": payload.benefit_id,
     "limit": payload.limit,
-    "organization_id": payload.organization_id,
     "page": payload.page,
   });
 

package/src/funcs/customerPortalLicenseKeysList.ts

@@ -130,7 +130,6 @@ async function $do(
   const query = encodeFormQuery({
     "benefit_id": payload.benefit_id,
     "limit": payload.limit,
-    "organization_id": payload.organization_id,
     "page": payload.page,
   });
 

package/src/funcs/customerPortalOrdersList.ts

@@ -119,7 +119,6 @@ async function $do(
 
   const query = encodeFormQuery({
     "limit": payload.limit,
-    "organization_id": payload.organization_id,
     "page": payload.page,
     "product_billing_type": payload.product_billing_type,
     "product_id": payload.product_id,

package/src/funcs/customerPortalSubscriptionsList.ts

@@ -121,7 +121,6 @@ async function $do(
   const query = encodeFormQuery({
     "active": payload.active,
     "limit": payload.limit,
-    "organization_id": payload.organization_id,
     "page": payload.page,
     "product_id": payload.product_id,
     "query": payload.query,

package/src/funcs/customerPortalWalletsGet.ts

@@ -0,0 +1,205 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } from "../core.js";
+import { 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 { RequestOptions } from "../lib/sdks.js";
+import { resolveSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  CustomerWallet,
+  CustomerWallet$inboundSchema,
+} from "../models/components/customerwallet.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import { PolarError } from "../models/errors/polarerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomerPortalWalletsGetRequest,
+  CustomerPortalWalletsGetRequest$outboundSchema,
+  CustomerPortalWalletsGetSecurity,
+} from "../models/operations/customerportalwalletsget.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Wallet
+ *
+ * @remarks
+ * Get a wallet by ID for the authenticated customer.
+ *
+ * **Scopes**: `customer_portal:read` `customer_portal:write`
+ */
+export function customerPortalWalletsGet(
+  client: PolarCore,
+  security: CustomerPortalWalletsGetSecurity,
+  request: CustomerPortalWalletsGetRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    CustomerWallet,
+    | ResourceNotFound
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  security: CustomerPortalWalletsGetSecurity,
+  request: CustomerPortalWalletsGetRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      CustomerWallet,
+      | ResourceNotFound
+      | HTTPValidationError
+      | PolarError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomerPortalWalletsGetRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customer-portal/wallets/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.customerSession,
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customer_portal:wallets:get",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: 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: "GET",
+    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: ["404", "422", "4XX", "5XX"],
+    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<
+    CustomerWallet,
+    | ResourceNotFound
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, CustomerWallet$inboundSchema),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}