@factify/sdk 0.3.12 → 0.3.13-rc.1

package/openapi.json

@@ -479,6 +479,27 @@
         "title": "CreateVersionRequest",
         "type": "object"
       },
+      "DailyUsage": {
+        "additionalProperties": false,
+        "description": "DailyUsage represents usage for a single day.",
+        "properties": {
+          "date": {
+            "description": "The date (YYYY-MM-DD format).",
+            "example": "2026-01-15",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+            "title": "date",
+            "type": "string"
+          },
+          "request_count": {
+            "description": "Request count for this day.",
+            "format": "int32",
+            "title": "request_count",
+            "type": "integer"
+          }
+        },
+        "title": "DailyUsage",
+        "type": "object"
+      },
       "DetachPolicyRequest": {
         "additionalProperties": false,
         "description": "DetachPolicyRequest identifies a policy to detach from a document.",
@@ -730,6 +751,35 @@
         "title": "GetDocumentResponse",
         "type": "object"
       },
+      "GetOrganizationQuotaRequest": {
+        "additionalProperties": false,
+        "description": "GetOrganizationQuotaRequest is a request to get quota status.",
+        "properties": {
+          "organization_id": {
+            "description": "Optional: organization ID to query. If not provided, uses the caller's organization.\n Only admins can query other organizations.",
+            "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+            "nullable": true,
+            "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+            "title": "organization_id",
+            "type": "string"
+          }
+        },
+        "title": "GetOrganizationQuotaRequest",
+        "type": "object"
+      },
+      "GetOrganizationQuotaResponse": {
+        "additionalProperties": false,
+        "description": "GetOrganizationQuotaResponse returns the quota status.",
+        "properties": {
+          "quota": {
+            "$ref": "#/components/schemas/OrganizationQuota",
+            "description": "The organization's quota status.",
+            "title": "quota"
+          }
+        },
+        "title": "GetOrganizationQuotaResponse",
+        "type": "object"
+      },
       "GetOrganizationRequest": {
         "additionalProperties": false,
         "description": "GetOrganizationRequest identifies an organization to retrieve.",
@@ -763,6 +813,69 @@
         "title": "GetOrganizationResponse",
         "type": "object"
       },
+      "GetUsageHistoryRequest": {
+        "additionalProperties": false,
+        "description": "GetUsageHistoryRequest is a request to get usage history.\ndate_range_valid // end_date must be after start_date\n",
+        "properties": {
+          "end_date": {
+            "description": "End date for the history (exclusive, YYYY-MM-DD format).",
+            "example": "2026-02-01",
+            "maxLength": 10,
+            "minLength": 10,
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+            "title": "end_date",
+            "type": "string"
+          },
+          "organization_id": {
+            "description": "Optional: organization ID to query. If not provided, uses the caller's organization.",
+            "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+            "nullable": true,
+            "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+            "title": "organization_id",
+            "type": "string"
+          },
+          "start_date": {
+            "description": "Start date for the history (inclusive, YYYY-MM-DD format).",
+            "example": "2026-01-01",
+            "maxLength": 10,
+            "minLength": 10,
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+            "title": "start_date",
+            "type": "string"
+          }
+        },
+        "title": "GetUsageHistoryRequest",
+        "type": "object"
+      },
+      "GetUsageHistoryResponse": {
+        "additionalProperties": false,
+        "description": "GetUsageHistoryResponse returns usage history.",
+        "properties": {
+          "daily_usage": {
+            "description": "Daily usage records.",
+            "items": {
+              "$ref": "#/components/schemas/DailyUsage"
+            },
+            "title": "daily_usage",
+            "type": "array"
+          },
+          "organization_id": {
+            "description": "The organization ID.",
+            "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+            "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+            "title": "organization_id",
+            "type": "string"
+          },
+          "total_requests": {
+            "description": "Total requests in the period.",
+            "format": "int32",
+            "title": "total_requests",
+            "type": "integer"
+          }
+        },
+        "title": "GetUsageHistoryResponse",
+        "type": "object"
+      },
       "GetVersionRequest": {
         "additionalProperties": false,
         "description": "GetVersionRequest identifies a specific version to retrieve.",
@@ -1095,6 +1208,67 @@
         "title": "Organization",
         "type": "object"
       },
+      "OrganizationQuota": {
+        "additionalProperties": false,
+        "description": "OrganizationQuota represents the quota status for an organization.",
+        "properties": {
+          "current_usage": {
+            "description": "Current usage in the billing period.",
+            "format": "int32",
+            "title": "current_usage",
+            "type": "integer"
+          },
+          "effective_limit": {
+            "description": "The effective monthly limit (considers custom_limit if set).",
+            "format": "int32",
+            "title": "effective_limit",
+            "type": "integer"
+          },
+          "is_exceeded": {
+            "description": "Whether quota is exceeded.",
+            "title": "is_exceeded",
+            "type": "boolean"
+          },
+          "organization_id": {
+            "description": "The organization ID.\n Pattern: org_[0-9a-hjkmnp-tv-z]{26}",
+            "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+            "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+            "title": "organization_id",
+            "type": "string"
+          },
+          "period_start": {
+            "description": "Start of current billing period.",
+            "format": "date-time",
+            "title": "period_start",
+            "type": "string"
+          },
+          "remaining": {
+            "description": "Remaining requests in the billing period.",
+            "format": "int32",
+            "title": "remaining",
+            "type": "integer"
+          },
+          "reset_at": {
+            "description": "When the quota resets (start of next billing period).",
+            "format": "date-time",
+            "title": "reset_at",
+            "type": "string"
+          },
+          "tier": {
+            "$ref": "#/components/schemas/QuotaTier",
+            "description": "The quota tier (free or custom).",
+            "title": "tier"
+          },
+          "usage_percent": {
+            "description": "Usage as a percentage (0-100+).",
+            "format": "int32",
+            "title": "usage_percent",
+            "type": "integer"
+          }
+        },
+        "title": "OrganizationQuota",
+        "type": "object"
+      },
       "Pagination": {
         "additionalProperties": false,
         "description": "Pagination contains cursor-based pagination metadata.\n Follows Google AIP-158 for pagination field naming.",
@@ -1160,6 +1334,16 @@
           "failed"
         ]
       },
+      "QuotaTier": {
+        "description": "QuotaTier represents the organization's quota tier.",
+        "enum": [
+          "QUOTA_TIER_UNSPECIFIED",
+          "QUOTA_TIER_FREE",
+          "QUOTA_TIER_CUSTOM"
+        ],
+        "title": "QuotaTier",
+        "type": "string"
+      },
       "RevokeApiKeyRequest": {
         "additionalProperties": false,
         "description": "RevokeApiKeyRequest identifies an API key to revoke.",
@@ -2746,6 +2930,156 @@
         ]
       }
     },
+    "/v1beta/quota": {
+      "get": {
+        "description": "Returns the current quota status for an organization including usage, limits, tier, and reset date.",
+        "operationId": "getOrganizationQuota",
+        "parameters": [
+          {
+            "description": "Optional: organization ID to query. If not provided, uses the caller's organization.\n Only admins can query other organizations.",
+            "in": "query",
+            "name": "organization_id",
+            "schema": {
+              "description": "Optional: organization ID to query. If not provided, uses the caller's organization.\n Only admins can query other organizations.",
+              "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+              "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+              "title": "organization_id",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetOrganizationQuotaResponse"
+                }
+              }
+            },
+            "description": "Success"
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "429": {
+            "$ref": "#/components/responses/RateLimitExceeded"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        },
+        "summary": "Get organization quota status",
+        "tags": [
+          "Quota"
+        ],
+        "x-codeSamples": [
+          {
+            "lang": "typescript",
+            "label": "getOrganizationQuota",
+            "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n  bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await factify.quota.getOrganizationQuota({\n    organizationId: \"org_01h2xcejqtf2nbrexx3vqjhp41\",\n  });\n\n  console.log(result);\n}\n\nrun();"
+          }
+        ]
+      }
+    },
+    "/v1beta/quota/usage": {
+      "get": {
+        "description": "Returns daily usage records for an organization within a specified date range.",
+        "operationId": "getUsageHistory",
+        "parameters": [
+          {
+            "description": "Optional: organization ID to query. If not provided, uses the caller's organization.",
+            "in": "query",
+            "name": "organization_id",
+            "schema": {
+              "description": "Optional: organization ID to query. If not provided, uses the caller's organization.",
+              "example": "org_01h2xcejqtf2nbrexx3vqjhp41",
+              "pattern": "^org_[0-9a-hjkmnp-tv-z]{26}$",
+              "title": "organization_id",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Start date for the history (inclusive, YYYY-MM-DD format).",
+            "in": "query",
+            "name": "start_date",
+            "schema": {
+              "description": "Start date for the history (inclusive, YYYY-MM-DD format).",
+              "example": "2026-01-01",
+              "maxLength": 10,
+              "minLength": 10,
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "title": "start_date",
+              "type": "string"
+            }
+          },
+          {
+            "description": "End date for the history (exclusive, YYYY-MM-DD format).",
+            "in": "query",
+            "name": "end_date",
+            "schema": {
+              "description": "End date for the history (exclusive, YYYY-MM-DD format).",
+              "example": "2026-02-01",
+              "maxLength": 10,
+              "minLength": 10,
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "title": "end_date",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetUsageHistoryResponse"
+                }
+              }
+            },
+            "description": "Success"
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "429": {
+            "$ref": "#/components/responses/RateLimitExceeded"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        },
+        "summary": "Get usage history",
+        "tags": [
+          "Quota"
+        ],
+        "x-codeSamples": [
+          {
+            "lang": "typescript",
+            "label": "getUsageHistory",
+            "source": "import { Factify } from \"@factify/sdk\";\n\nconst factify = new Factify({\n  bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await factify.quota.getUsageHistory({\n    organizationId: \"org_01h2xcejqtf2nbrexx3vqjhp41\",\n    startDate: \"2026-01-01\",\n    endDate: \"2026-02-01\",\n  });\n\n  console.log(result);\n}\n\nrun();"
+          }
+        ]
+      }
+    },
     "/v1beta/versions/{version_id}": {
       "get": {
         "description": "Retrieve a specific version by ID.",
@@ -2929,6 +3263,10 @@
       "description": "Generate and manage API keys for authentication.",
       "name": "API Keys"
     },
+    {
+      "description": "Query API usage and quota information for your organization.",
+      "name": "Quota"
+    },
     {
       "description": "Attach and manage access policies for documents.",
       "name": "Policies"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factify/sdk",
-  "version": "0.3.12",
+  "version": "0.3.13-rc.1",
   "author": "Factify",
   "type": "module",
   "tshy": {

package/src/funcs/quotaGetOrganizationQuota.ts

@@ -0,0 +1,182 @@
+/*
+ * 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 organization quota status
+ *
+ * @remarks
+ * Returns the current quota status for an organization including usage, limits, tier, and reset date.
+ */
+export function quotaGetOrganizationQuota(
+  client: FactifyCore,
+  request?: operations.GetOrganizationQuotaRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetOrganizationQuotaResponse,
+    | errors.ErrorT
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FactifyCore,
+  request?: operations.GetOrganizationQuotaRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetOrganizationQuotaResponse,
+      | errors.ErrorT
+      | FactifyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.GetOrganizationQuotaRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1beta/quota")();
+
+  const query = encodeFormQuery({
+    "organization_id": payload?.organization_id,
+  });
+
+  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: "getOrganizationQuota",
+    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.GetOrganizationQuotaResponse,
+    | errors.ErrorT
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetOrganizationQuotaResponse$inboundSchema, {
+      key: "GetOrganizationQuotaResponse",
+    }),
+    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 }];
+}