shipstation-client
Version:
ShipStation V2 SDK
28 lines (20 loc) • 1.4 kB
Markdown
# PaginationLink
Helpful links to other pages of results
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**first** | [**Link**](Link.md) | The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. | [default to undefined]
**last** | [**Link**](Link.md) | The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. | [default to undefined]
**prev** | [**OptionalLink**](OptionalLink.md) | The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. | [default to undefined]
**next** | [**OptionalLink**](OptionalLink.md) | The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. | [default to undefined]
## Example
```typescript
import { PaginationLink } from 'shipstation-client';
const instance: PaginationLink = {
first,
last,
prev,
next,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)