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

    Interface ProjectsRequestBuilder

    Builds and executes requests for operations under /v2/projects

    interface ProjectsRequestBuilder {
        get defaultEscaped(): DefaultRequestBuilder;
        byProject_id(project_id: string): WithProject_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                ProjectsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ProjectsGetResponse>;
        post(
            body: Project_base,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ProjectsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ProjectsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Project_base,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ProjectsRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    defaultEscaped

    Methods

    byProject_id get post toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    post

    • post(
          body: Project_base,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ProjectsPostResponse>

      To create a project, send a POST request to /v2/projects.

      Parameters

      • body: Project_base

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ProjectsPostResponse>

      error when the service returns a 401 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 create a project, send a POST request to /v2/projects.

      Parameters

      • body: Project_base

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ProjectsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods