Class ProjectsModule

Projects module — lists the projects the current token can access.

Index

Constructors

constructor

Methods

list getAll findById

Constructors

constructor

new ProjectsModule(client: BugBugApiClient): ProjectsModule
Parameters
- client: BugBugApiClient
Returns ProjectsModule
- Defined in sdk/src/modules/projects/projects.ts:13

Methods

list

list(
options?: { cursor?: string; pageSize?: number; query?: string } & RequestOptions,
): Promise<ProjectsListResponse>
List projects accessible with the current token, one page at a time.
Parameters
- options: { cursor?: string; pageSize?: number; query?: string } & RequestOptions = {}
  - Optionalcursor?: string
    Opaque cursor returned as nextToken by the previous page.
  - OptionalpageSize?: number
    Items per page.
  - Optionalquery?: string
    Case-insensitive name filter.
Returns Promise<ProjectsListResponse>
Paginated ProjectsListResponse.
- Defined in sdk/src/modules/projects/projects.ts:25

getAll

getAll(
    options?: RequestOptions,
): Promise<
    {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }[],
>
Fetch every project across all pages.

Internally follows nextToken until the API signals exhaustion.
Parameters
- options: RequestOptions = {}
Returns Promise<
    {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }[],
>
- Defined in sdk/src/modules/projects/projects.ts:50

findById

findById(
    projectId: string,
    options?: RequestOptions,
): Promise<
    | {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }
    | null,
>
Find a project by its id across all pages.
Parameters
- projectId: string
- options: RequestOptions = {}
Returns Promise<
    | {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }
    | null,
>
The matching project, or null when no project has that id.
- Defined in sdk/src/modules/projects/projects.ts:58

Class ProjectsModule

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProjectsModule

Methods

list

Parameters

`Optional`cursor?: string

`Optional`pageSize?: number

`Optional`query?: string

Returns Promise<ProjectsListResponse>

getAll

Parameters

Returns Promise<
    {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }[],
>

findById

Parameters

Returns Promise<
    | {
        id: string;
        name: string
        | null;
        homepageUrl: string | null;
        organizationId: string | null;
        organizationName: string;
    }
    | null,
>

Settings

On This Page

Class ProjectsModule

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProjectsModule

Methods

list

Parameters

Optionalcursor?: string

OptionalpageSize?: number

Optionalquery?: string

Returns Promise<ProjectsListResponse>

getAll

Parameters

Returns Promise< { id: string; name: string | null; homepageUrl: string | null; organizationId: string | null; organizationName: string; }[],>

findById

Parameters

Returns Promise< | { id: string; name: string | null; homepageUrl: string | null; organizationId: string | null; organizationName: string; } | null,>

Settings

On This Page

`Optional`cursor?: string

`Optional`pageSize?: number

`Optional`query?: string

Returns Promise<
{
id: string;
name: string
| null;
homepageUrl: string | null;
organizationId: string | null;
organizationName: string;
}[],
>

Returns Promise<
| {
id: string;
name: string
| null;
homepageUrl: string | null;
organizationId: string | null;
organizationName: string;
}
| null,
>