@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface UrlRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/oauth2/url

    interface UrlRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                UrlRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiGenerateOauth2URLOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                UrlRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): UrlRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    • To generate an Oauth2-URL for use with your localhost, send a GET request to /v2/gen-ai/oauth2/url. Pass 'http://localhost:3000 as redirect_url

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<UrlRequestBuilderGetQueryParameters>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiGenerateOauth2URLOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • Parameters

      • rawUrl: string

      Returns UrlRequestBuilder