Access api service definition type

Hierarchy

  • Service

Properties

Properties

space: {
    info: ServiceMethod<{
        can: "space/info";
        nb?: InferCaveats<{}>;
        with: URI<"did:">;
    }, Selectable<SpaceTable>, Failure>;
    recover: ServiceMethod<{
        can: "space/recover";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
        }>;
        with: URI<"did:">;
    }, "/home/runner/work/w3up-client/w3up-client/node_modules/@web3-storage/access/dist/src/types".EncodedDelegation<[{
        can: "*";
        nb?: InferCaveats<{}>;
        with: URI<"did:">;
    }]>[], Failure>;
    recover-validation: ServiceMethod<{
        can: "space/recover-validation";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
        }>;
        with: URI<"did:">;
    }, undefined | "/home/runner/work/w3up-client/w3up-client/node_modules/@web3-storage/access/dist/src/types".EncodedDelegation<[{
        can: "space/recover";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
        }>;
        with: URI<"did:">;
    }]>, Failure>;
}

Type declaration

voucher: {
    claim: ServiceMethod<{
        can: "voucher/claim";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
            product: Schema<URI<`${string}:`>, unknown>;
            service: Schema<undefined | `did:${string}:${string}` & `did:${string}` & Phantom<{
                protocol: "did:";
            }>, any>;
        }>;
        with: URI<"did:">;
    }, undefined | "/home/runner/work/w3up-client/w3up-client/node_modules/@web3-storage/access/dist/src/types".EncodedDelegation<[{
        can: "voucher/redeem";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
            product: Schema<URI<`${string}:`>, unknown>;
            space: Schema<URI<"did:">, unknown>;
        }>;
        with: URI<"did:">;
    }]>, Failure>;
    redeem: ServiceMethod<{
        can: "voucher/redeem";
        nb: InferCaveats<{
            identity: Schema<URI<"mailto:">, unknown>;
            product: Schema<URI<`${string}:`>, unknown>;
            space: Schema<URI<"did:">, unknown>;
        }>;
        with: URI<"did:">;
    }, void, Failure>;
}

Type declaration

Generated using TypeDoc