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

    Interface ProposeRequestBuilder

    Builds and executes requests for operations under /v2/apps/propose

    interface ProposeRequestBuilder {
        post(
            body: App_propose,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | App_propose_response>;
        toPostRequestInformation(
            body: App_propose,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ProposeRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

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

      To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.

      Parameters

      • body: App_propose

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | App_propose_response>

      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 propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.

      Parameters

      • body: App_propose

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ProposeRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods