@dypai-ai/client-sdk - v1.12.0
    Preparing search index...

    Interface TypedApiClient<TMap>

    Cliente API tipado con inferencia de tipos para endpoints. Siempre devuelve { data, error } — mismo patrón que dypai.db. Nunca lanza excepciones: los errores van en el campo error.

    interface TypedApiClient<TMap extends EndpointMap = EndpointMap> {
        delete<TEndpoint extends string>(
            endpoint: EndpointNameAllowedForMethod<TMap, TEndpoint, "DELETE">,
            options?: TypedGetOptions<
                TEndpoint extends keyof TMap
                    ? EndpointParams<TMap, TEndpoint>
                    : Record<string, any>,
            >,
        ): Promise<
            DypaiResponse<
                TEndpoint extends keyof TMap ? EndpointResponse<TMap, TEndpoint> : any,
            >,
        >;
        download(
            endpoint: string,
            body?: any,
            options?: { fileName?: string; params?: Record<string, any> },
        ): Promise<DypaiResponse<void>>;
        get<TEndpoint extends string>(
            endpoint: EndpointNameAllowedForMethod<TMap, TEndpoint, "GET">,
            options?: TypedGetOptions<
                TEndpoint extends keyof TMap
                    ? EndpointParams<TMap, TEndpoint>
                    : Record<string, any>,
            >,
        ): Promise<
            DypaiResponse<
                TEndpoint extends keyof TMap ? EndpointResponse<TMap, TEndpoint> : any,
            >,
        >;
        patch<TEndpoint extends string>(
            endpoint: EndpointNameAllowedForMethod<TMap, TEndpoint, "PATCH">,
            body?: TEndpoint extends keyof TMap
                ? Partial<EndpointBody<TMap, TEndpoint>>
                : any,
            options?: TypedMutationOptions<
                TEndpoint extends keyof TMap
                    ? EndpointParams<TMap, TEndpoint>
                    : Record<string, any>,
            >,
        ): Promise<
            DypaiResponse<
                TEndpoint extends keyof TMap ? EndpointResponse<TMap, TEndpoint> : any,
            >,
        >;
        post<TEndpoint extends string>(
            endpoint: EndpointNameAllowedForMethod<TMap, TEndpoint, "POST">,
            body: TEndpoint extends keyof TMap ? EndpointBody<TMap, TEndpoint> : any,
            options?: TypedMutationOptions<
                TEndpoint extends keyof TMap
                    ? EndpointParams<TMap, TEndpoint>
                    : Record<string, any>,
            >,
        ): Promise<
            DypaiResponse<
                TEndpoint extends keyof TMap ? EndpointResponse<TMap, TEndpoint> : any,
            >,
        >;
        put<TEndpoint extends string>(
            endpoint: EndpointNameAllowedForMethod<TMap, TEndpoint, "PUT">,
            body: TEndpoint extends keyof TMap ? EndpointBody<TMap, TEndpoint> : any,
            options?: TypedMutationOptions<
                TEndpoint extends keyof TMap
                    ? EndpointParams<TMap, TEndpoint>
                    : Record<string, any>,
            >,
        ): Promise<
            DypaiResponse<
                TEndpoint extends keyof TMap ? EndpointResponse<TMap, TEndpoint> : any,
            >,
        >;
        upload(
            endpoint: string,
            file: File,
            options?: ApiUploadOptions,
        ): Promise<DypaiResponse<any>>;
    }

    Type Parameters

    Index

    Methods

    • Descarga un archivo a través de un endpoint con nodo dypai_storage

      Parameters

      • endpoint: string
      • Optionalbody: any
      • Optionaloptions: { fileName?: string; params?: Record<string, any> }

      Returns Promise<DypaiResponse<void>>

    post