Class ModelListHttpOp<M, D, RESP, RESULT>

ProtectedapiVersion

ProtectedaxiosPromise

ProtectedbaseURL

Protectedconfig

Protected OptionalurlContext

Protected StaticoperationId

ProtectedbuildUrl

• buildUrl(): string

  Redefined function query url Builder

  Returns string

ProtectedgetConfig

• getConfig(): IOpConfig<M, D>

  Returns IOpConfig<M, D>

ProtectedgetOperationResponseData

• getOperationResponseData(value: AxiosResponse): RESP

  Returns data according to the operation settings from the query result

  Parameters

  • value: AxiosResponse

  Returns RESP

ProtectedgetOperationResponseDataRaw

• getOperationResponseDataRaw(value: Record<string, any>): undefined | RESP

  return raw data from responce

  Parameters

  • value: Record<string, any>

  Returns undefined | RESP

ProtectedgetRequestConfig

• getRequestConfig(): AxiosRequestConfig<D>

  Returns the prepared config for the request via Axios

  Returns AxiosRequestConfig<D>

ProtectedgetRootProperty

• getRootProperty(): string | string[]

  Returns the name of the property where the expected data is stored

  Returns string | string[]

ProtectedgetSuccessProperty

• getSuccessProperty(): string

  Returns the name of the property that contains the request success flag

  Returns string

ProtectedgetSuccessStatusCode

• getSuccessStatusCode(): number

  Returns the response code that is considered successful

  Returns number

ProtectedgetUrlContext

• getUrlContext(): UrlContextType

  Returns UrlContextType

ProtectedisSuccessRequestData

• isSuccessRequestData(data: Record<string, any>): boolean

  Returns true if the data has a success flag

  Parameters

  • data: Record<string, any>

  Returns boolean

ProtectedresponseDataValid

• responseDataValid(value: AxiosResponse): boolean | Error

  Returns true if the data is valid and applicable to the successful result of the operation

  Parameters

  • value: AxiosResponse

  Returns boolean | Error

Protectedsuccess

• success(value: AxiosResponse): Promise<Response<RESP, RESULT>>

  Handler the successful completion of the request

  Parameters

  • value: AxiosResponse

  Returns Promise<Response<RESP, RESULT>>