forge-dashboard-sdk-php

DashboardApi
in package

ForgeDashboard

Generated

DashboardApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['disableAutoUpdateBranch' => ['application/jso...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
disableAutoUpdateBranch() : void: Operation disableAutoUpdateBranch
disableAutoUpdateBranchAsync() : PromiseInterface: Operation disableAutoUpdateBranchAsync
disableAutoUpdateBranchAsyncWithHttpInfo() : PromiseInterface: Operation disableAutoUpdateBranchAsyncWithHttpInfo
disableAutoUpdateBranchRequest() : Request: Create request for operation 'disableAutoUpdateBranch'
disableAutoUpdateBranchWithHttpInfo() : array<string|int, mixed>: Operation disableAutoUpdateBranchWithHttpInfo
enableAutoUpdateBranch() : void: Operation enableAutoUpdateBranch
enableAutoUpdateBranchAsync() : PromiseInterface: Operation enableAutoUpdateBranchAsync
enableAutoUpdateBranchAsyncWithHttpInfo() : PromiseInterface: Operation enableAutoUpdateBranchAsyncWithHttpInfo
enableAutoUpdateBranchRequest() : Request: Create request for operation 'enableAutoUpdateBranch'
enableAutoUpdateBranchWithHttpInfo() : array<string|int, mixed>: Operation enableAutoUpdateBranchWithHttpInfo
getConfig() : Configuration
getDashboard() : Dashboard|Error: Operation getDashboard
getDashboardAsync() : PromiseInterface: Operation getDashboardAsync
getDashboardAsyncWithHttpInfo() : PromiseInterface: Operation getDashboardAsyncWithHttpInfo
getDashboardRequest() : Request: Create request for operation 'getDashboard'
getDashboardWithHttpInfo() : array<string|int, mixed>: Operation getDashboardWithHttpInfo
getHostIndex() : int: Get the host index
ignoreRepo() : void: Operation ignoreRepo
ignoreRepoAsync() : PromiseInterface: Operation ignoreRepoAsync
ignoreRepoAsyncWithHttpInfo() : PromiseInterface: Operation ignoreRepoAsyncWithHttpInfo
ignoreRepoRequest() : Request: Create request for operation 'ignoreRepo'
ignoreRepoWithHttpInfo() : array<string|int, mixed>: Operation ignoreRepoWithHttpInfo
refreshDashboard() : Dashboard|Error: Operation refreshDashboard
refreshDashboardAsync() : PromiseInterface: Operation refreshDashboardAsync
refreshDashboardAsyncWithHttpInfo() : PromiseInterface: Operation refreshDashboardAsyncWithHttpInfo
refreshDashboardRequest() : Request: Create request for operation 'refreshDashboard'
refreshDashboardWithHttpInfo() : array<string|int, mixed>: Operation refreshDashboardWithHttpInfo
setHostIndex() : void: Set the host index
streamDashboard() : Dashboard|Error: Operation streamDashboard
streamDashboardAsync() : PromiseInterface: Operation streamDashboardAsync
streamDashboardAsyncWithHttpInfo() : PromiseInterface: Operation streamDashboardAsyncWithHttpInfo
streamDashboardRequest() : Request: Create request for operation 'streamDashboard'
streamDashboardWithHttpInfo() : array<string|int, mixed>: Operation streamDashboardWithHttpInfo
unignoreRepo() : void: Operation unignoreRepo
unignoreRepoAsync() : PromiseInterface: Operation unignoreRepoAsync
unignoreRepoAsyncWithHttpInfo() : PromiseInterface: Operation unignoreRepoAsyncWithHttpInfo
unignoreRepoRequest() : Request: Create request for operation 'unignoreRepo'
unignoreRepoWithHttpInfo() : array<string|int, mixed>: Operation unignoreRepoWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['disableAutoUpdateBranch' => ['application/json'], 'enableAutoUpdateBranch' => ['application/json'], 'getDashboard' => ['application/json'], 'ignoreRepo' => ['application/json'], 'refreshDashboard' => ['application/json'], 'streamDashboard' => ['application/json'], 'unignoreRepo' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

disableAutoUpdateBranch()

Operation disableAutoUpdateBranch


    public
                    disableAutoUpdateBranch(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['disableAutoUpdateBranch'][0] ]) : void

Turn off automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: webhook_ensure_request (required)
$contentType : string = self::contentTypes['disableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['disableAutoUpdateBranch'] to see the possible values for this operation

disableAutoUpdateBranchAsync()

Operation disableAutoUpdateBranchAsync


    public
                    disableAutoUpdateBranchAsync(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['disableAutoUpdateBranch'][0] ]) : PromiseInterface

Turn off automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['disableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['disableAutoUpdateBranch'] to see the possible values for this operation

Return values

PromiseInterface

disableAutoUpdateBranchAsyncWithHttpInfo()

Operation disableAutoUpdateBranchAsyncWithHttpInfo


    public
                    disableAutoUpdateBranchAsyncWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['disableAutoUpdateBranch'][0] ]) : PromiseInterface

Turn off automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['disableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['disableAutoUpdateBranch'] to see the possible values for this operation

Return values

PromiseInterface

disableAutoUpdateBranchRequest()

Create request for operation 'disableAutoUpdateBranch'


    public
                    disableAutoUpdateBranchRequest(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['disableAutoUpdateBranch'][0] ]) : Request

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['disableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['disableAutoUpdateBranch'] to see the possible values for this operation

Return values

Request

disableAutoUpdateBranchWithHttpInfo()

Operation disableAutoUpdateBranchWithHttpInfo


    public
                    disableAutoUpdateBranchWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['disableAutoUpdateBranch'][0] ]) : array<string|int, mixed>

Turn off automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['disableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['disableAutoUpdateBranch'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

enableAutoUpdateBranch()

Operation enableAutoUpdateBranch


    public
                    enableAutoUpdateBranch(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['enableAutoUpdateBranch'][0] ]) : void

Turn on automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: webhook_ensure_request (required)
$contentType : string = self::contentTypes['enableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['enableAutoUpdateBranch'] to see the possible values for this operation

enableAutoUpdateBranchAsync()

Operation enableAutoUpdateBranchAsync


    public
                    enableAutoUpdateBranchAsync(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['enableAutoUpdateBranch'][0] ]) : PromiseInterface

Turn on automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['enableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['enableAutoUpdateBranch'] to see the possible values for this operation

Return values

PromiseInterface

enableAutoUpdateBranchAsyncWithHttpInfo()

Operation enableAutoUpdateBranchAsyncWithHttpInfo


    public
                    enableAutoUpdateBranchAsyncWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['enableAutoUpdateBranch'][0] ]) : PromiseInterface

Turn on automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['enableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['enableAutoUpdateBranch'] to see the possible values for this operation

Return values

PromiseInterface

enableAutoUpdateBranchRequest()

Create request for operation 'enableAutoUpdateBranch'


    public
                    enableAutoUpdateBranchRequest(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['enableAutoUpdateBranch'][0] ]) : Request

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['enableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['enableAutoUpdateBranch'] to see the possible values for this operation

Return values

Request

enableAutoUpdateBranchWithHttpInfo()

Operation enableAutoUpdateBranchWithHttpInfo


    public
                    enableAutoUpdateBranchWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['enableAutoUpdateBranch'][0] ]) : array<string|int, mixed>

Turn on automatic branch updates for one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['enableAutoUpdateBranch'][0]: The value for the Content-Type header. Check self::contentTypes['enableAutoUpdateBranch'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getDashboard()

Operation getDashboard


    public
                    getDashboard([string|null $owner = null ][, bool|null $include_drafts = false ][, string $contentType = self::contentTypes['getDashboard'][0] ]) : Dashboard|Error

The aggregated view

Parameters

$owner : string|null = null: A username that has shared their dashboard with the caller. Defaults to the caller's own. (optional)
$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['getDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['getDashboard'] to see the possible values for this operation

Return values

Dashboard|Error

getDashboardAsync()

Operation getDashboardAsync


    public
                    getDashboardAsync([string|null $owner = null ][, bool|null $include_drafts = false ][, string $contentType = self::contentTypes['getDashboard'][0] ]) : PromiseInterface

The aggregated view

Parameters

$owner : string|null = null: A username that has shared their dashboard with the caller. Defaults to the caller's own. (optional)
$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['getDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['getDashboard'] to see the possible values for this operation

Return values

PromiseInterface

getDashboardAsyncWithHttpInfo()

Operation getDashboardAsyncWithHttpInfo


    public
                    getDashboardAsyncWithHttpInfo([string|null $owner = null ][, bool|null $include_drafts = false ][, string $contentType = self::contentTypes['getDashboard'][0] ]) : PromiseInterface

The aggregated view

Parameters

$owner : string|null = null: A username that has shared their dashboard with the caller. Defaults to the caller's own. (optional)
$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['getDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['getDashboard'] to see the possible values for this operation

Return values

PromiseInterface

getDashboardRequest()

Create request for operation 'getDashboard'


    public
                    getDashboardRequest([string|null $owner = null ][, bool|null $include_drafts = false ][, string $contentType = self::contentTypes['getDashboard'][0] ]) : Request

Parameters

$owner : string|null = null: A username that has shared their dashboard with the caller. Defaults to the caller's own. (optional)
$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['getDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['getDashboard'] to see the possible values for this operation

Return values

Request

getDashboardWithHttpInfo()

Operation getDashboardWithHttpInfo


    public
                    getDashboardWithHttpInfo([string|null $owner = null ][, bool|null $include_drafts = false ][, string $contentType = self::contentTypes['getDashboard'][0] ]) : array<string|int, mixed>

The aggregated view

Parameters

$owner : string|null = null: A username that has shared their dashboard with the caller. Defaults to the caller's own. (optional)
$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['getDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['getDashboard'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Dashboard|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

ignoreRepo()

Operation ignoreRepo


    public
                    ignoreRepo(RepoIgnoreRequest $repo_ignore_request[, string $contentType = self::contentTypes['ignoreRepo'][0] ]) : void

Hide one tracked repo's pull requests, issues, or both from the dashboard and Insights

Parameters

$repo_ignore_request : RepoIgnoreRequest: repo_ignore_request (required)
$contentType : string = self::contentTypes['ignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['ignoreRepo'] to see the possible values for this operation

ignoreRepoAsync()

Operation ignoreRepoAsync


    public
                    ignoreRepoAsync(RepoIgnoreRequest $repo_ignore_request[, string $contentType = self::contentTypes['ignoreRepo'][0] ]) : PromiseInterface

Hide one tracked repo's pull requests, issues, or both from the dashboard and Insights

Parameters

$repo_ignore_request : RepoIgnoreRequest: (required)
$contentType : string = self::contentTypes['ignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['ignoreRepo'] to see the possible values for this operation

Return values

PromiseInterface

ignoreRepoAsyncWithHttpInfo()

Operation ignoreRepoAsyncWithHttpInfo


    public
                    ignoreRepoAsyncWithHttpInfo(RepoIgnoreRequest $repo_ignore_request[, string $contentType = self::contentTypes['ignoreRepo'][0] ]) : PromiseInterface

Hide one tracked repo's pull requests, issues, or both from the dashboard and Insights

Parameters

$repo_ignore_request : RepoIgnoreRequest: (required)
$contentType : string = self::contentTypes['ignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['ignoreRepo'] to see the possible values for this operation

Return values

PromiseInterface

ignoreRepoRequest()

Create request for operation 'ignoreRepo'


    public
                    ignoreRepoRequest(RepoIgnoreRequest $repo_ignore_request[, string $contentType = self::contentTypes['ignoreRepo'][0] ]) : Request

Parameters

$repo_ignore_request : RepoIgnoreRequest: (required)
$contentType : string = self::contentTypes['ignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['ignoreRepo'] to see the possible values for this operation

Return values

Request

ignoreRepoWithHttpInfo()

Operation ignoreRepoWithHttpInfo


    public
                    ignoreRepoWithHttpInfo(RepoIgnoreRequest $repo_ignore_request[, string $contentType = self::contentTypes['ignoreRepo'][0] ]) : array<string|int, mixed>

Hide one tracked repo's pull requests, issues, or both from the dashboard and Insights

Parameters

$repo_ignore_request : RepoIgnoreRequest: (required)
$contentType : string = self::contentTypes['ignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['ignoreRepo'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

refreshDashboard()

Operation refreshDashboard


    public
                    refreshDashboard([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['refreshDashboard'][0] ]) : Dashboard|Error

Trigger an immediate refresh of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['refreshDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['refreshDashboard'] to see the possible values for this operation

Return values

Dashboard|Error

refreshDashboardAsync()

Operation refreshDashboardAsync


    public
                    refreshDashboardAsync([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['refreshDashboard'][0] ]) : PromiseInterface

Trigger an immediate refresh of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['refreshDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['refreshDashboard'] to see the possible values for this operation

Return values

PromiseInterface

refreshDashboardAsyncWithHttpInfo()

Operation refreshDashboardAsyncWithHttpInfo


    public
                    refreshDashboardAsyncWithHttpInfo([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['refreshDashboard'][0] ]) : PromiseInterface

Trigger an immediate refresh of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['refreshDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['refreshDashboard'] to see the possible values for this operation

Return values

PromiseInterface

refreshDashboardRequest()

Create request for operation 'refreshDashboard'


    public
                    refreshDashboardRequest([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['refreshDashboard'][0] ]) : Request

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['refreshDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['refreshDashboard'] to see the possible values for this operation

Return values

Request

refreshDashboardWithHttpInfo()

Operation refreshDashboardWithHttpInfo


    public
                    refreshDashboardWithHttpInfo([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['refreshDashboard'][0] ]) : array<string|int, mixed>

Trigger an immediate refresh of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['refreshDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['refreshDashboard'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Dashboard|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

streamDashboard()

Operation streamDashboard


    public
                    streamDashboard([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['streamDashboard'][0] ]) : Dashboard|Error

Server-Sent Events stream of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['streamDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['streamDashboard'] to see the possible values for this operation

Return values

Dashboard|Error

streamDashboardAsync()

Operation streamDashboardAsync


    public
                    streamDashboardAsync([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['streamDashboard'][0] ]) : PromiseInterface

Server-Sent Events stream of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['streamDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['streamDashboard'] to see the possible values for this operation

Return values

PromiseInterface

streamDashboardAsyncWithHttpInfo()

Operation streamDashboardAsyncWithHttpInfo


    public
                    streamDashboardAsyncWithHttpInfo([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['streamDashboard'][0] ]) : PromiseInterface

Server-Sent Events stream of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['streamDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['streamDashboard'] to see the possible values for this operation

Return values

PromiseInterface

streamDashboardRequest()

Create request for operation 'streamDashboard'


    public
                    streamDashboardRequest([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['streamDashboard'][0] ]) : Request

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['streamDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['streamDashboard'] to see the possible values for this operation

Return values

Request

streamDashboardWithHttpInfo()

Operation streamDashboardWithHttpInfo


    public
                    streamDashboardWithHttpInfo([bool|null $include_drafts = false ][, string $contentType = self::contentTypes['streamDashboard'][0] ]) : array<string|int, mixed>

Server-Sent Events stream of the signed-in user's own dashboard

Parameters

$include_drafts : bool|null = false: Whether draft pull requests are in `pullRequests`. Defaults to `false`: nothing can be merged, auto-merged or updated on a draft, so a draft is left out and counted in the response's `hiddenDrafts` instead. The stream and the refresh endpoint take the same parameter, so every snapshot a client receives follows one rule. (optional, default to false)
$contentType : string = self::contentTypes['streamDashboard'][0]: The value for the Content-Type header. Check self::contentTypes['streamDashboard'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Dashboard|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

unignoreRepo()

Operation unignoreRepo


    public
                    unignoreRepo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['unignoreRepo'][0] ]) : void

Stop ignoring one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: webhook_ensure_request (required)
$contentType : string = self::contentTypes['unignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['unignoreRepo'] to see the possible values for this operation

unignoreRepoAsync()

Operation unignoreRepoAsync


    public
                    unignoreRepoAsync(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['unignoreRepo'][0] ]) : PromiseInterface

Stop ignoring one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['unignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['unignoreRepo'] to see the possible values for this operation

Return values

PromiseInterface

unignoreRepoAsyncWithHttpInfo()

Operation unignoreRepoAsyncWithHttpInfo


    public
                    unignoreRepoAsyncWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['unignoreRepo'][0] ]) : PromiseInterface

Stop ignoring one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['unignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['unignoreRepo'] to see the possible values for this operation

Return values

PromiseInterface

unignoreRepoRequest()

Create request for operation 'unignoreRepo'


    public
                    unignoreRepoRequest(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['unignoreRepo'][0] ]) : Request

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['unignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['unignoreRepo'] to see the possible values for this operation

Return values

Request

unignoreRepoWithHttpInfo()

Operation unignoreRepoWithHttpInfo


    public
                    unignoreRepoWithHttpInfo(WebhookEnsureRequest $webhook_ensure_request[, string $contentType = self::contentTypes['unignoreRepo'][0] ]) : array<string|int, mixed>

Stop ignoring one tracked repo

Parameters

$webhook_ensure_request : WebhookEnsureRequest: (required)
$contentType : string = self::contentTypes['unignoreRepo'][0]: The value for the Content-Type header. Check self::contentTypes['unignoreRepo'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

DashboardApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

disableAutoUpdateBranch()

Parameters

Tags

disableAutoUpdateBranchAsync()

Parameters

Tags

Return values

disableAutoUpdateBranchAsyncWithHttpInfo()

Parameters

Tags

Return values

disableAutoUpdateBranchRequest()

Parameters

Tags

Return values

disableAutoUpdateBranchWithHttpInfo()

Parameters

Tags

Return values

enableAutoUpdateBranch()

Parameters

Tags

enableAutoUpdateBranchAsync()

Parameters

Tags

Return values

enableAutoUpdateBranchAsyncWithHttpInfo()

Parameters

Tags

Return values

enableAutoUpdateBranchRequest()

Parameters

Tags

Return values

enableAutoUpdateBranchWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getDashboard()

Parameters

Tags

Return values

getDashboardAsync()

Parameters

Tags

Return values

getDashboardAsyncWithHttpInfo()

Parameters

Tags

Return values

getDashboardRequest()

Parameters

Tags

Return values

getDashboardWithHttpInfo()

Parameters

Tags

Return values

getHostIndex()

Return values

ignoreRepo()

Parameters

DashboardApi
in package

ForgeDashboard

Generated