Skip to content

refactor: allow total_count and remaining_count of pagination results to be null #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jason-rl wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor: allow total_count and remaining_count of pagination results to be null #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 42 additions & 42 deletions src/pagination.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export interface BlueprintsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface BlueprintsCursorIDPageParams {
Expand All @@ -24,7 +24,7 @@ export class BlueprintsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -36,7 +36,7 @@ export class BlueprintsCursorIDPage<Item extends { id: string }>

this.blueprints = body.blueprints || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -81,7 +81,7 @@ export interface DevboxesCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface DevboxesCursorIDPageParams {
Expand All @@ -98,7 +98,7 @@ export class DevboxesCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -110,7 +110,7 @@ export class DevboxesCursorIDPage<Item extends { id: string }>

this.devboxes = body.devboxes || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -155,7 +155,7 @@ export interface RepositoriesCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface RepositoriesCursorIDPageParams {
Expand All @@ -172,7 +172,7 @@ export class RepositoriesCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -184,7 +184,7 @@ export class RepositoriesCursorIDPage<Item extends { id: string }>

this.repositories = body.repositories || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -229,7 +229,7 @@ export interface DiskSnapshotsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface DiskSnapshotsCursorIDPageParams {
Expand All @@ -246,7 +246,7 @@ export class DiskSnapshotsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -258,7 +258,7 @@ export class DiskSnapshotsCursorIDPage<Item extends { id: string }>

this.snapshots = body.snapshots || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -303,7 +303,7 @@ export interface BenchmarksCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface BenchmarksCursorIDPageParams {
Expand All @@ -320,7 +320,7 @@ export class BenchmarksCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -332,7 +332,7 @@ export class BenchmarksCursorIDPage<Item extends { id: string }>

this.benchmarks = body.benchmarks || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -377,7 +377,7 @@ export interface AgentsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface AgentsCursorIDPageParams {
Expand All @@ -394,7 +394,7 @@ export class AgentsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -406,7 +406,7 @@ export class AgentsCursorIDPage<Item extends { id: string }>

this.agents = body.agents || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -451,7 +451,7 @@ export interface BenchmarkRunsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface BenchmarkRunsCursorIDPageParams {
Expand All @@ -468,7 +468,7 @@ export class BenchmarkRunsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -480,7 +480,7 @@ export class BenchmarkRunsCursorIDPage<Item extends { id: string }>

this.runs = body.runs || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -525,7 +525,7 @@ export interface ScenariosCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface ScenariosCursorIDPageParams {
Expand All @@ -542,7 +542,7 @@ export class ScenariosCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -554,7 +554,7 @@ export class ScenariosCursorIDPage<Item extends { id: string }>

this.scenarios = body.scenarios || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -599,7 +599,7 @@ export interface ScenarioRunsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface ScenarioRunsCursorIDPageParams {
Expand All @@ -616,7 +616,7 @@ export class ScenarioRunsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -628,7 +628,7 @@ export class ScenarioRunsCursorIDPage<Item extends { id: string }>

this.runs = body.runs || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -673,7 +673,7 @@ export interface ScenarioScorersCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface ScenarioScorersCursorIDPageParams {
Expand All @@ -690,7 +690,7 @@ export class ScenarioScorersCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -702,7 +702,7 @@ export class ScenarioScorersCursorIDPage<Item extends { id: string }>

this.scorers = body.scorers || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -747,7 +747,7 @@ export interface ObjectsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface ObjectsCursorIDPageParams {
Expand All @@ -764,7 +764,7 @@ export class ObjectsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -776,7 +776,7 @@ export class ObjectsCursorIDPage<Item extends { id: string }>

this.objects = body.objects || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -821,7 +821,7 @@ export interface NetworkPoliciesCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface NetworkPoliciesCursorIDPageParams {
Expand All @@ -838,7 +838,7 @@ export class NetworkPoliciesCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -850,7 +850,7 @@ export class NetworkPoliciesCursorIDPage<Item extends { id: string }>

this.network_policies = body.network_policies || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -895,7 +895,7 @@ export interface GatewayConfigsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface GatewayConfigsCursorIDPageParams {
Expand All @@ -912,7 +912,7 @@ export class GatewayConfigsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -924,7 +924,7 @@ export class GatewayConfigsCursorIDPage<Item extends { id: string }>

this.gateway_configs = body.gateway_configs || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down Expand Up @@ -969,7 +969,7 @@ export interface McpConfigsCursorIDPageResponse<Item> {

has_more: boolean;

total_count: number;
total_count: number | null;
}

export interface McpConfigsCursorIDPageParams {
Expand All @@ -986,7 +986,7 @@ export class McpConfigsCursorIDPage<Item extends { id: string }>

has_more: boolean;

total_count: number;
total_count: number | null;

constructor(
client: APIClient,
Expand All @@ -998,7 +998,7 @@ export class McpConfigsCursorIDPage<Item extends { id: string }>

this.mcp_configs = body.mcp_configs || [];
this.has_more = body.has_more || false;
this.total_count = body.total_count || 0;
this.total_count = body.total_count ?? null;
}

getPaginatedItems(): Item[] {
Expand Down
8 changes: 4 additions & 4 deletions src/resources/agents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ export interface AgentListView {
has_more: boolean;

/**
* The count of remaining Agents.
* The count of remaining Agents. Deprecated: always returns null.
*/
remaining_count: number;
remaining_count: number | null;

/**
* The total count of Agents.
* The total count of Agents. Deprecated: always returns null.
*/
total_count: number;
total_count: number | null;
}

/**
Expand Down
Loading