Class ClobApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteClobsWithClobId deleteClobsWithClobIdRaw getClobs getClobsRaw getClobsWithClobId getClobsWithClobIdRaw patchClobsWithClobId patchClobsWithClobIdRaw postClobs postClobsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteClobsWithClobId

  • deleteClobsWithClobId(requestParameters, initOverrides?): Promise<void>

  • Delete clob Delete clobs with clobId

    Parameters

    Returns Promise<void>

deleteClobsWithClobIdRaw

  • deleteClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Delete clob Delete clobs with clobId

    Parameters

    Returns Promise<ApiResponse<void>>

getClobs

  • getClobs(requestParameters?, initOverrides?): Promise<Clobs>

  • Get clobs

    Parameters

    Returns Promise<Clobs>

getClobsRaw

  • getClobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Clobs>>

  • Get clobs

    Parameters

    Returns Promise<ApiResponse<Clobs>>

getClobsWithClobId

  • getClobsWithClobId(requestParameters, initOverrides?): Promise<Clob>

  • Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. For more information about accept header usage, <a href="legacy-format/">see this page. Get clobs with clobId

    Parameters

    Returns Promise<Clob>

getClobsWithClobIdRaw

  • getClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Clob>>

  • Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. For more information about accept header usage, <a href="legacy-format/">see this page. Get clobs with clobId

    Parameters

    Returns Promise<ApiResponse<Clob>>

patchClobsWithClobId

  • patchClobsWithClobId(requestParameters, initOverrides?): Promise<void>

  • Update clob Patch clobs with clobId

    Parameters

    Returns Promise<void>

patchClobsWithClobIdRaw

  • patchClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Update clob Patch clobs with clobId

    Parameters

    Returns Promise<ApiResponse<void>>

postClobs

  • postClobs(requestParameters, initOverrides?): Promise<void>

  • Create new Clob Post clobs

    Parameters

    Returns Promise<void>

postClobsRaw

  • postClobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Create new Clob Post clobs

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    • context: RequestOpts
    • Optional initOverrides: RequestInit

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteClobsWithClobIddeleteClobsWithClobIdRawgetClobsgetClobsRawgetClobsWithClobIdgetClobsWithClobIdRawpatchClobsWithClobIdpatchClobsWithClobIdRawpostClobspostClobsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware