@factify/sdk 0.3.12 → 0.3.13-rc.1

package/src/funcs/quotaGetUsageHistory.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { FactifyCore } from "../core.js";
+import { encodeFormQuery } 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 { FactifyError } from "../models/errors/factifyerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get usage history
+ *
+ * @remarks
+ * Returns daily usage records for an organization within a specified date range.
+ */
+export function quotaGetUsageHistory(
+  client: FactifyCore,
+  request?: operations.GetUsageHistoryRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetUsageHistoryResponse,
+    | errors.ErrorT
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FactifyCore,
+  request?: operations.GetUsageHistoryRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetUsageHistoryResponse,
+      | errors.ErrorT
+      | FactifyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.GetUsageHistoryRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1beta/quota/usage")();
+
+  const query = encodeFormQuery({
+    "end_date": payload?.end_date,
+    "organization_id": payload?.organization_id,
+    "start_date": payload?.start_date,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getUsageHistory",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    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,
+    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: ["400", "401", "403", "404", "429", "4XX", "500", "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<
+    operations.GetUsageHistoryResponse,
+    | errors.ErrorT
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetUsageHistoryResponse$inboundSchema, {
+      key: "GetUsageHistoryResponse",
+    }),
+    M.jsonErr([400, 401, 403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(429, errors.ErrorT$inboundSchema, { hdrs: true }),
+    M.jsonErr(500, errors.ErrorT$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/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.3.12",
-  genVersion: "2.795.8",
-  userAgent: "speakeasy-sdk/typescript 0.3.12 2.795.8 1.0.0 @factify/sdk",
+  sdkVersion: "0.3.13-rc.1",
+  genVersion: "2.799.0",
+  userAgent: "speakeasy-sdk/typescript 0.3.13-rc.1 2.799.0 1.0.0 @factify/sdk",
 } as const;

package/src/models/components/dailyusage.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * DailyUsage represents usage for a single day.
+ */
+export type DailyUsage = {
+  /**
+   * The date (YYYY-MM-DD format).
+   */
+  date?: string | undefined;
+  /**
+   * Request count for this day.
+   */
+  requestCount?: number | undefined;
+};
+
+/** @internal */
+export const DailyUsage$inboundSchema: z.ZodMiniType<DailyUsage, unknown> = z
+  .pipe(
+    z.object({
+      date: types.optional(types.string()),
+      request_count: types.optional(types.number()),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "request_count": "requestCount",
+      });
+    }),
+  );
+
+export function dailyUsageFromJSON(
+  jsonString: string,
+): SafeParseResult<DailyUsage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DailyUsage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DailyUsage' from JSON`,
+  );
+}

package/src/models/components/getorganizationquotaresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  OrganizationQuota,
+  OrganizationQuota$inboundSchema,
+} from "./organizationquota.js";
+
+/**
+ * GetOrganizationQuotaResponse returns the quota status.
+ */
+export type GetOrganizationQuotaResponse = {
+  /**
+   * OrganizationQuota represents the quota status for an organization.
+   */
+  quota?: OrganizationQuota | undefined;
+};
+
+/** @internal */
+export const GetOrganizationQuotaResponse$inboundSchema: z.ZodMiniType<
+  GetOrganizationQuotaResponse,
+  unknown
+> = z.object({
+  quota: types.optional(OrganizationQuota$inboundSchema),
+});
+
+export function getOrganizationQuotaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetOrganizationQuotaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetOrganizationQuotaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetOrganizationQuotaResponse' from JSON`,
+  );
+}

package/src/models/components/getusagehistoryresponse.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { DailyUsage, DailyUsage$inboundSchema } from "./dailyusage.js";
+
+/**
+ * GetUsageHistoryResponse returns usage history.
+ */
+export type GetUsageHistoryResponse = {
+  /**
+   * Daily usage records.
+   */
+  dailyUsage?: Array<DailyUsage> | undefined;
+  /**
+   * The organization ID.
+   */
+  organizationId?: string | undefined;
+  /**
+   * Total requests in the period.
+   */
+  totalRequests?: number | undefined;
+};
+
+/** @internal */
+export const GetUsageHistoryResponse$inboundSchema: z.ZodMiniType<
+  GetUsageHistoryResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    daily_usage: types.optional(z.array(DailyUsage$inboundSchema)),
+    organization_id: types.optional(types.string()),
+    total_requests: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "daily_usage": "dailyUsage",
+      "organization_id": "organizationId",
+      "total_requests": "totalRequests",
+    });
+  }),
+);
+
+export function getUsageHistoryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUsageHistoryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUsageHistoryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUsageHistoryResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -11,13 +11,16 @@ export * from "./createdocumentresponse.js";
 export * from "./createorganizationrequest.js";
 export * from "./createorganizationresponse.js";
 export * from "./createversionrequest.js";
+export * from "./dailyusage.js";
 export * from "./document.js";
 export * from "./documentpolicy.js";
 export * from "./empty.js";
 export * from "./error.js";
 export * from "./generateentrypageresponse.js";
 export * from "./getdocumentresponse.js";
+export * from "./getorganizationquotaresponse.js";
 export * from "./getorganizationresponse.js";
+export * from "./getusagehistoryresponse.js";
 export * from "./httpmetadata.js";
 export * from "./listapikeysresponse.js";
 export * from "./listdocumentpoliciesresponse.js";
@@ -25,9 +28,11 @@ export * from "./listdocumentsresponse.js";
 export * from "./listorganizationsresponse.js";
 export * from "./listversionsresponse.js";
 export * from "./organization.js";
+export * from "./organizationquota.js";
 export * from "./pagination.js";
 export * from "./policy.js";
 export * from "./processingstatus.js";
+export * from "./quotatier.js";
 export * from "./revokeapikeyresponse.js";
 export * from "./security.js";
 export * from "./updatedocumentresponse.js";

package/src/models/components/organizationquota.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { QuotaTier, QuotaTier$inboundSchema } from "./quotatier.js";
+
+/**
+ * OrganizationQuota represents the quota status for an organization.
+ */
+export type OrganizationQuota = {
+  /**
+   * Current usage in the billing period.
+   */
+  currentUsage?: number | undefined;
+  /**
+   * The effective monthly limit (considers custom_limit if set).
+   */
+  effectiveLimit?: number | undefined;
+  /**
+   * Whether quota is exceeded.
+   */
+  isExceeded?: boolean | undefined;
+  /**
+   * The organization ID.
+   *
+   * @remarks
+   *  Pattern: org_[0-9a-hjkmnp-tv-z]{26}
+   */
+  organizationId?: string | undefined;
+  /**
+   * Start of current billing period.
+   */
+  periodStart?: Date | undefined;
+  /**
+   * Remaining requests in the billing period.
+   */
+  remaining?: number | undefined;
+  /**
+   * When the quota resets (start of next billing period).
+   */
+  resetAt?: Date | undefined;
+  /**
+   * QuotaTier represents the organization's quota tier.
+   */
+  tier?: QuotaTier | undefined;
+  /**
+   * Usage as a percentage (0-100+).
+   */
+  usagePercent?: number | undefined;
+};
+
+/** @internal */
+export const OrganizationQuota$inboundSchema: z.ZodMiniType<
+  OrganizationQuota,
+  unknown
+> = z.pipe(
+  z.object({
+    current_usage: types.optional(types.number()),
+    effective_limit: types.optional(types.number()),
+    is_exceeded: types.optional(types.boolean()),
+    organization_id: types.optional(types.string()),
+    period_start: types.optional(types.date()),
+    remaining: types.optional(types.number()),
+    reset_at: types.optional(types.date()),
+    tier: types.optional(QuotaTier$inboundSchema),
+    usage_percent: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "current_usage": "currentUsage",
+      "effective_limit": "effectiveLimit",
+      "is_exceeded": "isExceeded",
+      "organization_id": "organizationId",
+      "period_start": "periodStart",
+      "reset_at": "resetAt",
+      "usage_percent": "usagePercent",
+    });
+  }),
+);
+
+export function organizationQuotaFromJSON(
+  jsonString: string,
+): SafeParseResult<OrganizationQuota, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrganizationQuota$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrganizationQuota' from JSON`,
+  );
+}

package/src/models/components/quotatier.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * QuotaTier represents the organization's quota tier.
+ */
+export const QuotaTier = {
+  QuotaTierUnspecified: "QUOTA_TIER_UNSPECIFIED",
+  QuotaTierFree: "QUOTA_TIER_FREE",
+  QuotaTierCustom: "QUOTA_TIER_CUSTOM",
+} as const;
+/**
+ * QuotaTier represents the organization's quota tier.
+ */
+export type QuotaTier = OpenEnum<typeof QuotaTier>;
+
+/** @internal */
+export const QuotaTier$inboundSchema: z.ZodMiniType<QuotaTier, unknown> =
+  openEnums.inboundSchema(QuotaTier);

package/src/models/operations/getorganizationquota.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetOrganizationQuotaRequest = {
+  /**
+   * Optional: organization ID to query. If not provided, uses the caller's organization.
+   *
+   * @remarks
+   *  Only admins can query other organizations.
+   */
+  organizationId?: string | undefined;
+};
+
+export type GetOrganizationQuotaResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * Success
+   */
+  getOrganizationQuotaResponse?:
+    | components.GetOrganizationQuotaResponse
+    | undefined;
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type GetOrganizationQuotaRequest$Outbound = {
+  organization_id?: string | undefined;
+};
+
+/** @internal */
+export const GetOrganizationQuotaRequest$outboundSchema: z.ZodMiniType<
+  GetOrganizationQuotaRequest$Outbound,
+  GetOrganizationQuotaRequest
+> = z.pipe(
+  z.object({
+    organizationId: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      organizationId: "organization_id",
+    });
+  }),
+);
+
+export function getOrganizationQuotaRequestToJSON(
+  getOrganizationQuotaRequest: GetOrganizationQuotaRequest,
+): string {
+  return JSON.stringify(
+    GetOrganizationQuotaRequest$outboundSchema.parse(
+      getOrganizationQuotaRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetOrganizationQuotaResponse$inboundSchema: z.ZodMiniType<
+  GetOrganizationQuotaResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    HttpMeta: components.HTTPMetadata$inboundSchema,
+    GetOrganizationQuotaResponse: types.optional(
+      components.GetOrganizationQuotaResponse$inboundSchema,
+    ),
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "HttpMeta": "httpMeta",
+      "GetOrganizationQuotaResponse": "getOrganizationQuotaResponse",
+      "Headers": "headers",
+    });
+  }),
+);
+
+export function getOrganizationQuotaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetOrganizationQuotaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetOrganizationQuotaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetOrganizationQuotaResponse' from JSON`,
+  );
+}

package/src/models/operations/getusagehistory.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetUsageHistoryRequest = {
+  /**
+   * Optional: organization ID to query. If not provided, uses the caller's organization.
+   */
+  organizationId?: string | undefined;
+  /**
+   * Start date for the history (inclusive, YYYY-MM-DD format).
+   */
+  startDate?: string | undefined;
+  /**
+   * End date for the history (exclusive, YYYY-MM-DD format).
+   */
+  endDate?: string | undefined;
+};
+
+export type GetUsageHistoryResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * Success
+   */
+  getUsageHistoryResponse?: components.GetUsageHistoryResponse | undefined;
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type GetUsageHistoryRequest$Outbound = {
+  organization_id?: string | undefined;
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+};
+
+/** @internal */
+export const GetUsageHistoryRequest$outboundSchema: z.ZodMiniType<
+  GetUsageHistoryRequest$Outbound,
+  GetUsageHistoryRequest
+> = z.pipe(
+  z.object({
+    organizationId: z.optional(z.string()),
+    startDate: z.optional(z.string()),
+    endDate: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      organizationId: "organization_id",
+      startDate: "start_date",
+      endDate: "end_date",
+    });
+  }),
+);
+
+export function getUsageHistoryRequestToJSON(
+  getUsageHistoryRequest: GetUsageHistoryRequest,
+): string {
+  return JSON.stringify(
+    GetUsageHistoryRequest$outboundSchema.parse(getUsageHistoryRequest),
+  );
+}
+
+/** @internal */
+export const GetUsageHistoryResponse$inboundSchema: z.ZodMiniType<
+  GetUsageHistoryResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    HttpMeta: components.HTTPMetadata$inboundSchema,
+    GetUsageHistoryResponse: types.optional(
+      components.GetUsageHistoryResponse$inboundSchema,
+    ),
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "HttpMeta": "httpMeta",
+      "GetUsageHistoryResponse": "getUsageHistoryResponse",
+      "Headers": "headers",
+    });
+  }),
+);
+
+export function getUsageHistoryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUsageHistoryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUsageHistoryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUsageHistoryResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -11,6 +11,8 @@ export * from "./detachdocumentpolicy.js";
 export * from "./generatedocumententrypage.js";
 export * from "./getdocument.js";
 export * from "./getorganization.js";
+export * from "./getorganizationquota.js";
+export * from "./getusagehistory.js";
 export * from "./getversion.js";
 export * from "./listapikeys.js";
 export * from "./listdocumentpolicies.js";