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

    Interface WithProject_ItemRequestBuilder

    Builds and executes requests for operations under /v2/projects/{project_id}

    interface WithProject_ItemRequestBuilder {
        get resources(): ResourcesRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithProject_GetResponse>;
        patch(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithProject_PatchResponse>;
        put(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithProject_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Project,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithProject_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    resources

    Methods

    delete get patch put toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. Tobe deleted, a project must not have any resources assigned to it. Any existingresources must first be reassigned or destroyed, or you will receive a 412 error.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 412 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 a project, send a GET request to /v2/projects/$PROJECT_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithProject_GetResponse>

      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 a project, send a PATCH request to /v2/projects/$PROJECT_ID. 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 | WithProject_PatchResponse>

      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 a project, send a PUT request to /v2/projects/$PROJECT_ID. 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 | WithProject_PutResponse>

      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 delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. Tobe deleted, a project must not have any resources assigned to it. Any existingresources must first be reassigned or destroyed, or you will receive a 412 error.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To get a project, send a GET request to /v2/projects/$PROJECT_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. 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 a project, send a PUT request to /v2/projects/$PROJECT_ID. 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

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods