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

package/src/models/components/recipient.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 { DocumentRole, DocumentRole$inboundSchema } from "./documentrole.js";
+import { RecipientType, RecipientType$inboundSchema } from "./recipienttype.js";
+
+/**
+ * Recipient represents an entity with access to a document.
+ */
+export type Recipient = {
+  documentRole: DocumentRole;
+  /**
+   * Email (only for user recipients).
+   */
+  email?: string | undefined;
+  /**
+   * Recipient ID (TypeID: user_xxx, bot_xxx, or org_xxx).
+   */
+  id: string;
+  /**
+   * Display name.
+   */
+  name?: string | undefined;
+  type: RecipientType;
+};
+
+/** @internal */
+export const Recipient$inboundSchema: z.ZodMiniType<Recipient, unknown> = z
+  .pipe(
+    z.object({
+      document_role: DocumentRole$inboundSchema,
+      email: types.optional(types.string()),
+      id: types.string(),
+      name: types.optional(types.string()),
+      type: RecipientType$inboundSchema,
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "document_role": "documentRole",
+      });
+    }),
+  );
+
+export function recipientFromJSON(
+  jsonString: string,
+): SafeParseResult<Recipient, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Recipient$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Recipient' from JSON`,
+  );
+}

package/src/models/components/recipientgrant.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { DocumentRole, DocumentRole$outboundSchema } from "./documentrole.js";
+
+/**
+ * RecipientGrant specifies a recipient and role for granting access.
+ */
+export type RecipientGrant = {
+  /**
+   * Recipient email address or TypeID (user_xxx, bot_xxx).
+   */
+  recipient?: string | undefined;
+  role: DocumentRole;
+};
+
+/** @internal */
+export type RecipientGrant$Outbound = {
+  recipient?: string | undefined;
+  role: string;
+};
+
+/** @internal */
+export const RecipientGrant$outboundSchema: z.ZodMiniType<
+  RecipientGrant$Outbound,
+  RecipientGrant
+> = z.object({
+  recipient: z.optional(z.string()),
+  role: DocumentRole$outboundSchema,
+});
+
+export function recipientGrantToJSON(recipientGrant: RecipientGrant): string {
+  return JSON.stringify(RecipientGrant$outboundSchema.parse(recipientGrant));
+}

package/src/models/components/recipienttype.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 RecipientType = {
+  User: "user",
+  Bot: "bot",
+  Organization: "organization",
+} as const;
+export type RecipientType = OpenEnum<typeof RecipientType>;
+
+/** @internal */
+export const RecipientType$inboundSchema: z.ZodMiniType<
+  RecipientType,
+  unknown
+> = openEnums.inboundSchema(RecipientType);

package/src/models/components/revokedocumentaccessresponse.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * RevokeDocumentAccessResponse contains the result of revoking access.
+ */
+export type RevokeDocumentAccessResponse = {
+  /**
+   * Error message if the revocation failed.
+   */
+  error?: string | undefined;
+  /**
+   * Whether the revocation succeeded.
+   */
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const RevokeDocumentAccessResponse$inboundSchema: z.ZodMiniType<
+  RevokeDocumentAccessResponse,
+  unknown
+> = z.object({
+  error: types.optional(types.string()),
+  success: types.optional(types.boolean()),
+});
+
+export function revokeDocumentAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RevokeDocumentAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevokeDocumentAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevokeDocumentAccessResponse' from JSON`,
+  );
+}

package/src/models/components/setgeneralaccessresponse.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";
+
+/**
+ * SetGeneralAccessResponse contains the updated general access level.
+ */
+export type SetGeneralAccessResponse = {
+  /**
+   * Document ID.
+   */
+  documentId?: string | undefined;
+  generalAccessLevel?: GeneralAccessLevel | undefined;
+};
+
+/** @internal */
+export const SetGeneralAccessResponse$inboundSchema: z.ZodMiniType<
+  SetGeneralAccessResponse,
+  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 setGeneralAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SetGeneralAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SetGeneralAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SetGeneralAccessResponse' from JSON`,
+  );
+}

package/src/models/components/sharelink.ts

@@ -0,0 +1,60 @@
+/*
+ * 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";
+
+/**
+ * ShareLink represents a shareable link for a document.
+ */
+export type ShareLink = {
+  /**
+   * When the link was created.
+   */
+  createdAt?: Date | undefined;
+  /**
+   * ID of the user who created this link.
+   */
+  creatorId?: string | undefined;
+  /**
+   * Document ID this link belongs to.
+   */
+  documentId?: string | undefined;
+  /**
+   * Share link ID.
+   */
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ShareLink$inboundSchema: z.ZodMiniType<ShareLink, unknown> = z
+  .pipe(
+    z.object({
+      created_at: types.optional(types.date()),
+      creator_id: types.optional(types.string()),
+      document_id: types.optional(types.string()),
+      id: types.optional(types.string()),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "created_at": "createdAt",
+        "creator_id": "creatorId",
+        "document_id": "documentId",
+      });
+    }),
+  );
+
+export function shareLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<ShareLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShareLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShareLink' from JSON`,
+  );
+}

package/src/models/components/updatedocumentaccessresponse.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * UpdateDocumentAccessResponse contains the result of updating access.
+ */
+export type UpdateDocumentAccessResponse = {
+  /**
+   * Error message if the update failed.
+   */
+  error?: string | undefined;
+  /**
+   * Whether the update succeeded.
+   */
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateDocumentAccessResponse$inboundSchema: z.ZodMiniType<
+  UpdateDocumentAccessResponse,
+  unknown
+> = z.object({
+  error: types.optional(types.string()),
+  success: types.optional(types.boolean()),
+});
+
+export function updateDocumentAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateDocumentAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateDocumentAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateDocumentAccessResponse' from JSON`,
+  );
+}

package/src/models/operations/createsharelink.ts

@@ -0,0 +1,105 @@
+/*
+ * 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";
+
+/**
+ * CreateShareLinkRequest creates a share link for a document.
+ */
+export type CreateShareLinkCreateShareLinkRequest = {};
+
+export type CreateShareLinkRequest = {
+  /**
+   * Document ID.
+   */
+  documentId: string;
+  body: CreateShareLinkCreateShareLinkRequest;
+};
+
+export type CreateShareLinkResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.CreateShareLinkResponse;
+};
+
+/** @internal */
+export type CreateShareLinkCreateShareLinkRequest$Outbound = {};
+
+/** @internal */
+export const CreateShareLinkCreateShareLinkRequest$outboundSchema:
+  z.ZodMiniType<
+    CreateShareLinkCreateShareLinkRequest$Outbound,
+    CreateShareLinkCreateShareLinkRequest
+  > = z.object({});
+
+export function createShareLinkCreateShareLinkRequestToJSON(
+  createShareLinkCreateShareLinkRequest: CreateShareLinkCreateShareLinkRequest,
+): string {
+  return JSON.stringify(
+    CreateShareLinkCreateShareLinkRequest$outboundSchema.parse(
+      createShareLinkCreateShareLinkRequest,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateShareLinkRequest$Outbound = {
+  document_id: string;
+  body: CreateShareLinkCreateShareLinkRequest$Outbound;
+};
+
+/** @internal */
+export const CreateShareLinkRequest$outboundSchema: z.ZodMiniType<
+  CreateShareLinkRequest$Outbound,
+  CreateShareLinkRequest
+> = z.pipe(
+  z.object({
+    documentId: z.string(),
+    body: z.lazy(() => CreateShareLinkCreateShareLinkRequest$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      documentId: "document_id",
+    });
+  }),
+);
+
+export function createShareLinkRequestToJSON(
+  createShareLinkRequest: CreateShareLinkRequest,
+): string {
+  return JSON.stringify(
+    CreateShareLinkRequest$outboundSchema.parse(createShareLinkRequest),
+  );
+}
+
+/** @internal */
+export const CreateShareLinkResponse$inboundSchema: z.ZodMiniType<
+  CreateShareLinkResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: components.CreateShareLinkResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+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/operations/getgeneralaccess.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 GetGeneralAccessRequest = {
+  /**
+   * Document ID.
+   */
+  documentId: string;
+};
+
+export type GetGeneralAccessResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetGeneralAccessResponse;
+};
+
+/** @internal */
+export type GetGeneralAccessRequest$Outbound = {
+  document_id: string;
+};
+
+/** @internal */
+export const GetGeneralAccessRequest$outboundSchema: z.ZodMiniType<
+  GetGeneralAccessRequest$Outbound,
+  GetGeneralAccessRequest
+> = z.pipe(
+  z.object({
+    documentId: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      documentId: "document_id",
+    });
+  }),
+);
+
+export function getGeneralAccessRequestToJSON(
+  getGeneralAccessRequest: GetGeneralAccessRequest,
+): string {
+  return JSON.stringify(
+    GetGeneralAccessRequest$outboundSchema.parse(getGeneralAccessRequest),
+  );
+}
+
+/** @internal */
+export const GetGeneralAccessResponse$inboundSchema: z.ZodMiniType<
+  GetGeneralAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: components.GetGeneralAccessResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+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/operations/getusagehistory.ts

@@ -15,9 +15,13 @@ export type GetUsageHistoryRequest = {
    */
   organizationId?: string | undefined;
   /**
-   * Filter by date.after (RFC 3339 format, e.g., 2024-01-15T09:30:00Z)
+   * Return results after this timestamp (inclusive).
    */
   dateAfter?: Date | undefined;
+  /**
+   * Return results before this timestamp (inclusive).
+   */
+  dateBefore?: Date | undefined;
 };
 
 export type GetUsageHistoryResponse = {
@@ -29,6 +33,7 @@ export type GetUsageHistoryResponse = {
 export type GetUsageHistoryRequest$Outbound = {
   organization_id?: string | undefined;
   "date.after"?: string | undefined;
+  "date.before"?: string | undefined;
 };
 
 /** @internal */
@@ -39,11 +44,13 @@ export const GetUsageHistoryRequest$outboundSchema: z.ZodMiniType<
   z.object({
     organizationId: z.optional(z.string()),
     dateAfter: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    dateBefore: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
   }),
   z.transform((v) => {
     return remap$(v, {
       organizationId: "organization_id",
       dateAfter: "date.after",
+      dateBefore: "date.before",
     });
   }),
 );

package/src/models/operations/grantdocumentaccess.ts

@@ -0,0 +1,137 @@
+/*
+ * 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";
+
+/**
+ * GrantDocumentAccessRequest grants access to one or more recipients.
+ */
+export type GrantDocumentAccessGrantDocumentAccessRequest = {
+  /**
+   * Custom message to include in the notification email.
+   */
+  customMessage?: string | null | undefined;
+  /**
+   * Recipients to grant access to (1-50).
+   */
+  recipients?: Array<components.RecipientGrant> | undefined;
+  /**
+   * Whether to send email notifications.
+   */
+  shouldSendNotification?: boolean | null | undefined;
+};
+
+export type GrantDocumentAccessRequest = {
+  /**
+   * Document ID.
+   */
+  documentId: string;
+  body: GrantDocumentAccessGrantDocumentAccessRequest;
+};
+
+export type GrantDocumentAccessResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GrantDocumentAccessResponse;
+};
+
+/** @internal */
+export type GrantDocumentAccessGrantDocumentAccessRequest$Outbound = {
+  custom_message?: string | null | undefined;
+  recipients?: Array<components.RecipientGrant$Outbound> | undefined;
+  should_send_notification?: boolean | null | undefined;
+};
+
+/** @internal */
+export const GrantDocumentAccessGrantDocumentAccessRequest$outboundSchema:
+  z.ZodMiniType<
+    GrantDocumentAccessGrantDocumentAccessRequest$Outbound,
+    GrantDocumentAccessGrantDocumentAccessRequest
+  > = z.pipe(
+    z.object({
+      customMessage: z.optional(z.nullable(z.string())),
+      recipients: z.optional(z.array(components.RecipientGrant$outboundSchema)),
+      shouldSendNotification: z.optional(z.nullable(z.boolean())),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        customMessage: "custom_message",
+        shouldSendNotification: "should_send_notification",
+      });
+    }),
+  );
+
+export function grantDocumentAccessGrantDocumentAccessRequestToJSON(
+  grantDocumentAccessGrantDocumentAccessRequest:
+    GrantDocumentAccessGrantDocumentAccessRequest,
+): string {
+  return JSON.stringify(
+    GrantDocumentAccessGrantDocumentAccessRequest$outboundSchema.parse(
+      grantDocumentAccessGrantDocumentAccessRequest,
+    ),
+  );
+}
+
+/** @internal */
+export type GrantDocumentAccessRequest$Outbound = {
+  document_id: string;
+  body: GrantDocumentAccessGrantDocumentAccessRequest$Outbound;
+};
+
+/** @internal */
+export const GrantDocumentAccessRequest$outboundSchema: z.ZodMiniType<
+  GrantDocumentAccessRequest$Outbound,
+  GrantDocumentAccessRequest
+> = z.pipe(
+  z.object({
+    documentId: z.string(),
+    body: z.lazy(() =>
+      GrantDocumentAccessGrantDocumentAccessRequest$outboundSchema
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      documentId: "document_id",
+    });
+  }),
+);
+
+export function grantDocumentAccessRequestToJSON(
+  grantDocumentAccessRequest: GrantDocumentAccessRequest,
+): string {
+  return JSON.stringify(
+    GrantDocumentAccessRequest$outboundSchema.parse(grantDocumentAccessRequest),
+  );
+}
+
+/** @internal */
+export const GrantDocumentAccessResponse$inboundSchema: z.ZodMiniType<
+  GrantDocumentAccessResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: components.GrantDocumentAccessResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+export function grantDocumentAccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GrantDocumentAccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GrantDocumentAccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GrantDocumentAccessResponse' from JSON`,
+  );
+}