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

    Interface NamespacesRequestBuilder

    Builds and executes requests for operations under /v2/functions/namespaces

    interface NamespacesRequestBuilder {
        byNamespace_id(namespace_id: string): WithNamespace_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | NamespacesGetResponse>;
        post(
            body: Create_namespace,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | NamespacesPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Create_namespace,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): NamespacesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byNamespace_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | NamespacesGetResponse>

      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

    post

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

      Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.

      Parameters

      • body: Create_namespace

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | NamespacesPostResponse>

      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

    • Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.

      Parameters

      • body: Create_namespace

        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