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

    Interface AttachmentsRequestBuilder

    Builds and executes requests for operations under /v2/partner_network_connect/attachments

    interface AttachmentsRequestBuilder {
        byPa_id(pa_id: string): WithPa_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AttachmentsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | AttachmentsGetResponse>;
        post(
            body: Partner_attachment_writable,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | AttachmentsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AttachmentsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Partner_attachment_writable,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AttachmentsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byPa_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

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

      To create a new partner attachment, send a POST request to/v2/partner_network_connect/attachments with a JSON object containing therequired configuration details.

      Parameters

      • body: Partner_attachment_writable

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | AttachmentsPostResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 422 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 new partner attachment, send a POST request to/v2/partner_network_connect/attachments with a JSON object containing therequired configuration details.

      Parameters

      • body: Partner_attachment_writable

        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

    Methods