Class Repositories

Hierarchy

APIResource
- Repositories

Index

Constructors

constructor

new Repositories(client: Runloop): Repositories
Parameters
- client: Runloop
Returns Repositories
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: RepositoryCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<RepositoryConnectionView>
Create a connection to a Github Repository and trigger an initial inspection of the repo's technical stack and developer environment requirements.
Parameters
- body: RepositoryCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryConnectionView>
- Defined in src/resources/repositories.ts:13

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<RepositoryConnectionView>
Get Repository Connection details including latest inspection status and generated repository insights.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryConnectionView>
- Defined in src/resources/repositories.ts:24

list

list(
    query?: RepositoryListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    RepositoryConnectionViewsRepositoriesCursorIDPage,
    RepositoryConnectionView,
>
List all available repository connections.
Parameters
- Optionalquery: RepositoryListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
RepositoryConnectionViewsRepositoriesCursorIDPage,
RepositoryConnectionView,
>
- Defined in src/resources/repositories.ts:31
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    RepositoryConnectionViewsRepositoriesCursorIDPage,
    RepositoryConnectionView,
>
List all available repository connections.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
RepositoryConnectionViewsRepositoriesCursorIDPage,
RepositoryConnectionView,
>
- Defined in src/resources/repositories.ts:35

delete

delete(
    id: string,
    body?: RepositoryDeleteParams | null,
    options?: RequestOptions<unknown>,
): APIPromise<unknown>
Permanently Delete a Repository Connection including any automatically generated inspection insights.
Parameters
- id: string
- Optionalbody: RepositoryDeleteParams | null
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<unknown>
- Defined in src/resources/repositories.ts:55

inspect

inspect(
    id: string,
    body?: RepositoryInspectParams,
    options?: RequestOptions<unknown>,
): APIPromise<RepositoryInspectionDetails>
Inspect a repository connection by inspecting the specified version including repo's technical stack and developer environment requirements.
Parameters
- id: string
- Optionalbody: RepositoryInspectParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryInspectionDetails>
- Defined in src/resources/repositories.ts:67
inspect(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<RepositoryInspectionDetails>
Inspect a repository connection by inspecting the specified version including repo's technical stack and developer environment requirements.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryInspectionDetails>
- Defined in src/resources/repositories.ts:72

listInspections

listInspections(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<RepositoryInspectionListView>
List all inspections of a repository connection including automatically generated insights for each inspection.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryInspectionListView>
- Defined in src/resources/repositories.ts:88

refresh

refresh(
    id: string,
    body?: RepositoryRefreshParams,
    options?: RequestOptions<unknown>,
): APIPromise<unknown>
Refresh a repository connection by inspecting the latest version including repo's technical stack and developer environment requirements.
Parameters
- id: string
- Optionalbody: RepositoryRefreshParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<unknown>
Deprecated
- Defined in src/resources/repositories.ts:98
refresh(id: string, options?: RequestOptions<unknown>): APIPromise<unknown>
Refresh a repository connection by inspecting the latest version including repo's technical stack and developer environment requirements.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<unknown>
Deprecated
- Defined in src/resources/repositories.ts:103

retrieveInspection

retrieveInspection(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<RepositoryInspectionDetails>
Get a repository inspection by id.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RepositoryInspectionDetails>
- Defined in src/resources/repositories.ts:118

Class Repositories

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Repositories

Properties

Protected_client

Methods

create

Parameters

Returns APIPromise<RepositoryConnectionView>

retrieve

Parameters

Returns APIPromise<RepositoryConnectionView>

list

Parameters

Returns PagePromise< RepositoryConnectionViewsRepositoriesCursorIDPage, RepositoryConnectionView,>

Parameters

Returns PagePromise< RepositoryConnectionViewsRepositoriesCursorIDPage, RepositoryConnectionView,>

delete

Parameters

Returns APIPromise<unknown>

inspect

Parameters

Returns APIPromise<RepositoryInspectionDetails>

Parameters

Returns APIPromise<RepositoryInspectionDetails>

listInspections

Parameters

Returns APIPromise<RepositoryInspectionListView>

refresh

Parameters

Returns APIPromise<unknown>

Deprecated

Parameters

Returns APIPromise<unknown>

Deprecated

retrieveInspection

Parameters

Returns APIPromise<RepositoryInspectionDetails>

Settings

On This Page

`Protected`_client

Returns PagePromise<
RepositoryConnectionViewsRepositoriesCursorIDPage,
RepositoryConnectionView,
>

Returns PagePromise<
RepositoryConnectionViewsRepositoriesCursorIDPage,
RepositoryConnectionView,
>