Class ApiResponse<T>

ApiResponse - A generic response object for API requests.

Type Parameters

T

Constructors

constructor

new ApiResponse<T>(statusCode, message, data): ApiResponse<T>
Type Parameters
- T
Parameters
- statusCode: number
  The status code of the response.
- message: string
  The message of the response.
- data: null | T
  The data of the response.
Returns ApiResponse<T>
- A new instance of the ApiResponse class.
- Defined in models/ApiResponse.ts:81

Properties

data

data: null | T

isSuccessful

isSuccessful: boolean

message

message: string

statusCode

statusCode: number

Methods

asAppCollectionType

asAppCollectionType(): ApiResponse<CollectionResponse<App>>
Returns ApiResponse<CollectionResponse<App>>
- An ApiResponse<CollectionResponse>.
Method
asAppCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.
- Defined in models/ApiResponse.ts:138

asAppType

asAppType(): ApiResponse<App>
Returns ApiResponse<App>
- An ApiResponse.
Method
asAppType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:118

asCreatedWithIdResponseType

asCreatedWithIdResponseType<T>(): ApiResponse<CreatedWithIdResponse<T>>
Type Parameters
- T
Returns ApiResponse<CreatedWithIdResponse<T>>
- An ApiResponse<CreatedWithIdResponse>.
Method
asCreatedWithIdResponseType - Converts the ApiResponse to an ApiResponse<CreatedWithIdResponse>.
- Defined in models/ApiResponse.ts:225

asFieldCollectionType

asFieldCollectionType(): ApiResponse<CollectionResponse<Field>>
Returns ApiResponse<CollectionResponse<Field>>
- An ApiResponse<CollectionResponse>.
Method
asFieldCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.
- Defined in models/ApiResponse.ts:176

asFieldType

asFieldType(): ApiResponse<Field>
Returns ApiResponse<Field>
- An ApiResponse.
Method
asFieldType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:161

asFileInfoType

asFileInfoType(): ApiResponse<FileInfo>
Returns ApiResponse<FileInfo>
- An ApiResponse.
Method
asFileInfoType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:245

asFileType

asFileType(response): ApiResponse<File>
Parameters
- response: AxiosResponse<any, any>
Returns ApiResponse<File>
- An ApiResponse.
Method
asFileType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:270

asGetPagedAppsResponseType

asGetPagedAppsResponseType(): ApiResponse<GetPagedAppsResponse>
Returns ApiResponse<GetPagedAppsResponse>
- An ApiResponse.
Method
asGetPagedAppsResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:92

asGetPagedFieldsResponseType

asGetPagedFieldsResponseType(): ApiResponse<GetPagedFieldsResponse>
Returns ApiResponse<GetPagedFieldsResponse>
- An ApiResponse.
Method
asGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:199

asGetPagedRecordsResponseType

asGetPagedRecordsResponseType(): ApiResponse<GetPagedRecordsResponse>
Returns ApiResponse<GetPagedRecordsResponse>
- An ApiResponse.
Method
asGetPagedRecordsResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:368

asGetPagedReportsResponseType

asGetPagedReportsResponseType(): ApiResponse<GetPagedReportsResponse>
Returns ApiResponse<GetPagedReportsResponse>
- An ApiResponse.
Method
asGetPagedReportsResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:322

asListItemResponseType

asListItemResponseType(): ApiResponse<ListItemResponse>
Returns ApiResponse<ListItemResponse>
- An ApiResponse.
Method
asListItemResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:306

asRecordCollectionType

asRecordCollectionType(): ApiResponse<CollectionResponse<Record>>
Returns ApiResponse<CollectionResponse<Record>>
- An ApiResponse<CollectionResponse>.
Method
asRecordCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.
- Defined in models/ApiResponse.ts:423

asRecordType

asRecordType(): ApiResponse<Record>
Returns ApiResponse<Record>
- An ApiResponse.
Method
asRecordType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:398

asReportDataType

asReportDataType(): ApiResponse<ReportData>
Returns ApiResponse<ReportData>
- An ApiResponse.
Method
asReportDataType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:348

asSaveRecordResponseType

asSaveRecordResponseType(): ApiResponse<SaveRecordResponse>
Returns ApiResponse<SaveRecordResponse>
- An ApiResponse.
Method
asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse.
- Defined in models/ApiResponse.ts:450

`Static` `Private` convertToAttachment

convertToAttachment(attachmentItem): Attachment
Parameters
- attachmentItem: any
  The attachment item to convert.
Returns Attachment
- The converted attachment object.
Method
convertToAttachment - Converts the attachment item to the appropriate attachment object.
- Defined in models/ApiResponse.ts:706

`Static` `Private` convertToDelegate

convertToDelegate(delegateItem): Delegate
Parameters
- delegateItem: any
  The delegate item to convert.
Returns Delegate
- The converted Delegate object.
Method
convertToDelegate - Converts the delegate item to a Delegate object.
- Defined in models/ApiResponse.ts:655

`Static` `Private` convertToScoringGroup

convertToScoringGroup(scoringGroupItem): ScoringGroup
Parameters
- scoringGroupItem: any
  The scoring group item to convert.
Returns ScoringGroup
- The converted scoring group object.
Method
convertToScoringGroup - Converts the scoring group item to the appropriate scoring group object.
- Defined in models/ApiResponse.ts:692

`Static` `Private` convertToTimeSpanData

convertToTimeSpanData(timeSpanItem): TimeSpanData
Parameters
- timeSpanItem: any
  The time span item to convert.
Returns TimeSpanData
- The converted time span data object.
Method
convertToTimeSpanData - Converts the time span item to the appropriate time span data object.
- Defined in models/ApiResponse.ts:735

`Static` `Private` getFieldByType

getFieldByType(fieldItem): Field
Parameters
- fieldItem: any
  The field item to convert.
Returns Field
- The converted field object.
Method
getFieldByType - Converts the field item to the appropriate field object based upon the field item's type.

Throws
- If the field item's type is unknown.
- Defined in models/ApiResponse.ts:579

`Static` `Private` getListValues

getListValues(fieldItem): ListValue[]
Parameters
- fieldItem: any
  The field item whose values should be converted.
Returns ListValue[]
- The converted list values.
Method
getListValues - Converts the field items list values to a ListValue[].
- Defined in models/ApiResponse.ts:786

`Static` `Private` getRecordValueByType

getRecordValueByType(recordValueItem): RecordValue<any>
Parameters
- recordValueItem: any
  The record value item.
Returns RecordValue<any>
- The RecordValue.
Method
getRecordValueByType - Gets the RecordValue by by type.
- Defined in models/ApiResponse.ts:468