@factify/sdk 0.3.15-rc.1 → 0.3.15-rc.3

package/src/funcs/userPreferencesGetUserPreferences.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FactifyCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.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 user preferences
+ *
+ * @remarks
+ * Returns the authenticated user's onboarding preferences. Only available for user accounts, not API keys.
+ */
+export function userPreferencesGetUserPreferences(
+  client: FactifyCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetUserPreferencesResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: FactifyCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetUserPreferencesResponse,
+      | errors.ErrorResponse
+      | FactifyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1beta/user-preferences")();
+
+  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: "getUserPreferences",
+    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,
+    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.GetUserPreferencesResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetUserPreferencesResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404], errors.ErrorResponse$inboundSchema),
+    M.jsonErr(429, errors.ErrorResponse$inboundSchema, { hdrs: true }),
+    M.jsonErr(500, errors.ErrorResponse$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.15-rc.1",
-  genVersion: "2.855.2",
-  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.1 2.855.2 1.0.0 @factify/sdk",
+  sdkVersion: "0.3.15-rc.3",
+  genVersion: "2.859.2",
+  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.3 2.859.2 1.0.0 @factify/sdk",
 } as const;

package/src/models/components/getdocumentquotaresponse.ts

@@ -0,0 +1,53 @@
+/*
+ * 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";
+
+/**
+ * GetDocumentQuotaResponse contains the document quota for the organization.
+ */
+export type GetDocumentQuotaResponse = {
+  /**
+   * Remaining documents that can be created (limit minus used, floored at 0).
+   *
+   * @remarks
+   *  When limit is 0 (unlimited), this field is 0 and should be ignored by clients.
+   */
+  available?: number | undefined;
+  /**
+   * Maximum documents allowed for this organization.
+   *
+   * @remarks
+   *  0 means unlimited (no quota enforced).
+   */
+  limit?: number | undefined;
+  /**
+   * Number of documents counting against quota (excludes demo, includes trashed).
+   */
+  used?: number | undefined;
+};
+
+/** @internal */
+export const GetDocumentQuotaResponse$inboundSchema: z.ZodMiniType<
+  GetDocumentQuotaResponse,
+  unknown
+> = z.object({
+  available: types.optional(types.number()),
+  limit: types.optional(types.number()),
+  used: types.optional(types.number()),
+});
+
+export function getDocumentQuotaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetDocumentQuotaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetDocumentQuotaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetDocumentQuotaResponse' from JSON`,
+  );
+}

package/src/models/components/getuserpreferencesresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * 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";
+
+/**
+ * GetUserPreferencesResponse contains the user's onboarding preferences.
+ */
+export type GetUserPreferencesResponse = {
+  /**
+   * Whether the user has completed the document tour.
+   */
+  hasCompletedDocumentTour?: boolean | undefined;
+  /**
+   * Whether the user has completed the hub onboarding flow.
+   */
+  hasCompletedHubOnboarding?: boolean | undefined;
+};
+
+/** @internal */
+export const GetUserPreferencesResponse$inboundSchema: z.ZodMiniType<
+  GetUserPreferencesResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    has_completed_document_tour: types.optional(types.boolean()),
+    has_completed_hub_onboarding: types.optional(types.boolean()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "has_completed_document_tour": "hasCompletedDocumentTour",
+      "has_completed_hub_onboarding": "hasCompletedHubOnboarding",
+    });
+  }),
+);
+
+export function getUserPreferencesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUserPreferencesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUserPreferencesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUserPreferencesResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -30,10 +30,12 @@ export * from "./empty.js";
 export * from "./errordetail.js";
 export * from "./errorresponse.js";
 export * from "./generateentrypageresponse.js";
+export * from "./getdocumentquotaresponse.js";
 export * from "./getdocumentresponse.js";
 export * from "./getorganizationquotaresponse.js";
 export * from "./getorganizationresponse.js";
 export * from "./getusagehistoryresponse.js";
+export * from "./getuserpreferencesresponse.js";
 export * from "./listapikeyquotasresponse.js";
 export * from "./listapikeysresponse.js";
 export * from "./listdocumentpoliciesresponse.js";

package/src/models/operations/getdocumentquota.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetDocumentQuotaResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetDocumentQuotaResponse;
+};
+
+/** @internal */
+export const GetDocumentQuotaResponse$inboundSchema: z.ZodMiniType<
+  GetDocumentQuotaResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: components.GetDocumentQuotaResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+export function getDocumentQuotaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetDocumentQuotaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetDocumentQuotaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetDocumentQuotaResponse' from JSON`,
+  );
+}

package/src/models/operations/getuserpreferences.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetUserPreferencesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetUserPreferencesResponse;
+};
+
+/** @internal */
+export const GetUserPreferencesResponse$inboundSchema: z.ZodMiniType<
+  GetUserPreferencesResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: components.GetUserPreferencesResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+export function getUserPreferencesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUserPreferencesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUserPreferencesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUserPreferencesResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -14,9 +14,11 @@ export * from "./deleteapikeyquota.js";
 export * from "./detachdocumentpolicy.js";
 export * from "./generatedocumententrypage.js";
 export * from "./getdocument.js";
+export * from "./getdocumentquota.js";
 export * from "./getorganization.js";
 export * from "./getorganizationquota.js";
 export * from "./getusagehistory.js";
+export * from "./getuserpreferences.js";
 export * from "./getversion.js";
 export * from "./listapikeyquotas.js";
 export * from "./listapikeys.js";

package/src/sdk/documents.ts

@@ -4,6 +4,7 @@
 
 import { documentsCreate } from "../funcs/documentsCreate.js";
 import { documentsGet } from "../funcs/documentsGet.js";
+import { documentsGetDocumentQuota } from "../funcs/documentsGetDocumentQuota.js";
 import { documentsList } from "../funcs/documentsList.js";
 import { documentsUpdate } from "../funcs/documentsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -49,6 +50,21 @@ export class Documents extends ClientSDK {
     ));
   }
 
+  /**
+   * Get document quota
+   *
+   * @remarks
+   * Returns the document quota status for the authenticated user's organization, including the number of documents used, the configured limit, and remaining capacity.
+   */
+  async getDocumentQuota(
+    options?: RequestOptions,
+  ): Promise<operations.GetDocumentQuotaResponse> {
+    return unwrapAsync(documentsGetDocumentQuota(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a document
    *

package/src/sdk/sdk.ts

@@ -10,6 +10,7 @@ import { Organizations } from "./organizations.js";
 import { Policies } from "./policies.js";
 import { Quotas } from "./quotas.js";
 import { Usage } from "./usage.js";
+import { UserPreferences } from "./userpreferences.js";
 import { Versions } from "./versions.js";
 
 export class Factify extends ClientSDK {
@@ -52,4 +53,9 @@ export class Factify extends ClientSDK {
   get usage(): Usage {
     return (this._usage ??= new Usage(this._options));
   }
+
+  private _userPreferences?: UserPreferences;
+  get userPreferences(): UserPreferences {
+    return (this._userPreferences ??= new UserPreferences(this._options));
+  }
 }

package/src/sdk/userpreferences.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { userPreferencesGetUserPreferences } from "../funcs/userPreferencesGetUserPreferences.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class UserPreferences extends ClientSDK {
+  /**
+   * Get user preferences
+   *
+   * @remarks
+   * Returns the authenticated user's onboarding preferences. Only available for user accounts, not API keys.
+   */
+  async getUserPreferences(
+    options?: RequestOptions,
+  ): Promise<operations.GetUserPreferencesResponse> {
+    return unwrapAsync(userPreferencesGetUserPreferences(
+      this,
+      options,
+    ));
+  }
+}