@polar-sh/sdk 0.22.2 → 0.24.0

package/src/funcs/metersQuantities.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } from "../core.js";
+import { encodeFormQuery, 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 {
+  MeterQuantities,
+  MeterQuantities$inboundSchema,
+} from "../models/components/meterquantities.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 {
+  MetersQuantitiesRequest,
+  MetersQuantitiesRequest$outboundSchema,
+} from "../models/operations/metersquantities.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Meter Quantities
+ *
+ * @remarks
+ * Get quantities of a meter over a time period.
+ */
+export async function metersQuantities(
+  client: PolarCore,
+  request: MetersQuantitiesRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    MeterQuantities,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => MetersQuantitiesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/meters/{id}/quantities")(pathParams);
+
+  const query = encodeFormQuery({
+    "customer_id": payload.customer_id,
+    "end_timestamp": payload.end_timestamp,
+    "exernal_customer_id": payload.exernal_customer_id,
+    "interval": payload.interval,
+    "start_timestamp": payload.start_timestamp,
+  });
+
+  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 = {
+    operationID: "meters:quantities",
+    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,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  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;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    MeterQuantities,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, MeterQuantities$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;
+  }
+
+  return result;
+}

package/src/funcs/metersUpdate.ts

@@ -0,0 +1,155 @@
+/*
+ * 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 { Meter, Meter$inboundSchema } from "../models/components/meter.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 {
+  MetersUpdateRequest,
+  MetersUpdateRequest$outboundSchema,
+} from "../models/operations/metersupdate.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update Meter
+ *
+ * @remarks
+ * Update a meter.
+ */
+export async function metersUpdate(
+  client: PolarCore,
+  request: MetersUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    Meter,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => MetersUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.MeterUpdate, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/meters/{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 = {
+    operationID: "meters:update",
+    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;
+  }
+  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;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    Meter,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, Meter$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;
+  }
+
+  return result;
+}

package/src/lib/config.ts

@@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.22.2",
-  genVersion: "2.497.8",
-  userAgent: "speakeasy-sdk/typescript 0.22.2 2.497.8 0.1.0 @polar-sh/sdk",
+  sdkVersion: "0.24.0",
+  genVersion: "2.503.2",
+  userAgent: "speakeasy-sdk/typescript 0.24.0 2.503.2 0.1.0 @polar-sh/sdk",
 } as const;

package/src/lib/retries.ts

@@ -158,7 +158,6 @@ async function retryBackoff(
   const start = Date.now();
   let x = 0;
 
-  // eslint-disable-next-line no-constant-condition
   while (true) {
     try {
       const res = await fn();

package/src/models/components/countaggregation.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CountAggregation = {
+  func?: "count" | undefined;
+};
+
+/** @internal */
+export const CountAggregation$inboundSchema: z.ZodType<
+  CountAggregation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  func: z.literal("count").default("count"),
+});
+
+/** @internal */
+export type CountAggregation$Outbound = {
+  func: "count";
+};
+
+/** @internal */
+export const CountAggregation$outboundSchema: z.ZodType<
+  CountAggregation$Outbound,
+  z.ZodTypeDef,
+  CountAggregation
+> = z.object({
+  func: z.literal("count").default("count" as const),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CountAggregation$ {
+  /** @deprecated use `CountAggregation$inboundSchema` instead. */
+  export const inboundSchema = CountAggregation$inboundSchema;
+  /** @deprecated use `CountAggregation$outboundSchema` instead. */
+  export const outboundSchema = CountAggregation$outboundSchema;
+  /** @deprecated use `CountAggregation$Outbound` instead. */
+  export type Outbound = CountAggregation$Outbound;
+}
+
+export function countAggregationToJSON(
+  countAggregation: CountAggregation,
+): string {
+  return JSON.stringify(
+    CountAggregation$outboundSchema.parse(countAggregation),
+  );
+}
+
+export function countAggregationFromJSON(
+  jsonString: string,
+): SafeParseResult<CountAggregation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CountAggregation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CountAggregation' from JSON`,
+  );
+}

package/src/models/components/event.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EventSource,
+  EventSource$inboundSchema,
+  EventSource$outboundSchema,
+} from "./eventsource.js";
+
+export type EventMetadata = string | number | boolean;
+
+export type Event = {
+  metadata: { [k: string]: string | number | boolean };
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp: Date;
+  /**
+   * The name of the event.
+   */
+  name: string;
+  source: EventSource;
+  /**
+   * The ID of the organization owning the event.
+   */
+  organizationId: string;
+  /**
+   * ID of the customer in your Polar organization associated with the event.
+   */
+  customerId: string | null;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string | null;
+};
+
+/** @internal */
+export const EventMetadata$inboundSchema: z.ZodType<
+  EventMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type EventMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const EventMetadata$outboundSchema: z.ZodType<
+  EventMetadata$Outbound,
+  z.ZodTypeDef,
+  EventMetadata
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventMetadata$ {
+  /** @deprecated use `EventMetadata$inboundSchema` instead. */
+  export const inboundSchema = EventMetadata$inboundSchema;
+  /** @deprecated use `EventMetadata$outboundSchema` instead. */
+  export const outboundSchema = EventMetadata$outboundSchema;
+  /** @deprecated use `EventMetadata$Outbound` instead. */
+  export type Outbound = EventMetadata$Outbound;
+}
+
+export function eventMetadataToJSON(eventMetadata: EventMetadata): string {
+  return JSON.stringify(EventMetadata$outboundSchema.parse(eventMetadata));
+}
+
+export function eventMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
+  .object({
+    metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+    id: z.string(),
+    timestamp: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    name: z.string(),
+    source: EventSource$inboundSchema,
+    organization_id: z.string(),
+    customer_id: z.nullable(z.string()),
+    external_customer_id: z.nullable(z.string()),
+  }).transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+      "customer_id": "customerId",
+      "external_customer_id": "externalCustomerId",
+    });
+  });
+
+/** @internal */
+export type Event$Outbound = {
+  metadata: { [k: string]: string | number | boolean };
+  id: string;
+  timestamp: string;
+  name: string;
+  source: string;
+  organization_id: string;
+  customer_id: string | null;
+  external_customer_id: string | null;
+};
+
+/** @internal */
+export const Event$outboundSchema: z.ZodType<
+  Event$Outbound,
+  z.ZodTypeDef,
+  Event
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  id: z.string(),
+  timestamp: z.date().transform(v => v.toISOString()),
+  name: z.string(),
+  source: EventSource$outboundSchema,
+  organizationId: z.string(),
+  customerId: z.nullable(z.string()),
+  externalCustomerId: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    customerId: "customer_id",
+    externalCustomerId: "external_customer_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Event$ {
+  /** @deprecated use `Event$inboundSchema` instead. */
+  export const inboundSchema = Event$inboundSchema;
+  /** @deprecated use `Event$outboundSchema` instead. */
+  export const outboundSchema = Event$outboundSchema;
+  /** @deprecated use `Event$Outbound` instead. */
+  export type Outbound = Event$Outbound;
+}
+
+export function eventToJSON(event: Event): string {
+  return JSON.stringify(Event$outboundSchema.parse(event));
+}
+
+export function eventFromJSON(
+  jsonString: string,
+): SafeParseResult<Event, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event' from JSON`,
+  );
+}