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

package/src/funcs/accessRequestsListAccessRequests.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { FactifyCore } from "../core.js";
+import { 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 { 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";
+
+/**
+ * List access requests
+ *
+ * @remarks
+ * Lists pending access requests for the specified document.
+ */
+export function accessRequestsListAccessRequests(
+  client: FactifyCore,
+  request: operations.ListAccessRequestsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListAccessRequestsResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FactifyCore,
+  request: operations.ListAccessRequestsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListAccessRequestsResponse,
+      | errors.ErrorResponse
+      | FactifyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.ListAccessRequestsRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    document_id: encodeSimple("document_id", payload.document_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1beta/documents/{document_id}/access-requests")(
+    pathParams,
+  );
+
+  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: "listAccessRequests",
+    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,
+    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.ListAccessRequestsResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListAccessRequestsResponse$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.3",
+  sdkVersion: "0.3.15-rc.4",
   genVersion: "2.859.2",
-  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.3 2.859.2 1.0.0 @factify/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.4 2.859.2 1.0.0 @factify/sdk",
 } as const;

package/src/models/components/accessrequest.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 {
+  AccessRequestPermission,
+  AccessRequestPermission$inboundSchema,
+} from "./accessrequestpermission.js";
+import {
+  AccessRequestStatus,
+  AccessRequestStatus$inboundSchema,
+} from "./accessrequeststatus.js";
+import { Subject, Subject$inboundSchema } from "./subject.js";
+
+/**
+ * AccessRequest represents a request for access to a document.
+ */
+export type AccessRequest = {
+  /**
+   * When the request was created.
+   */
+  createdAt: Date;
+  /**
+   * Document this request is for.
+   *
+   * @remarks
+   *  Pattern: doc_[0-9a-hjkmnp-tv-z]{26}
+   */
+  documentId: string;
+  /**
+   * Unique ID for the access request.
+   *
+   * @remarks
+   *  Pattern: acr_[0-9a-hjkmnp-tv-z]{26}
+   */
+  id: string;
+  /**
+   * Optional message from the requester.
+   */
+  message?: string | null | undefined;
+  permission: AccessRequestPermission;
+  requestStatus: AccessRequestStatus;
+  /**
+   * Subject is a lightweight reference to either a user or a bot.
+   *
+   * @remarks
+   *  Used in embedded fields like created_by.
+   *  For full details, call GetUser or GetBot with the subject's id.
+   * subject_type_matches_id_prefix // id prefix must match type (user_ for user, bot_ for bot)
+   */
+  subject: Subject;
+  /**
+   * Email of the requesting user. Denormalized for display convenience.
+   */
+  subjectEmail?: string | undefined;
+  /**
+   * When the request was last updated.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const AccessRequest$inboundSchema: z.ZodMiniType<
+  AccessRequest,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.date(),
+    document_id: types.string(),
+    id: types.string(),
+    message: z.optional(z.nullable(types.string())),
+    permission: AccessRequestPermission$inboundSchema,
+    request_status: AccessRequestStatus$inboundSchema,
+    subject: Subject$inboundSchema,
+    subject_email: types.optional(types.string()),
+    updated_at: types.date(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "document_id": "documentId",
+      "request_status": "requestStatus",
+      "subject_email": "subjectEmail",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function accessRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AccessRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccessRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccessRequest' from JSON`,
+  );
+}

package/src/models/components/accessrequestpermission.ts

@@ -0,0 +1,25 @@
+/*
+ * 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";
+
+export const AccessRequestPermission = {
+  View: "view",
+  Edit: "edit",
+  Comment: "comment",
+} as const;
+export type AccessRequestPermission = OpenEnum<typeof AccessRequestPermission>;
+
+/** @internal */
+export const AccessRequestPermission$inboundSchema: z.ZodMiniType<
+  AccessRequestPermission,
+  unknown
+> = openEnums.inboundSchema(AccessRequestPermission);
+/** @internal */
+export const AccessRequestPermission$outboundSchema: z.ZodMiniType<
+  string,
+  AccessRequestPermission
+> = openEnums.outboundSchema(AccessRequestPermission);

package/src/models/components/accessrequeststatus.ts

@@ -0,0 +1,20 @@
+/*
+ * 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";
+
+export const AccessRequestStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Denied: "denied",
+} as const;
+export type AccessRequestStatus = OpenEnum<typeof AccessRequestStatus>;
+
+/** @internal */
+export const AccessRequestStatus$inboundSchema: z.ZodMiniType<
+  AccessRequestStatus,
+  unknown
+> = openEnums.inboundSchema(AccessRequestStatus);

package/src/models/components/approveaccessrequestresponse.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AccessRequest, AccessRequest$inboundSchema } from "./accessrequest.js";
+
+/**
+ * ApproveAccessRequestResponse contains the approved access request.
+ */
+export type ApproveAccessRequestResponse = {
+  /**
+   * AccessRequest represents a request for access to a document.
+   */
+  accessRequest: AccessRequest;
+};
+
+/** @internal */
+export const ApproveAccessRequestResponse$inboundSchema: z.ZodMiniType<
+  ApproveAccessRequestResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    access_request: AccessRequest$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "access_request": "accessRequest",
+    });
+  }),
+);
+
+export function approveAccessRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ApproveAccessRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApproveAccessRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApproveAccessRequestResponse' from JSON`,
+  );
+}

package/src/models/components/checkaccessrequeststatusresponse.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 types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * CheckAccessRequestStatusResponse returns whether the caller has a pending request.
+ */
+export type CheckAccessRequestStatusResponse = {
+  hasPendingRequest?: boolean | undefined;
+};
+
+/** @internal */
+export const CheckAccessRequestStatusResponse$inboundSchema: z.ZodMiniType<
+  CheckAccessRequestStatusResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    has_pending_request: types.optional(types.boolean()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "has_pending_request": "hasPendingRequest",
+    });
+  }),
+);
+
+export function checkAccessRequestStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckAccessRequestStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckAccessRequestStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckAccessRequestStatusResponse' from JSON`,
+  );
+}

package/src/models/components/createaccessrequestresponse.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AccessRequest, AccessRequest$inboundSchema } from "./accessrequest.js";
+
+/**
+ * CreateAccessRequestResponse contains the created access request.
+ */
+export type CreateAccessRequestResponse = {
+  /**
+   * AccessRequest represents a request for access to a document.
+   */
+  accessRequest: AccessRequest;
+};
+
+/** @internal */
+export const CreateAccessRequestResponse$inboundSchema: z.ZodMiniType<
+  CreateAccessRequestResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    access_request: AccessRequest$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "access_request": "accessRequest",
+    });
+  }),
+);
+
+export function createAccessRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateAccessRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateAccessRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateAccessRequestResponse' from JSON`,
+  );
+}

package/src/models/components/denyaccessrequestresponse.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AccessRequest, AccessRequest$inboundSchema } from "./accessrequest.js";
+
+/**
+ * DenyAccessRequestResponse contains the denied access request.
+ */
+export type DenyAccessRequestResponse = {
+  /**
+   * AccessRequest represents a request for access to a document.
+   */
+  accessRequest: AccessRequest;
+};
+
+/** @internal */
+export const DenyAccessRequestResponse$inboundSchema: z.ZodMiniType<
+  DenyAccessRequestResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    access_request: AccessRequest$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "access_request": "accessRequest",
+    });
+  }),
+);
+
+export function denyAccessRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DenyAccessRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DenyAccessRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DenyAccessRequestResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -4,11 +4,17 @@
 
 export * from "./acceptorganizationinviteresponse.js";
 export * from "./accesslevel.js";
+export * from "./accessrequest.js";
+export * from "./accessrequestpermission.js";
+export * from "./accessrequeststatus.js";
 export * from "./addorganizationmemberresponse.js";
 export * from "./apikey.js";
 export * from "./apikeyquota.js";
+export * from "./approveaccessrequestresponse.js";
+export * from "./checkaccessrequeststatusresponse.js";
 export * from "./connecterror.js";
 export * from "./connecterrordetailsany.js";
+export * from "./createaccessrequestresponse.js";
 export * from "./createapikeyrequest.js";
 export * from "./createapikeyresponse.js";
 export * from "./createdocumentrequest.js";
@@ -21,6 +27,7 @@ export * from "./dailyusage.js";
 export * from "./deleteapikeyquotaresponse.js";
 export * from "./deleteorganizationquotarequest.js";
 export * from "./deleteorganizationquotaresponse.js";
+export * from "./denyaccessrequestresponse.js";
 export * from "./document.js";
 export * from "./documentownership.js";
 export * from "./documentpermissionset.js";
@@ -36,6 +43,8 @@ export * from "./getorganizationquotaresponse.js";
 export * from "./getorganizationresponse.js";
 export * from "./getusagehistoryresponse.js";
 export * from "./getuserpreferencesresponse.js";
+export * from "./inspectaccessresponse.js";
+export * from "./listaccessrequestsresponse.js";
 export * from "./listapikeyquotasresponse.js";
 export * from "./listapikeysresponse.js";
 export * from "./listdocumentpoliciesresponse.js";

package/src/models/components/inspectaccessresponse.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 {
+  DocumentPermissionSet,
+  DocumentPermissionSet$inboundSchema,
+} from "./documentpermissionset.js";
+
+/**
+ * InspectAccessResponse contains the caller's permissions.
+ */
+export type InspectAccessResponse = {
+  /**
+   * Document ID.
+   */
+  documentId?: string | undefined;
+  /**
+   * DocumentPermissionSet contains the permissions the authenticated user has on a document.
+   */
+  permissionSet?: DocumentPermissionSet | undefined;
+};
+
+/** @internal */
+export const InspectAccessResponse$inboundSchema: z.ZodMiniType<
+  InspectAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    document_id: types.optional(types.string()),
+    permission_set: types.optional(DocumentPermissionSet$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "document_id": "documentId",
+      "permission_set": "permissionSet",
+    });
+  }),
+);
+
+export function inspectAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<InspectAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InspectAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InspectAccessResponse' from JSON`,
+  );
+}

package/src/models/components/listaccessrequestsresponse.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { AccessRequest, AccessRequest$inboundSchema } from "./accessrequest.js";
+
+/**
+ * ListAccessRequestsResponse contains the list of access requests.
+ */
+export type ListAccessRequestsResponse = {
+  hasMore?: boolean | undefined;
+  items?: Array<AccessRequest> | undefined;
+};
+
+/** @internal */
+export const ListAccessRequestsResponse$inboundSchema: z.ZodMiniType<
+  ListAccessRequestsResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    has_more: types.optional(types.boolean()),
+    items: types.optional(z.array(AccessRequest$inboundSchema)),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "has_more": "hasMore",
+    });
+  }),
+);
+
+export function listAccessRequestsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAccessRequestsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAccessRequestsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAccessRequestsResponse' from JSON`,
+  );
+}