@polar-sh/sdk 0.46.6 → 0.47.0

package/src/funcs/metricsUpdateDashboard.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { PolarCore } from "../core.js";
+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 { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  MetricDashboardSchema,
+  MetricDashboardSchema$inboundSchema,
+} from "../models/components/metricdashboardschema.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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  MetricsUpdateDashboardRequest,
+  MetricsUpdateDashboardRequest$outboundSchema,
+} from "../models/operations/metricsupdatedashboard.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update Metric Dashboard
+ *
+ * @remarks
+ * Update a user-defined metric dashboard.
+ *
+ * **Scopes**: `metrics:write`
+ */
+export function metricsUpdateDashboard(
+  client: PolarCore,
+  request: MetricsUpdateDashboardRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    MetricDashboardSchema,
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: MetricsUpdateDashboardRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      MetricDashboardSchema,
+      | HTTPValidationError
+      | PolarError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => z.parse(MetricsUpdateDashboardRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.MetricDashboardUpdate, {
+    explode: true,
+  });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/metrics/dashboards/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "metrics:update_dashboard",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.accessToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    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: ["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<
+    MetricDashboardSchema,
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, MetricDashboardSchema$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 }];
+}

package/src/funcs/oauth2ClientsDelete.ts

@@ -102,7 +102,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/oauth2/register/{client_id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/oauth2ClientsGet.ts

@@ -102,7 +102,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/oauth2/register/{client_id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/oauth2ClientsUpdate.ts

@@ -104,7 +104,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/oauth2/register/{client_id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/ordersGenerateInvoice.ts

@@ -103,7 +103,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/orders/{id}/invoice")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/ordersGet.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/orders/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/ordersInvoice.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/orders/{id}/invoice")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/ordersUpdate.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/orders/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/organizationAccessTokensDelete.ts

@@ -102,7 +102,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/organization-access-tokens/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/organizationAccessTokensUpdate.ts

@@ -108,7 +108,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/organization-access-tokens/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/organizationsGet.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/organizations/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/organizationsUpdate.ts

@@ -121,7 +121,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/organizations/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/paymentsGet.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/payments/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/productsGet.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/products/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/productsUpdate.ts

@@ -119,7 +119,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/products/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/productsUpdateBenefits.ts

@@ -121,7 +121,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/products/{id}/benefits")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/subscriptionsGet.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/subscriptions/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/subscriptionsList.ts

@@ -125,6 +125,9 @@ async function $do(
     encodeFormQuery({
       "active": payload.active,
       "cancel_at_period_end": payload.cancel_at_period_end,
+      "canceled_at_after": payload.canceled_at_after,
+      "canceled_at_before": payload.canceled_at_before,
+      "customer_cancellation_reason": payload.customer_cancellation_reason,
       "customer_id": payload.customer_id,
       "discount_id": payload.discount_id,
       "external_customer_id": payload.external_customer_id,

package/src/funcs/subscriptionsRevoke.ts

@@ -125,7 +125,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/subscriptions/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/subscriptionsUpdate.ts

@@ -133,7 +133,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/subscriptions/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/webhooksDeleteWebhookEndpoint.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/webhooks/endpoints/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/webhooksGetWebhookEndpoint.ts

@@ -113,7 +113,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/webhooks/endpoints/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/webhooksRedeliverWebhookEvent.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/webhooks/events/{id}/redeliver")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/webhooksResetWebhookEndpointSecret.ts

@@ -114,7 +114,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/webhooks/endpoints/{id}/secret")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/webhooksUpdateWebhookEndpoint.ts

@@ -116,7 +116,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v1/webhooks/endpoints/{id}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/lib/config.ts

@@ -64,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.46.6",
-  genVersion: "2.866.2",
-  userAgent: "speakeasy-sdk/typescript 0.46.6 2.866.2 0.1.0 @polar-sh/sdk",
+  sdkVersion: "0.47.0",
+  genVersion: "2.879.6",
+  userAgent: "speakeasy-sdk/typescript 0.47.0 2.879.6 0.1.0 @polar-sh/sdk",
 } as const;

package/src/lib/encodings.ts

@@ -479,6 +479,23 @@ export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited);
 export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited);
 export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject);
 
+function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const tag = val[Symbol.toStringTag];
+  if (tag !== "Blob" && tag !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}
+
 export function appendForm(
   fd: FormData,
   key: string,
@@ -487,10 +504,12 @@ export function appendForm(
 ): void {
   if (value == null) {
     return;
-  } else if (value instanceof Blob && fileName) {
-    fd.append(key, value, fileName);
-  } else if (value instanceof Blob) {
-    fd.append(key, value);
+  } else if (isBlobLike(value)) {
+    if (fileName) {
+      fd.append(key, value as Blob, fileName);
+    } else {
+      fd.append(key, value as Blob);
+    }
   } else {
     fd.append(key, String(value));
   }

package/src/lib/sdks.ts

@@ -128,13 +128,15 @@ export class ClientSDK {
     if (!base) {
       return ERR(new InvalidRequestError("No base URL provided for operation"));
     }
-    const reqURL = new URL(base);
-    const inputURL = new URL(path, reqURL);
-
+    const baseURL = new URL(base);
+    let reqURL: URL;
     if (path) {
-      reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/";
-      reqURL.pathname += inputURL.pathname.replace(/^\/+/, "");
+      baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/";
+      reqURL = new URL(path, baseURL);
+    } else {
+      reqURL = baseURL;
     }
+    reqURL.hash = "";
 
     let finalQuery = query || "";
 

package/src/lib/security.ts

@@ -240,8 +240,9 @@ function applyBearer(
 
 export function resolveGlobalSecurity(
   security: Partial<Security> | null | undefined,
+  allowedFields?: number[],
 ): SecurityState | null {
-  return resolveSecurity(
+  let inputs: SecurityInput[][] = [
     [
       {
         fieldName: "Authorization",
@@ -249,7 +250,18 @@ export function resolveGlobalSecurity(
         value: security?.accessToken ?? env().POLAR_ACCESS_TOKEN,
       },
     ],
-  );
+  ];
+
+  if (allowedFields) {
+    inputs = allowedFields.map((i) => {
+      if (i < 0 || i >= inputs.length) {
+        throw new RangeError(`invalid allowedFields index ${i}`);
+      }
+      return inputs[i]!;
+    });
+  }
+
+  return resolveSecurity(...inputs);
 }
 
 export async function extractSecurity<

package/src/lib/url.ts

@@ -13,21 +13,23 @@ export function pathToFunc(
   const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
-    return pathPattern.replace(paramRE, function (_, placeholder) {
-      if (!hasOwn.call(params, placeholder)) {
-        throw new Error(`Parameter '${placeholder}' is required`);
-      }
+    return pathPattern
+      .replace(paramRE, function (_, placeholder) {
+        if (!hasOwn.call(params, placeholder)) {
+          throw new Error(`Parameter '${placeholder}' is required`);
+        }
 
-      const value = params[placeholder];
-      if (typeof value !== "string" && typeof value !== "number") {
-        throw new Error(
-          `Parameter '${placeholder}' must be a string or number`,
-        );
-      }
+        const value = params[placeholder];
+        if (typeof value !== "string" && typeof value !== "number") {
+          throw new Error(
+            `Parameter '${placeholder}' must be a string or number`,
+          );
+        }
 
-      return options?.charEncoding === "percent"
-        ? encodeURIComponent(`${value}`)
-        : `${value}`;
-    });
+        return options?.charEncoding === "percent"
+          ? encodeURIComponent(`${value}`)
+          : `${value}`;
+      })
+      .replace(/^\/+/, "");
   };
 }

package/src/models/components/availablescope.ts

@@ -55,6 +55,7 @@ export const AvailableScope = {
   RefundsWrite: "refunds:write",
   PaymentsRead: "payments:read",
   MetricsRead: "metrics:read",
+  MetricsWrite: "metrics:write",
   WebhooksRead: "webhooks:read",
   WebhooksWrite: "webhooks:write",
   LicenseKeysRead: "license_keys:read",

package/src/models/components/benefitgrant.ts

@@ -101,9 +101,6 @@ export type BenefitGrant = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   benefit: Benefit;

package/src/models/components/benefitgrantcustomwebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantCustomWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   /**

package/src/models/components/benefitgrantdiscordwebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantDiscordWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   /**

package/src/models/components/benefitgrantdownloadableswebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantDownloadablesWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   benefit: BenefitDownloadables;

package/src/models/components/benefitgrantfeatureflagwebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantFeatureFlagWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   /**

package/src/models/components/benefitgrantgithubrepositorywebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantGitHubRepositoryWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   /**

package/src/models/components/benefitgrantlicensekeyswebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantLicenseKeysWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   benefit: BenefitLicenseKeys;

package/src/models/components/benefitgrantmetercreditwebhook.ts

@@ -91,9 +91,6 @@ export type BenefitGrantMeterCreditWebhook = {
    * The error information if the benefit grant failed with an unrecoverable error.
    */
   error?: BenefitGrantError | null | undefined;
-  /**
-   * A customer in an organization.
-   */
   customer: Customer;
   member?: Member | null | undefined;
   /**