@factify/sdk 0.3.15-rc.5 → 0.3.15-rc.7

package/src/funcs/sharingUpdate.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { FactifyCore } from "../core.js";
+import { encodeJSON, 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";
+
+/**
+ * Update document access
+ *
+ * @remarks
+ * Update a recipient's role.
+ */
+export function sharingUpdate(
+  client: FactifyCore,
+  request: operations.UpdateDocumentAccessRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateDocumentAccessResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FactifyCore,
+  request: operations.UpdateDocumentAccessRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UpdateDocumentAccessResponse,
+      | errors.ErrorResponse
+      | FactifyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.UpdateDocumentAccessRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.body, { explode: true });
+
+  const pathParams = {
+    document_id: encodeSimple("document_id", payload.document_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    recipient_id: encodeSimple("recipient_id", payload.recipient_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v1beta/documents/{document_id}/share/{recipient_id}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "updateDocumentAccess",
+    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: "PATCH",
+    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.UpdateDocumentAccessResponse,
+    | errors.ErrorResponse
+    | FactifyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.UpdateDocumentAccessResponse$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/funcs/usageGetUsageHistory.ts

@@ -97,6 +97,7 @@ async function $do(
 
   const query = encodeFormQuery({
     "date.after": payload?.["date.after"],
+    "date.before": payload?.["date.before"],
     "organization_id": payload?.organization_id,
   });
 

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.5",
+  sdkVersion: "0.3.15-rc.7",
   genVersion: "2.865.2",
-  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.5 2.865.2 1.0.0 @factify/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.3.15-rc.7 2.865.2 1.0.0 @factify/sdk",
 } as const;

package/src/models/components/accessgrantresult.ts

@@ -0,0 +1,47 @@
+/*
+ * 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";
+
+/**
+ * AccessGrantResult contains the outcome of granting access to one recipient.
+ */
+export type AccessGrantResult = {
+  /**
+   * Error message if the grant failed.
+   */
+  error?: string | undefined;
+  /**
+   * The recipient that was granted access.
+   */
+  recipient?: string | undefined;
+  /**
+   * Whether the grant succeeded.
+   */
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const AccessGrantResult$inboundSchema: z.ZodMiniType<
+  AccessGrantResult,
+  unknown
+> = z.object({
+  error: types.optional(types.string()),
+  recipient: types.optional(types.string()),
+  success: types.optional(types.boolean()),
+});
+
+export function accessGrantResultFromJSON(
+  jsonString: string,
+): SafeParseResult<AccessGrantResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccessGrantResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccessGrantResult' from JSON`,
+  );
+}

package/src/models/components/createdocumentrequest.ts

@@ -16,7 +16,10 @@ export type CreateDocumentRequestPayload = {
  * CreateDocumentRequest contains the file and metadata for creating a document.
  */
 export type CreateDocumentRequest = {
-  accessLevel?: AccessLevel | undefined;
+  /**
+   * Document access level. Defaults to organization if user belongs to an org, otherwise private.
+   */
+  accessLevel?: AccessLevel | null | undefined;
   /**
    * Optional document description.
    */
@@ -63,7 +66,7 @@ export function createDocumentRequestPayloadToJSON(
 
 /** @internal */
 export type CreateDocumentRequest$Outbound = {
-  access_level?: string | undefined;
+  access_level?: string | null | undefined;
   description?: string | null | undefined;
   payload: CreateDocumentRequestPayload$Outbound | Blob;
   title: string;
@@ -75,7 +78,7 @@ export const CreateDocumentRequest$outboundSchema: z.ZodMiniType<
   CreateDocumentRequest
 > = z.pipe(
   z.object({
-    accessLevel: z.optional(AccessLevel$outboundSchema),
+    accessLevel: z.optional(z.nullable(AccessLevel$outboundSchema)),
     description: z.optional(z.nullable(z.string())),
     payload: z.union([
       z.lazy(() => CreateDocumentRequestPayload$outboundSchema),

package/src/models/components/createsharelinkresponse.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 { ShareLink, ShareLink$inboundSchema } from "./sharelink.js";
+
+/**
+ * CreateShareLinkResponse contains the created share link.
+ */
+export type CreateShareLinkResponse = {
+  /**
+   * ShareLink represents a shareable link for a document.
+   */
+  shareLink?: ShareLink | undefined;
+  /**
+   * Shortened URL for the share link (if available).
+   */
+  shortUrl?: string | null | undefined;
+};
+
+/** @internal */
+export const CreateShareLinkResponse$inboundSchema: z.ZodMiniType<
+  CreateShareLinkResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    share_link: types.optional(ShareLink$inboundSchema),
+    short_url: z.optional(z.nullable(types.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "share_link": "shareLink",
+      "short_url": "shortUrl",
+    });
+  }),
+);
+
+export function createShareLinkResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateShareLinkResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateShareLinkResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateShareLinkResponse' from JSON`,
+  );
+}

package/src/models/components/document.ts

@@ -39,9 +39,9 @@ export type Document = {
    */
   createdBy: Subject;
   /**
-   * VersionRef is a lightweight reference to a version.
+   * Reference to the current version, if any.
    */
-  currentVersion?: VersionRef | undefined;
+  currentVersion?: VersionRef | null | undefined;
   /**
    * Optional document description.
    */
@@ -108,7 +108,7 @@ export const Document$inboundSchema: z.ZodMiniType<Document, unknown> = z.pipe(
     access_level: AccessLevel$inboundSchema,
     created_at: types.date(),
     created_by: Subject$inboundSchema,
-    current_version: types.optional(VersionRef$inboundSchema),
+    current_version: z.optional(z.nullable(VersionRef$inboundSchema)),
     description: z.optional(z.nullable(types.string())),
     general_access: types.optional(AccessLevel$inboundSchema),
     id: types.string(),

package/src/models/components/documentrole.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 DocumentRole = {
+  Viewer: "viewer",
+  Commenter: "commenter",
+  Collaborator: "collaborator",
+  Admin: "admin",
+  Owner: "owner",
+} as const;
+export type DocumentRole = OpenEnum<typeof DocumentRole>;
+
+/** @internal */
+export const DocumentRole$inboundSchema: z.ZodMiniType<DocumentRole, unknown> =
+  openEnums.inboundSchema(DocumentRole);
+/** @internal */
+export const DocumentRole$outboundSchema: z.ZodMiniType<string, DocumentRole> =
+  openEnums.outboundSchema(DocumentRole);

package/src/models/components/generalaccesslevel.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 GeneralAccessLevel = {
+  Restricted: "restricted",
+  Organization: "organization",
+  AnyoneWithLink: "anyone_with_link",
+} as const;
+export type GeneralAccessLevel = OpenEnum<typeof GeneralAccessLevel>;
+
+/** @internal */
+export const GeneralAccessLevel$inboundSchema: z.ZodMiniType<
+  GeneralAccessLevel,
+  unknown
+> = openEnums.inboundSchema(GeneralAccessLevel);
+/** @internal */
+export const GeneralAccessLevel$outboundSchema: z.ZodMiniType<
+  string,
+  GeneralAccessLevel
+> = openEnums.outboundSchema(GeneralAccessLevel);

package/src/models/components/getgeneralaccessresponse.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 {
+  GeneralAccessLevel,
+  GeneralAccessLevel$inboundSchema,
+} from "./generalaccesslevel.js";
+
+/**
+ * GetGeneralAccessResponse contains the current general access level.
+ */
+export type GetGeneralAccessResponse = {
+  /**
+   * Document ID.
+   */
+  documentId?: string | undefined;
+  generalAccessLevel?: GeneralAccessLevel | undefined;
+};
+
+/** @internal */
+export const GetGeneralAccessResponse$inboundSchema: z.ZodMiniType<
+  GetGeneralAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    document_id: types.optional(types.string()),
+    general_access_level: types.optional(GeneralAccessLevel$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "document_id": "documentId",
+      "general_access_level": "generalAccessLevel",
+    });
+  }),
+);
+
+export function getGeneralAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeneralAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeneralAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeneralAccessResponse' from JSON`,
+  );
+}

package/src/models/components/grantdocumentaccessresponse.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 {
+  AccessGrantResult,
+  AccessGrantResult$inboundSchema,
+} from "./accessgrantresult.js";
+
+/**
+ * GrantDocumentAccessResponse contains the results of granting access.
+ */
+export type GrantDocumentAccessResponse = {
+  /**
+   * Document ID.
+   */
+  documentId?: string | undefined;
+  /**
+   * Number of failed grants.
+   */
+  failed?: number | undefined;
+  /**
+   * Results for each recipient.
+   */
+  results?: Array<AccessGrantResult> | undefined;
+  /**
+   * Number of successful grants.
+   */
+  successful?: number | undefined;
+  /**
+   * Total number of recipients processed.
+   */
+  total?: number | undefined;
+};
+
+/** @internal */
+export const GrantDocumentAccessResponse$inboundSchema: z.ZodMiniType<
+  GrantDocumentAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    document_id: types.optional(types.string()),
+    failed: types.optional(types.number()),
+    results: types.optional(z.array(AccessGrantResult$inboundSchema)),
+    successful: types.optional(types.number()),
+    total: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "document_id": "documentId",
+    });
+  }),
+);
+
+export function grantDocumentAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GrantDocumentAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GrantDocumentAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GrantDocumentAccessResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from "./acceptorganizationinviteresponse.js";
+export * from "./accessgrantresult.js";
 export * from "./accesslevel.js";
 export * from "./accessrequest.js";
 export * from "./accessrequestpermission.js";
@@ -22,6 +23,7 @@ export * from "./createdocumentresponse.js";
 export * from "./createorganizationinviteresponse.js";
 export * from "./createorganizationrequest.js";
 export * from "./createorganizationresponse.js";
+export * from "./createsharelinkresponse.js";
 export * from "./createversionrequest.js";
 export * from "./dailyusage.js";
 export * from "./deleteapikeyquotaresponse.js";
@@ -32,21 +34,26 @@ export * from "./document.js";
 export * from "./documentownership.js";
 export * from "./documentpermissionset.js";
 export * from "./documentpolicy.js";
+export * from "./documentrole.js";
 export * from "./documenttrashstate.js";
 export * from "./empty.js";
 export * from "./errordetail.js";
 export * from "./errorresponse.js";
+export * from "./generalaccesslevel.js";
 export * from "./generateentrypageresponse.js";
 export * from "./getdocumentquotaresponse.js";
 export * from "./getdocumentresponse.js";
+export * from "./getgeneralaccessresponse.js";
 export * from "./getorganizationquotaresponse.js";
 export * from "./getorganizationresponse.js";
 export * from "./getusagehistoryresponse.js";
 export * from "./getuserpreferencesresponse.js";
+export * from "./grantdocumentaccessresponse.js";
 export * from "./inspectaccessresponse.js";
 export * from "./listaccessrequestsresponse.js";
 export * from "./listapikeyquotasresponse.js";
 export * from "./listapikeysresponse.js";
+export * from "./listdocumentaccessresponse.js";
 export * from "./listdocumentpoliciesresponse.js";
 export * from "./listdocumentsresponse.js";
 export * from "./listorganizationinvitesresponse.js";
@@ -64,16 +71,23 @@ export * from "./pagination.js";
 export * from "./policy.js";
 export * from "./processingstatus.js";
 export * from "./quotatier.js";
+export * from "./recipient.js";
+export * from "./recipientgrant.js";
+export * from "./recipienttype.js";
 export * from "./removeorganizationmemberresponse.js";
 export * from "./resendorganizationinviteresponse.js";
 export * from "./revokeapikeyresponse.js";
+export * from "./revokedocumentaccessresponse.js";
 export * from "./revokeorganizationinviteresponse.js";
 export * from "./security.js";
 export * from "./setapikeyquotaresponse.js";
+export * from "./setgeneralaccessresponse.js";
 export * from "./setorganizationquotarequest.js";
 export * from "./setorganizationquotaresponse.js";
+export * from "./sharelink.js";
 export * from "./subject.js";
 export * from "./subjecttype.js";
+export * from "./updatedocumentaccessresponse.js";
 export * from "./updatedocumentresponse.js";
 export * from "./updateorganizationmemberresponse.js";
 export * from "./user.js";

package/src/models/components/listdocumentaccessresponse.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 {
+  GeneralAccessLevel,
+  GeneralAccessLevel$inboundSchema,
+} from "./generalaccesslevel.js";
+import { Recipient, Recipient$inboundSchema } from "./recipient.js";
+
+/**
+ * ListDocumentAccessResponse contains the access list and general access level.
+ */
+export type ListDocumentAccessResponse = {
+  /**
+   * Document ID.
+   */
+  documentId?: string | undefined;
+  generalAccessLevel?: GeneralAccessLevel | undefined;
+  /**
+   * Recipients with access.
+   */
+  recipients?: Array<Recipient> | undefined;
+};
+
+/** @internal */
+export const ListDocumentAccessResponse$inboundSchema: z.ZodMiniType<
+  ListDocumentAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    document_id: types.optional(types.string()),
+    general_access_level: types.optional(GeneralAccessLevel$inboundSchema),
+    recipients: types.optional(z.array(Recipient$inboundSchema)),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "document_id": "documentId",
+      "general_access_level": "generalAccessLevel",
+    });
+  }),
+);
+
+export function listDocumentAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDocumentAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDocumentAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDocumentAccessResponse' from JSON`,
+  );
+}