GetListBuilder
Type parameters
▪ Raw: RawListResponse‹any, any›
▪ I: IncludedGroups
Hierarchy
RequestBuilder‹JsonListResponse‹Raw, I››
↳ GetListBuilder
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
+ new GetListBuilder(httpClient
: HttpClient, uri
: string): GetListBuilder
Overrides RequestBuilder.constructor
Parameters:
Name | Type |
| HttpClient |
| string |
Returns: GetListBuilder
Properties
Protected
limit
Protected
limit• limit: number = DEFAULT_RESOURCE_LIMIT
Inherited from RequestBuilder.limit
Protected
offset
Protected
offset• offset: undefined | number
Inherited from RequestBuilder.offset
Protected
options
Protected
options• options: Options
Inherited from RequestBuilder.options
Protected
page
Protected
page• page: number = 1
Inherited from RequestBuilder.page
Protected
queryParams
Protected
queryParams• queryParams: Record‹string, string›
Inherited from RequestBuilder.queryParams
Protected
resolveIncludedRelationships
Protected
resolveIncludedRelationships• resolveIncludedRelationships: boolean = false
Inherited from RequestBuilder.resolveIncludedRelationships
Protected
sortParams
Protected
sortParams• sortParams: string[] = []
Inherited from RequestBuilder.sortParams
uri
• uri: string
Inherited from RequestBuilder.uri
Accessors
parameters
• get parameters(): Record‹string, string›
Inherited from RequestBuilder.parameters
Returns: Record‹string, string›
Methods
addToResponse
▸ addToResponse(response
: JsonListResponse‹Raw, I› | undefined): this
Parameters:
Name | Type |
| JsonListResponse‹Raw, I› | undefined |
Returns: this
filter
▸ filter(key
: string | string[] | undefined, value
: string | number | boolean | undefined, operator?
: FilterOperator): this
Inherited from RequestBuilder.filter
Parameters:
Name | Type |
| string | string[] | undefined |
| string | number | boolean | undefined |
|
Returns: this
groupIncluded
▸ groupIncluded<Groups>(groups
: Groups): GetListBuilder‹Raw, IncludedGroups‹Groups››
Type parameters:
▪ Groups: IncludedGroupsSchema
Parameters:
Name | Type |
| Groups |
Returns: GetListBuilder‹Raw, IncludedGroups‹Groups››
pageLimit
▸ pageLimit(limit
: number): this
Inherited from RequestBuilder.pageLimit
Parameters:
Name | Type |
| number |
Returns: this
pageNumber
▸ pageNumber(page
: number | string | undefined): this
Inherited from RequestBuilder.pageNumber
Parameters:
Name | Type |
| number | string | undefined |
Returns: this
pageOffset
▸ pageOffset(offset
: number): this
Inherited from RequestBuilder.pageOffset
Parameters:
Name | Type |
| number |
Returns: this
parameter
▸ parameter(key
: string, value
: string | number | boolean | undefined): this
Inherited from RequestBuilder.parameter
Parameters:
Name | Type |
| string |
| string | number | boolean | undefined |
Returns: this
Protected
parseResponse
Protected
parseResponse▸ parseResponse<Raw>(response
: HttpResponse): Promise‹JsonResponse‹Raw››
Inherited from RequestBuilder.parseResponse
Type parameters:
▪ Raw: RawResponse‹any, any›
Parameters:
Name | Type |
| HttpResponse |
Returns: Promise‹JsonResponse‹Raw››
resolveIncluded
▸ resolveIncluded(resolveIncluded?
: undefined | false | true): this
Overrides RequestBuilder.resolveIncluded
Parameters:
Name | Type |
| undefined | false | true |
Returns: this
send
▸ send(options?
: HttpOptions): Promise‹JsonListResponse‹Raw, I››
Overrides RequestBuilder.send
Parameters:
Name | Type |
| HttpOptions |
Returns: Promise‹JsonListResponse‹Raw, I››
sort
▸ sort(key
: string | undefined, order
: SortOrder): this
Inherited from RequestBuilder.sort
Parameters:
Name | Type |
| string | undefined |
|
Returns: this
Last updated