-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathcompany_scroll.py
More file actions
34 lines (25 loc) · 1 KB
/
company_scroll.py
File metadata and controls
34 lines (25 loc) · 1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from typing import List, Optional
from typing_extensions import Literal
from .._models import BaseModel
from .shared.company import Company
from .shared.cursor_pages import CursorPages
__all__ = ["CompanyScroll"]
class CompanyScroll(BaseModel):
data: Optional[List[Company]] = None
pages: Optional[CursorPages] = None
"""
Cursor-based pagination is a technique used in the Intercom API to navigate
through large amounts of data. A "cursor" or pointer is used to keep track of
the current position in the result set, allowing the API to return the data in
small chunks or "pages" as needed.
"""
scroll_param: Optional[str] = None
"""
The scroll parameter to use in the next request to fetch the next page of
results.
"""
total_count: Optional[int] = None
"""The total number of companies"""
type: Optional[Literal["list"]] = None
"""The type of object - `list`"""