@polar-sh/sdk 0.27.0 → 0.28.0

package/src/funcs/customersDeleteExternal.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomersDeleteExternalRequest,
+  CustomersDeleteExternalRequest$outboundSchema,
+} from "../models/operations/customersdeleteexternal.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Delete Customer by External ID
+ *
+ * @remarks
+ * Delete a customer by external ID.
+ *
+ * Immediately cancels any active subscriptions and revokes any active benefits.
+ *
+ * **Scopes**: `customers:write`
+ */
+export function customersDeleteExternal(
+  client: PolarCore,
+  request: CustomersDeleteExternalRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    void,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: CustomersDeleteExternalRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      void,
+      | ResourceNotFound
+      | HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomersDeleteExternalRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    external_id: encodeSimple("external_id", payload.external_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customers/external/{external_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customers:delete_external",
+    oAuth2Scopes: [],
+
+    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: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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<
+    void,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.nil(204, z.void()),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/customersGetExternal.ts

@@ -0,0 +1,189 @@
+/*
+ * 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 { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  Customer,
+  Customer$inboundSchema,
+} from "../models/components/customer.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomersGetExternalRequest,
+  CustomersGetExternalRequest$outboundSchema,
+} from "../models/operations/customersgetexternal.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Customer by External ID
+ *
+ * @remarks
+ * Get a customer by external ID.
+ *
+ * **Scopes**: `customers:read` `customers:write`
+ */
+export function customersGetExternal(
+  client: PolarCore,
+  request: CustomersGetExternalRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Customer,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: CustomersGetExternalRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Customer,
+      | ResourceNotFound
+      | HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomersGetExternalRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    external_id: encodeSimple("external_id", payload.external_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customers/external/{external_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customers:get_external",
+    oAuth2Scopes: [],
+
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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<
+    Customer,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, Customer$inboundSchema),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/customersList.ts

@@ -225,7 +225,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/customersUpdateExternal.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  Customer,
+  Customer$inboundSchema,
+} from "../models/components/customer.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomersUpdateExternalRequest,
+  CustomersUpdateExternalRequest$outboundSchema,
+} from "../models/operations/customersupdateexternal.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update Customer by External ID
+ *
+ * @remarks
+ * Update a customer by external ID.
+ *
+ * **Scopes**: `customers:write`
+ */
+export function customersUpdateExternal(
+  client: PolarCore,
+  request: CustomersUpdateExternalRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Customer,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: CustomersUpdateExternalRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Customer,
+      | ResourceNotFound
+      | HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomersUpdateExternalRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.CustomerUpdate, { explode: true });
+
+  const pathParams = {
+    external_id: encodeSimple("external_id", payload.external_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customers/external/{external_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 = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customers:update_external",
+    oAuth2Scopes: [],
+
+    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,
+    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<
+    Customer,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, Customer$inboundSchema),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/discountsList.ts

@@ -215,7 +215,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/eventsList.ts

@@ -228,7 +228,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/externalOrganizationsList.ts

@@ -218,7 +218,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/filesList.ts

@@ -214,7 +214,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/licenseKeysList.ts

@@ -232,7 +232,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/metersEvents.ts

@@ -228,7 +228,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/metersList.ts

@@ -224,7 +224,7 @@ async function $do(
     const page = request?.page ?? 1;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
-    if (numPages == null || numPages <= page) {
+    if (typeof numPages !== "number" || numPages <= page) {
       return { next: () => null };
     }
 

package/src/funcs/metersQuantities.ts

@@ -115,7 +115,7 @@ async function $do(
   const query = encodeFormQuery({
     "customer_id": payload.customer_id,
     "end_timestamp": payload.end_timestamp,
-    "exernal_customer_id": payload.exernal_customer_id,
+    "external_customer_id": payload.external_customer_id,
     "interval": payload.interval,
     "start_timestamp": payload.start_timestamp,
   });

package/src/funcs/metricsGet.ts

@@ -40,6 +40,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get metrics about your orders and subscriptions.
  *
+ * Currency values are output in cents.
+ *
  * **Scopes**: `metrics:read`
  */
 export function metricsGet(

package/src/funcs/oauth2Authorize.ts

@@ -26,9 +26,6 @@ import { Result } from "../types/fp.js";
 
 /**
  * Authorize
- *
- * @remarks
- * **Scopes**:
  */
 export function oauth2Authorize(
   client: PolarCore,

package/src/funcs/oauth2ClientsCreate.ts

@@ -36,8 +36,6 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Create an OAuth2 client.
- *
- * **Scopes**:
  */
 export function oauth2ClientsCreate(
   client: PolarCore,

package/src/funcs/oauth2ClientsDelete.ts

@@ -36,8 +36,6 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Delete an OAuth2 client.
- *
- * **Scopes**:
  */
 export function oauth2ClientsDelete(
   client: PolarCore,