@factify/sdk 0.3.11 → 0.3.13-rc.1

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";

package/src/sdk/quota.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { quotaGetOrganizationQuota } from "../funcs/quotaGetOrganizationQuota.js";
+import { quotaGetUsageHistory } from "../funcs/quotaGetUsageHistory.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Quota extends ClientSDK {
+  /**
+   * Get organization quota status
+   *
+   * @remarks
+   * Returns the current quota status for an organization including usage, limits, tier, and reset date.
+   */
+  async getOrganizationQuota(
+    request?: operations.GetOrganizationQuotaRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetOrganizationQuotaResponse> {
+    return unwrapAsync(quotaGetOrganizationQuota(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get usage history
+   *
+   * @remarks
+   * Returns daily usage records for an organization within a specified date range.
+   */
+  async getUsageHistory(
+    request?: operations.GetUsageHistoryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetUsageHistoryResponse> {
+    return unwrapAsync(quotaGetUsageHistory(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -8,6 +8,7 @@ import { Documents } from "./documents.js";
 import { EntryPages } from "./entrypages.js";
 import { Organizations } from "./organizations.js";
 import { Policies } from "./policies.js";
+import { Quota } from "./quota.js";
 import { Versions } from "./versions.js";
 
 export class Factify extends ClientSDK {
@@ -40,4 +41,9 @@ export class Factify extends ClientSDK {
   get organizations(): Organizations {
     return (this._organizations ??= new Organizations(this._options));
   }
+
+  private _quota?: Quota;
+  get quota(): Quota {
+    return (this._quota ??= new Quota(this._options));
+  }
 }