@cloudpdf/sdk 3.0.0-next.12 → 3.0.0-next.13

package/dist/esm/api/types/DocSignaturesComplete200Response.d.mts

@@ -0,0 +1,204 @@
+import type * as CloudPDF from "../index.mjs";
+export interface DocSignaturesComplete200Response {
+    status: DocSignaturesComplete200Response.Status;
+    signature: DocSignaturesComplete200Response.Signature;
+    version: DocSignaturesComplete200Response.Version;
+    previous: DocSignaturesComplete200Response.Previous;
+    protection: DocSignaturesComplete200Response.Protection;
+    meta: DocSignaturesComplete200Response.Meta;
+}
+export declare namespace DocSignaturesComplete200Response {
+    const Status: {
+        readonly Completed: "completed";
+        readonly AlreadyCompleted: "already-completed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    interface Signature {
+        index: number;
+        field: CloudPDF.DocSignaturesComplete200ResponseSignatureField;
+        fieldName: string;
+        widget: Signature.Widget | null;
+        signed: boolean;
+        kind: Signature.Kind;
+        filter: string | null;
+        subFilter: string | null;
+        byteRange: unknown[] | null;
+        contentsSize: number;
+        coverage: Signature.Coverage | null;
+        revisionIndex: number | null;
+        signer: Signature.Signer;
+        docMdp: number | null;
+        catalogCertification: boolean;
+        fieldMdp: Signature.FieldMdp | null;
+        lock: Signature.Lock | null;
+        seedValue: Signature.SeedValue | null;
+    }
+    namespace Signature {
+        interface Widget {
+            annotObjectNumber: number;
+            pageObjectNumber: number;
+        }
+        const Kind: {
+            readonly Signature: "signature";
+            readonly Timestamp: "timestamp";
+        };
+        type Kind = (typeof Kind)[keyof typeof Kind];
+        const Coverage: {
+            readonly WholeRevision: "whole-revision";
+            readonly Partial: "partial";
+            readonly Malformed: "malformed";
+        };
+        type Coverage = (typeof Coverage)[keyof typeof Coverage];
+        interface Signer {
+            name: string | null;
+            reason: string | null;
+            location: string | null;
+            contactInfo: string | null;
+            claimedTime: string | null;
+        }
+        interface FieldMdp {
+            action: FieldMdp.Action;
+            fields: string[];
+            permission?: (number | null) | undefined;
+        }
+        namespace FieldMdp {
+            const Action: {
+                readonly All: "all";
+                readonly Include: "include";
+                readonly Exclude: "exclude";
+            };
+            type Action = (typeof Action)[keyof typeof Action];
+        }
+        interface Lock {
+            action: Lock.Action;
+            fields: string[];
+            permission?: (number | null) | undefined;
+        }
+        namespace Lock {
+            const Action: {
+                readonly All: "all";
+                readonly Include: "include";
+                readonly Exclude: "exclude";
+            };
+            type Action = (typeof Action)[keyof typeof Action];
+        }
+        interface SeedValue {
+            requiredFlags: number;
+            presentFlags: number;
+            version: number | null;
+            mdp: number | null;
+            filter: string | null;
+            subFilters: string[];
+            digestMethods: string[];
+            reasons: string[];
+            unsupportedRequired: boolean;
+        }
+    }
+    interface Version {
+        sha256: string;
+        byteLength: number;
+    }
+    interface Previous {
+        baseSha256: string;
+        editsVersion: number;
+    }
+    interface Protection {
+        enforced: Protection.Enforced | null;
+        judged: Protection.Judged | null;
+        certification: Protection.Certification | null;
+        fieldLocks: Protection.FieldLocks.Item[];
+        policyVersion: number;
+    }
+    namespace Protection {
+        const Enforced: {
+            readonly None: "none";
+            readonly Lta: "lta";
+            readonly Fill: "fill";
+            readonly Annotate: "annotate";
+        };
+        type Enforced = (typeof Enforced)[keyof typeof Enforced];
+        const Judged: {
+            readonly None: "none";
+            readonly Lta: "lta";
+            readonly Fill: "fill";
+            readonly Annotate: "annotate";
+        };
+        type Judged = (typeof Judged)[keyof typeof Judged];
+        interface Certification {
+            signatureIndex: number;
+            permission: number | null;
+        }
+        type FieldLocks = FieldLocks.Item[];
+        namespace FieldLocks {
+            interface Item {
+                signatureIndex: number;
+                source: Item.Source;
+                spec: Item.Spec | null;
+            }
+            namespace Item {
+                const Source: {
+                    readonly Fieldmdp: "fieldmdp";
+                    readonly Lock: "lock";
+                };
+                type Source = (typeof Source)[keyof typeof Source];
+                interface Spec {
+                    action: Spec.Action;
+                    fields: string[];
+                    permission?: (number | null) | undefined;
+                }
+                namespace Spec {
+                    const Action: {
+                        readonly All: "all";
+                        readonly Include: "include";
+                        readonly Exclude: "exclude";
+                    };
+                    type Action = (typeof Action)[keyof typeof Action];
+                }
+            }
+        }
+    }
+    interface Meta {
+        affectedPages: Meta.AffectedPages.Item[];
+        cacheDelta: Meta.CacheDelta | null;
+    }
+    namespace Meta {
+        type AffectedPages = AffectedPages.Item[];
+        namespace AffectedPages {
+            interface Item {
+                pageObjectNumber: number;
+                revision: Item.Revision;
+                weakAnnotationState: CloudPDF.DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState;
+            }
+            namespace Item {
+                interface Revision {
+                    docSessionId: string;
+                    pageObjectNumber: number;
+                    generation: number;
+                }
+            }
+        }
+        interface CacheDelta {
+            previousDocVersion: number;
+            docVersion: number;
+            annotationsVersion?: number | undefined;
+            layerVersion?: number | undefined;
+            working?: boolean | undefined;
+            pages: CacheDelta.Pages.Item[];
+        }
+        namespace CacheDelta {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    pageObjectNumber: number;
+                    cache: Item.Cache;
+                }
+                namespace Item {
+                    interface Cache {
+                        contentVersion: number;
+                        annotationVersion: number;
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/esm/api/types/DocSignaturesComplete200Response.mjs

@@ -0,0 +1,69 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DocSignaturesComplete200Response;
+(function (DocSignaturesComplete200Response) {
+    DocSignaturesComplete200Response.Status = {
+        Completed: "completed",
+        AlreadyCompleted: "already-completed",
+    };
+    let Signature;
+    (function (Signature) {
+        Signature.Kind = {
+            Signature: "signature",
+            Timestamp: "timestamp",
+        };
+        Signature.Coverage = {
+            WholeRevision: "whole-revision",
+            Partial: "partial",
+            Malformed: "malformed",
+        };
+        let FieldMdp;
+        (function (FieldMdp) {
+            FieldMdp.Action = {
+                All: "all",
+                Include: "include",
+                Exclude: "exclude",
+            };
+        })(FieldMdp = Signature.FieldMdp || (Signature.FieldMdp = {}));
+        let Lock;
+        (function (Lock) {
+            Lock.Action = {
+                All: "all",
+                Include: "include",
+                Exclude: "exclude",
+            };
+        })(Lock = Signature.Lock || (Signature.Lock = {}));
+    })(Signature = DocSignaturesComplete200Response.Signature || (DocSignaturesComplete200Response.Signature = {}));
+    let Protection;
+    (function (Protection) {
+        Protection.Enforced = {
+            None: "none",
+            Lta: "lta",
+            Fill: "fill",
+            Annotate: "annotate",
+        };
+        Protection.Judged = {
+            None: "none",
+            Lta: "lta",
+            Fill: "fill",
+            Annotate: "annotate",
+        };
+        let FieldLocks;
+        (function (FieldLocks) {
+            let Item;
+            (function (Item) {
+                Item.Source = {
+                    Fieldmdp: "fieldmdp",
+                    Lock: "lock",
+                };
+                let Spec;
+                (function (Spec) {
+                    Spec.Action = {
+                        All: "all",
+                        Include: "include",
+                        Exclude: "exclude",
+                    };
+                })(Spec = Item.Spec || (Item.Spec = {}));
+            })(Item = FieldLocks.Item || (FieldLocks.Item = {}));
+        })(FieldLocks = Protection.FieldLocks || (Protection.FieldLocks = {}));
+    })(Protection = DocSignaturesComplete200Response.Protection || (DocSignaturesComplete200Response.Protection = {}));
+})(DocSignaturesComplete200Response || (DocSignaturesComplete200Response = {}));

package/dist/esm/api/types/DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState.d.mts

@@ -0,0 +1,11 @@
+import type * as CloudPDF from "../index.mjs";
+export type DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState = CloudPDF.DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState.Unknown | CloudPDF.DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState.Known;
+export declare namespace DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState {
+    interface Unknown {
+        kind: "unknown";
+    }
+    interface Known {
+        kind: "known";
+        hasAnyWeakAnnotations: boolean;
+    }
+}

package/dist/esm/api/types/DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DocSignaturesComplete200ResponseSignatureField.d.mts

@@ -0,0 +1,12 @@
+import type * as CloudPDF from "../index.mjs";
+export type DocSignaturesComplete200ResponseSignatureField = CloudPDF.DocSignaturesComplete200ResponseSignatureField.ObjectNumber | CloudPDF.DocSignaturesComplete200ResponseSignatureField.Fqn;
+export declare namespace DocSignaturesComplete200ResponseSignatureField {
+    interface ObjectNumber {
+        kind: "objectNumber";
+        fieldObjectNumber: number;
+    }
+    interface Fqn {
+        kind: "fqn";
+        name: string;
+    }
+}

package/dist/esm/api/types/DocSignaturesComplete200ResponseSignatureField.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DocSignaturesComplete400Response.d.mts

@@ -0,0 +1,40 @@
+export interface DocSignaturesComplete400Response {
+    name: DocSignaturesComplete400Response.Name;
+    code: DocSignaturesComplete400Response.Code;
+    message: string;
+    details?: Record<string, unknown> | undefined;
+}
+export declare namespace DocSignaturesComplete400Response {
+    const Name: {
+        readonly EngineError: "EngineError";
+    };
+    type Name = (typeof Name)[keyof typeof Name];
+    const Code: {
+        readonly Unknown: "Unknown";
+        readonly InvalidArg: "InvalidArg";
+        readonly DocNotOpen: "DocNotOpen";
+        readonly DocOpenFailed: "DocOpenFailed";
+        readonly DocPasswordRequired: "DocPasswordRequired";
+        readonly DocPasswordIncorrect: "DocPasswordIncorrect";
+        readonly SharePasswordRequired: "SharePasswordRequired";
+        readonly Aborted: "Aborted";
+        readonly Network: "Network";
+        readonly Unauthenticated: "Unauthenticated";
+        readonly Forbidden: "Forbidden";
+        readonly NotFound: "NotFound";
+        readonly WireFormat: "WireFormat";
+        readonly RuntimeUnavailable: "RuntimeUnavailable";
+        readonly InvalidReference: "InvalidReference";
+        readonly WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict";
+        readonly LayerVersionConflict: "LayerVersionConflict";
+        readonly NotImplemented: "NotImplemented";
+        readonly MalformedPdf: "MalformedPdf";
+        readonly SigningPending: "SigningPending";
+        readonly SigningExpired: "SigningExpired";
+        readonly SigningVersionMismatch: "SigningVersionMismatch";
+        readonly SignatureRefused: "SignatureRefused";
+        readonly ProtectedDocument: "ProtectedDocument";
+        readonly StaleBase: "StaleBase";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+}

package/dist/esm/api/types/DocSignaturesComplete400Response.mjs

@@ -0,0 +1,34 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DocSignaturesComplete400Response;
+(function (DocSignaturesComplete400Response) {
+    DocSignaturesComplete400Response.Name = {
+        EngineError: "EngineError",
+    };
+    DocSignaturesComplete400Response.Code = {
+        Unknown: "Unknown",
+        InvalidArg: "InvalidArg",
+        DocNotOpen: "DocNotOpen",
+        DocOpenFailed: "DocOpenFailed",
+        DocPasswordRequired: "DocPasswordRequired",
+        DocPasswordIncorrect: "DocPasswordIncorrect",
+        SharePasswordRequired: "SharePasswordRequired",
+        Aborted: "Aborted",
+        Network: "Network",
+        Unauthenticated: "Unauthenticated",
+        Forbidden: "Forbidden",
+        NotFound: "NotFound",
+        WireFormat: "WireFormat",
+        RuntimeUnavailable: "RuntimeUnavailable",
+        InvalidReference: "InvalidReference",
+        WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
+        LayerVersionConflict: "LayerVersionConflict",
+        NotImplemented: "NotImplemented",
+        MalformedPdf: "MalformedPdf",
+        SigningPending: "SigningPending",
+        SigningExpired: "SigningExpired",
+        SigningVersionMismatch: "SigningVersionMismatch",
+        SignatureRefused: "SignatureRefused",
+        ProtectedDocument: "ProtectedDocument",
+        StaleBase: "StaleBase",
+    };
+})(DocSignaturesComplete400Response || (DocSignaturesComplete400Response = {}));

package/dist/esm/api/types/DocSignaturesComplete404Response.d.mts

@@ -0,0 +1,40 @@
+export interface DocSignaturesComplete404Response {
+    name: DocSignaturesComplete404Response.Name;
+    code: DocSignaturesComplete404Response.Code;
+    message: string;
+    details?: Record<string, unknown> | undefined;
+}
+export declare namespace DocSignaturesComplete404Response {
+    const Name: {
+        readonly EngineError: "EngineError";
+    };
+    type Name = (typeof Name)[keyof typeof Name];
+    const Code: {
+        readonly Unknown: "Unknown";
+        readonly InvalidArg: "InvalidArg";
+        readonly DocNotOpen: "DocNotOpen";
+        readonly DocOpenFailed: "DocOpenFailed";
+        readonly DocPasswordRequired: "DocPasswordRequired";
+        readonly DocPasswordIncorrect: "DocPasswordIncorrect";
+        readonly SharePasswordRequired: "SharePasswordRequired";
+        readonly Aborted: "Aborted";
+        readonly Network: "Network";
+        readonly Unauthenticated: "Unauthenticated";
+        readonly Forbidden: "Forbidden";
+        readonly NotFound: "NotFound";
+        readonly WireFormat: "WireFormat";
+        readonly RuntimeUnavailable: "RuntimeUnavailable";
+        readonly InvalidReference: "InvalidReference";
+        readonly WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict";
+        readonly LayerVersionConflict: "LayerVersionConflict";
+        readonly NotImplemented: "NotImplemented";
+        readonly MalformedPdf: "MalformedPdf";
+        readonly SigningPending: "SigningPending";
+        readonly SigningExpired: "SigningExpired";
+        readonly SigningVersionMismatch: "SigningVersionMismatch";
+        readonly SignatureRefused: "SignatureRefused";
+        readonly ProtectedDocument: "ProtectedDocument";
+        readonly StaleBase: "StaleBase";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+}

package/dist/esm/api/types/DocSignaturesComplete404Response.mjs

@@ -0,0 +1,34 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DocSignaturesComplete404Response;
+(function (DocSignaturesComplete404Response) {
+    DocSignaturesComplete404Response.Name = {
+        EngineError: "EngineError",
+    };
+    DocSignaturesComplete404Response.Code = {
+        Unknown: "Unknown",
+        InvalidArg: "InvalidArg",
+        DocNotOpen: "DocNotOpen",
+        DocOpenFailed: "DocOpenFailed",
+        DocPasswordRequired: "DocPasswordRequired",
+        DocPasswordIncorrect: "DocPasswordIncorrect",
+        SharePasswordRequired: "SharePasswordRequired",
+        Aborted: "Aborted",
+        Network: "Network",
+        Unauthenticated: "Unauthenticated",
+        Forbidden: "Forbidden",
+        NotFound: "NotFound",
+        WireFormat: "WireFormat",
+        RuntimeUnavailable: "RuntimeUnavailable",
+        InvalidReference: "InvalidReference",
+        WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
+        LayerVersionConflict: "LayerVersionConflict",
+        NotImplemented: "NotImplemented",
+        MalformedPdf: "MalformedPdf",
+        SigningPending: "SigningPending",
+        SigningExpired: "SigningExpired",
+        SigningVersionMismatch: "SigningVersionMismatch",
+        SignatureRefused: "SignatureRefused",
+        ProtectedDocument: "ProtectedDocument",
+        StaleBase: "StaleBase",
+    };
+})(DocSignaturesComplete404Response || (DocSignaturesComplete404Response = {}));

package/dist/esm/api/types/DocSignaturesComplete409Response.d.mts

@@ -0,0 +1,40 @@
+export interface DocSignaturesComplete409Response {
+    name: DocSignaturesComplete409Response.Name;
+    code: DocSignaturesComplete409Response.Code;
+    message: string;
+    details?: Record<string, unknown> | undefined;
+}
+export declare namespace DocSignaturesComplete409Response {
+    const Name: {
+        readonly EngineError: "EngineError";
+    };
+    type Name = (typeof Name)[keyof typeof Name];
+    const Code: {
+        readonly Unknown: "Unknown";
+        readonly InvalidArg: "InvalidArg";
+        readonly DocNotOpen: "DocNotOpen";
+        readonly DocOpenFailed: "DocOpenFailed";
+        readonly DocPasswordRequired: "DocPasswordRequired";
+        readonly DocPasswordIncorrect: "DocPasswordIncorrect";
+        readonly SharePasswordRequired: "SharePasswordRequired";
+        readonly Aborted: "Aborted";
+        readonly Network: "Network";
+        readonly Unauthenticated: "Unauthenticated";
+        readonly Forbidden: "Forbidden";
+        readonly NotFound: "NotFound";
+        readonly WireFormat: "WireFormat";
+        readonly RuntimeUnavailable: "RuntimeUnavailable";
+        readonly InvalidReference: "InvalidReference";
+        readonly WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict";
+        readonly LayerVersionConflict: "LayerVersionConflict";
+        readonly NotImplemented: "NotImplemented";
+        readonly MalformedPdf: "MalformedPdf";
+        readonly SigningPending: "SigningPending";
+        readonly SigningExpired: "SigningExpired";
+        readonly SigningVersionMismatch: "SigningVersionMismatch";
+        readonly SignatureRefused: "SignatureRefused";
+        readonly ProtectedDocument: "ProtectedDocument";
+        readonly StaleBase: "StaleBase";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+}

package/dist/esm/api/types/DocSignaturesComplete409Response.mjs

@@ -0,0 +1,34 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DocSignaturesComplete409Response;
+(function (DocSignaturesComplete409Response) {
+    DocSignaturesComplete409Response.Name = {
+        EngineError: "EngineError",
+    };
+    DocSignaturesComplete409Response.Code = {
+        Unknown: "Unknown",
+        InvalidArg: "InvalidArg",
+        DocNotOpen: "DocNotOpen",
+        DocOpenFailed: "DocOpenFailed",
+        DocPasswordRequired: "DocPasswordRequired",
+        DocPasswordIncorrect: "DocPasswordIncorrect",
+        SharePasswordRequired: "SharePasswordRequired",
+        Aborted: "Aborted",
+        Network: "Network",
+        Unauthenticated: "Unauthenticated",
+        Forbidden: "Forbidden",
+        NotFound: "NotFound",
+        WireFormat: "WireFormat",
+        RuntimeUnavailable: "RuntimeUnavailable",
+        InvalidReference: "InvalidReference",
+        WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
+        LayerVersionConflict: "LayerVersionConflict",
+        NotImplemented: "NotImplemented",
+        MalformedPdf: "MalformedPdf",
+        SigningPending: "SigningPending",
+        SigningExpired: "SigningExpired",
+        SigningVersionMismatch: "SigningVersionMismatch",
+        SignatureRefused: "SignatureRefused",
+        ProtectedDocument: "ProtectedDocument",
+        StaleBase: "StaleBase",
+    };
+})(DocSignaturesComplete409Response || (DocSignaturesComplete409Response = {}));