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

    Interface WithPa_ItemRequestBuilder

    Builds and executes requests for operations under /v2/partner_network_connect/attachments/{pa_id}

    interface WithPa_ItemRequestBuilder {
        get bgp_auth_key(): Bgp_auth_keyRequestBuilder;
        get remote_routes(): Remote_routesRequestBuilder;
        get service_key(): Service_keyRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithPa_DeleteResponse>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithPa_GetResponse>;
        patch(
            body:
                | Partner_attachment_updatableMember1
                | Partner_attachment_updatableMember2
                | Partner_attachment_updatableMember3,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithPa_PatchResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body:
                | Partner_attachment_updatableMember1
                | Partner_attachment_updatableMember2
                | Partner_attachment_updatableMember3,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithPa_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    bgp_auth_key remote_routes service_key

    Methods

    delete get patch toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation withUrl

    Accessors

    Methods

    • To delete an existing partner attachment, send a DELETE request to/v2/partner_network_connect/attachments/{pa_id}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithPa_DeleteResponse>

      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 the details of a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithPa_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 an existing partner attachment, send a PATCH request to/v2/partner_network_connect/attachments/{pa_id} with a JSON object containing thefields to be updated.

      Parameters

      • body:
            | Partner_attachment_updatableMember1
            | Partner_attachment_updatableMember2
            | Partner_attachment_updatableMember3

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithPa_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 delete an existing partner attachment, send a DELETE request to/v2/partner_network_connect/attachments/{pa_id}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To get the details of a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update an existing partner attachment, send a PATCH request to/v2/partner_network_connect/attachments/{pa_id} with a JSON object containing thefields to be updated.

      Parameters

      • body:
            | Partner_attachment_updatableMember1
            | Partner_attachment_updatableMember2
            | Partner_attachment_updatableMember3

        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