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

    Interface DefaultRequestBuilder

    Builds and executes requests for operations under /v2/projects/default

    interface DefaultRequestBuilder {
        get resources(): ResourcesRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DefaultGetResponse>;
        patch(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DefaultPatchResponse>;
        put(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DefaultPutResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DefaultRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    resources

    Methods

    get patch put toGetRequestInformation toPatchRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To get your default project, send a GET request to /v2/projects/default.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DefaultGetResponse>

      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

    • To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.

      Parameters

      • body: Project

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DefaultPatchResponse>

      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

    • To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.

      Parameters

      • body: Project

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DefaultPutResponse>

      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

    • To get your default project, send a GET request to /v2/projects/default.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.

      Parameters

      • body: Project

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.

      Parameters

      • body: Project

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns DefaultRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods