forge-dashboard-sdk-php

PullRequestsApi
in package

ForgeDashboard

Generated

PullRequestsApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['closePullRequest' => ['application/json'], 'e...

Properties

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

Methods

__construct() : mixed
closePullRequest() : void: Operation closePullRequest
closePullRequestAsync() : PromiseInterface: Operation closePullRequestAsync
closePullRequestAsyncWithHttpInfo() : PromiseInterface: Operation closePullRequestAsyncWithHttpInfo
closePullRequestRequest() : Request: Create request for operation 'closePullRequest'
closePullRequestWithHttpInfo() : array<string|int, mixed>: Operation closePullRequestWithHttpInfo
enablePullRequestAutoMerge() : void: Operation enablePullRequestAutoMerge
enablePullRequestAutoMergeAsync() : PromiseInterface: Operation enablePullRequestAutoMergeAsync
enablePullRequestAutoMergeAsyncWithHttpInfo() : PromiseInterface: Operation enablePullRequestAutoMergeAsyncWithHttpInfo
enablePullRequestAutoMergeRequest() : Request: Create request for operation 'enablePullRequestAutoMerge'
enablePullRequestAutoMergeWithHttpInfo() : array<string|int, mixed>: Operation enablePullRequestAutoMergeWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getPullRequestChecks() : PullRequestChecksResponse|Error: Operation getPullRequestChecks
getPullRequestChecksAsync() : PromiseInterface: Operation getPullRequestChecksAsync
getPullRequestChecksAsyncWithHttpInfo() : PromiseInterface: Operation getPullRequestChecksAsyncWithHttpInfo
getPullRequestChecksRequest() : Request: Create request for operation 'getPullRequestChecks'
getPullRequestChecksWithHttpInfo() : array<string|int, mixed>: Operation getPullRequestChecksWithHttpInfo
mergePullRequest() : void: Operation mergePullRequest
mergePullRequestAsync() : PromiseInterface: Operation mergePullRequestAsync
mergePullRequestAsyncWithHttpInfo() : PromiseInterface: Operation mergePullRequestAsyncWithHttpInfo
mergePullRequestRequest() : Request: Create request for operation 'mergePullRequest'
mergePullRequestWithHttpInfo() : array<string|int, mixed>: Operation mergePullRequestWithHttpInfo
postPullRequestDependabotAction() : void: Operation postPullRequestDependabotAction
postPullRequestDependabotActionAsync() : PromiseInterface: Operation postPullRequestDependabotActionAsync
postPullRequestDependabotActionAsyncWithHttpInfo() : PromiseInterface: Operation postPullRequestDependabotActionAsyncWithHttpInfo
postPullRequestDependabotActionRequest() : Request: Create request for operation 'postPullRequestDependabotAction'
postPullRequestDependabotActionWithHttpInfo() : array<string|int, mixed>: Operation postPullRequestDependabotActionWithHttpInfo
postPullRequestRenovateRebase() : void: Operation postPullRequestRenovateRebase
postPullRequestRenovateRebaseAsync() : PromiseInterface: Operation postPullRequestRenovateRebaseAsync
postPullRequestRenovateRebaseAsyncWithHttpInfo() : PromiseInterface: Operation postPullRequestRenovateRebaseAsyncWithHttpInfo
postPullRequestRenovateRebaseRequest() : Request: Create request for operation 'postPullRequestRenovateRebase'
postPullRequestRenovateRebaseWithHttpInfo() : array<string|int, mixed>: Operation postPullRequestRenovateRebaseWithHttpInfo
rerunPullRequestChecks() : void: Operation rerunPullRequestChecks
rerunPullRequestChecksAsync() : PromiseInterface: Operation rerunPullRequestChecksAsync
rerunPullRequestChecksAsyncWithHttpInfo() : PromiseInterface: Operation rerunPullRequestChecksAsyncWithHttpInfo
rerunPullRequestChecksRequest() : Request: Create request for operation 'rerunPullRequestChecks'
rerunPullRequestChecksWithHttpInfo() : array<string|int, mixed>: Operation rerunPullRequestChecksWithHttpInfo
setHostIndex() : void: Set the host index
updatePullRequestBranch() : void: Operation updatePullRequestBranch
updatePullRequestBranchAsync() : PromiseInterface: Operation updatePullRequestBranchAsync
updatePullRequestBranchAsyncWithHttpInfo() : PromiseInterface: Operation updatePullRequestBranchAsyncWithHttpInfo
updatePullRequestBranchRequest() : Request: Create request for operation 'updatePullRequestBranch'
updatePullRequestBranchWithHttpInfo() : array<string|int, mixed>: Operation updatePullRequestBranchWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['closePullRequest' => ['application/json'], 'enablePullRequestAutoMerge' => ['application/json'], 'getPullRequestChecks' => ['application/json'], 'mergePullRequest' => ['application/json'], 'postPullRequestDependabotAction' => ['application/json'], 'postPullRequestRenovateRebase' => ['application/json'], 'rerunPullRequestChecks' => ['application/json'], 'updatePullRequestBranch' => ['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

closePullRequest()

Operation closePullRequest


    public
                    closePullRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['closePullRequest'][0] ]) : void

Close one pull request without merging it, on the signed-in user's behalf

Parameters

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

closePullRequestAsync()

Operation closePullRequestAsync


    public
                    closePullRequestAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['closePullRequest'][0] ]) : PromiseInterface

Close one pull request without merging it, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

closePullRequestAsyncWithHttpInfo()

Operation closePullRequestAsyncWithHttpInfo


    public
                    closePullRequestAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['closePullRequest'][0] ]) : PromiseInterface

Close one pull request without merging it, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

closePullRequestRequest()

Create request for operation 'closePullRequest'


    public
                    closePullRequestRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['closePullRequest'][0] ]) : Request

Parameters

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

Return values

Request

closePullRequestWithHttpInfo()

Operation closePullRequestWithHttpInfo


    public
                    closePullRequestWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['closePullRequest'][0] ]) : array<string|int, mixed>

Close one pull request without merging it, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['closePullRequest'][0]: The value for the Content-Type header. Check self::contentTypes['closePullRequest'] 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)

enablePullRequestAutoMerge()

Operation enablePullRequestAutoMerge


    public
                    enablePullRequestAutoMerge(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['enablePullRequestAutoMerge'][0] ]) : void

Arm a pull request's own native auto-merge, on the signed-in user's behalf

Parameters

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

enablePullRequestAutoMergeAsync()

Operation enablePullRequestAutoMergeAsync


    public
                    enablePullRequestAutoMergeAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['enablePullRequestAutoMerge'][0] ]) : PromiseInterface

Arm a pull request's own native auto-merge, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

enablePullRequestAutoMergeAsyncWithHttpInfo()

Operation enablePullRequestAutoMergeAsyncWithHttpInfo


    public
                    enablePullRequestAutoMergeAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['enablePullRequestAutoMerge'][0] ]) : PromiseInterface

Arm a pull request's own native auto-merge, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

enablePullRequestAutoMergeRequest()

Create request for operation 'enablePullRequestAutoMerge'


    public
                    enablePullRequestAutoMergeRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['enablePullRequestAutoMerge'][0] ]) : Request

Parameters

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

Return values

Request

enablePullRequestAutoMergeWithHttpInfo()

Operation enablePullRequestAutoMergeWithHttpInfo


    public
                    enablePullRequestAutoMergeWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['enablePullRequestAutoMerge'][0] ]) : array<string|int, mixed>

Arm a pull request's own native auto-merge, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['enablePullRequestAutoMerge'][0]: The value for the Content-Type header. Check self::contentTypes['enablePullRequestAutoMerge'] 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

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getPullRequestChecks()

Operation getPullRequestChecks


    public
                    getPullRequestChecks(Forge $forge, string $full_name, int $number[, string $contentType = self::contentTypes['getPullRequestChecks'][0] ]) : PullRequestChecksResponse|Error

List every job/check run against a pull request's head commit, on demand

Parameters

$forge : Forge: forge (required)
$full_name : string: "owner/repo", matching a Repo.fullName from GET /api/dashboard. (required)
$number : int: Matching a PullRequest.number from GET /api/dashboard. (required)
$contentType : string = self::contentTypes['getPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getPullRequestChecks'] to see the possible values for this operation

Return values

PullRequestChecksResponse|Error

getPullRequestChecksAsync()

Operation getPullRequestChecksAsync


    public
                    getPullRequestChecksAsync(Forge $forge, string $full_name, int $number[, string $contentType = self::contentTypes['getPullRequestChecks'][0] ]) : PromiseInterface

List every job/check run against a pull request's head commit, on demand

Parameters

$forge : Forge: (required)
$full_name : string: "owner/repo", matching a Repo.fullName from GET /api/dashboard. (required)
$number : int: Matching a PullRequest.number from GET /api/dashboard. (required)
$contentType : string = self::contentTypes['getPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getPullRequestChecks'] to see the possible values for this operation

Return values

PromiseInterface

getPullRequestChecksAsyncWithHttpInfo()

Operation getPullRequestChecksAsyncWithHttpInfo


    public
                    getPullRequestChecksAsyncWithHttpInfo(Forge $forge, string $full_name, int $number[, string $contentType = self::contentTypes['getPullRequestChecks'][0] ]) : PromiseInterface

List every job/check run against a pull request's head commit, on demand

Parameters

$forge : Forge: (required)
$full_name : string: "owner/repo", matching a Repo.fullName from GET /api/dashboard. (required)
$number : int: Matching a PullRequest.number from GET /api/dashboard. (required)
$contentType : string = self::contentTypes['getPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getPullRequestChecks'] to see the possible values for this operation

Return values

PromiseInterface

getPullRequestChecksRequest()

Create request for operation 'getPullRequestChecks'


    public
                    getPullRequestChecksRequest(Forge $forge, string $full_name, int $number[, string $contentType = self::contentTypes['getPullRequestChecks'][0] ]) : Request

Parameters

$forge : Forge: (required)
$full_name : string: "owner/repo", matching a Repo.fullName from GET /api/dashboard. (required)
$number : int: Matching a PullRequest.number from GET /api/dashboard. (required)
$contentType : string = self::contentTypes['getPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getPullRequestChecks'] to see the possible values for this operation

Return values

Request

getPullRequestChecksWithHttpInfo()

Operation getPullRequestChecksWithHttpInfo


    public
                    getPullRequestChecksWithHttpInfo(Forge $forge, string $full_name, int $number[, string $contentType = self::contentTypes['getPullRequestChecks'][0] ]) : array<string|int, mixed>

List every job/check run against a pull request's head commit, on demand

Parameters

$forge : Forge: (required)
$full_name : string: "owner/repo", matching a Repo.fullName from GET /api/dashboard. (required)
$number : int: Matching a PullRequest.number from GET /api/dashboard. (required)
$contentType : string = self::contentTypes['getPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['getPullRequestChecks'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

mergePullRequest()

Operation mergePullRequest


    public
                    mergePullRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['mergePullRequest'][0] ]) : void

Merge one pull request, on the signed-in user's behalf

Parameters

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

mergePullRequestAsync()

Operation mergePullRequestAsync


    public
                    mergePullRequestAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['mergePullRequest'][0] ]) : PromiseInterface

Merge one pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

mergePullRequestAsyncWithHttpInfo()

Operation mergePullRequestAsyncWithHttpInfo


    public
                    mergePullRequestAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['mergePullRequest'][0] ]) : PromiseInterface

Merge one pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

mergePullRequestRequest()

Create request for operation 'mergePullRequest'


    public
                    mergePullRequestRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['mergePullRequest'][0] ]) : Request

Parameters

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

Return values

Request

mergePullRequestWithHttpInfo()

Operation mergePullRequestWithHttpInfo


    public
                    mergePullRequestWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['mergePullRequest'][0] ]) : array<string|int, mixed>

Merge one pull request, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['mergePullRequest'][0]: The value for the Content-Type header. Check self::contentTypes['mergePullRequest'] 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)

postPullRequestDependabotAction()

Operation postPullRequestDependabotAction


    public
                    postPullRequestDependabotAction(PullRequestDependabotActionRequest $pull_request_dependabot_action_request[, string $contentType = self::contentTypes['postPullRequestDependabotAction'][0] ]) : void

Post one of Dependabot's own documented PR-comment commands on a pull request, on the signed-in user's behalf

Parameters

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

postPullRequestDependabotActionAsync()

Operation postPullRequestDependabotActionAsync


    public
                    postPullRequestDependabotActionAsync(PullRequestDependabotActionRequest $pull_request_dependabot_action_request[, string $contentType = self::contentTypes['postPullRequestDependabotAction'][0] ]) : PromiseInterface

Post one of Dependabot's own documented PR-comment commands on a pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

postPullRequestDependabotActionAsyncWithHttpInfo()

Operation postPullRequestDependabotActionAsyncWithHttpInfo


    public
                    postPullRequestDependabotActionAsyncWithHttpInfo(PullRequestDependabotActionRequest $pull_request_dependabot_action_request[, string $contentType = self::contentTypes['postPullRequestDependabotAction'][0] ]) : PromiseInterface

Post one of Dependabot's own documented PR-comment commands on a pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

postPullRequestDependabotActionRequest()

Create request for operation 'postPullRequestDependabotAction'


    public
                    postPullRequestDependabotActionRequest(PullRequestDependabotActionRequest $pull_request_dependabot_action_request[, string $contentType = self::contentTypes['postPullRequestDependabotAction'][0] ]) : Request

Parameters

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

Return values

Request

postPullRequestDependabotActionWithHttpInfo()

Operation postPullRequestDependabotActionWithHttpInfo


    public
                    postPullRequestDependabotActionWithHttpInfo(PullRequestDependabotActionRequest $pull_request_dependabot_action_request[, string $contentType = self::contentTypes['postPullRequestDependabotAction'][0] ]) : array<string|int, mixed>

Post one of Dependabot's own documented PR-comment commands on a pull request, on the signed-in user's behalf

Parameters

$pull_request_dependabot_action_request : PullRequestDependabotActionRequest: (required)
$contentType : string = self::contentTypes['postPullRequestDependabotAction'][0]: The value for the Content-Type header. Check self::contentTypes['postPullRequestDependabotAction'] 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)

postPullRequestRenovateRebase()

Operation postPullRequestRenovateRebase


    public
                    postPullRequestRenovateRebase(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['postPullRequestRenovateRebase'][0] ]) : void

Trigger Renovate's own rebase/retry on a pull request, on the signed-in user's behalf

Parameters

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

postPullRequestRenovateRebaseAsync()

Operation postPullRequestRenovateRebaseAsync


    public
                    postPullRequestRenovateRebaseAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['postPullRequestRenovateRebase'][0] ]) : PromiseInterface

Trigger Renovate's own rebase/retry on a pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

postPullRequestRenovateRebaseAsyncWithHttpInfo()

Operation postPullRequestRenovateRebaseAsyncWithHttpInfo


    public
                    postPullRequestRenovateRebaseAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['postPullRequestRenovateRebase'][0] ]) : PromiseInterface

Trigger Renovate's own rebase/retry on a pull request, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

postPullRequestRenovateRebaseRequest()

Create request for operation 'postPullRequestRenovateRebase'


    public
                    postPullRequestRenovateRebaseRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['postPullRequestRenovateRebase'][0] ]) : Request

Parameters

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

Return values

Request

postPullRequestRenovateRebaseWithHttpInfo()

Operation postPullRequestRenovateRebaseWithHttpInfo


    public
                    postPullRequestRenovateRebaseWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['postPullRequestRenovateRebase'][0] ]) : array<string|int, mixed>

Trigger Renovate's own rebase/retry on a pull request, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['postPullRequestRenovateRebase'][0]: The value for the Content-Type header. Check self::contentTypes['postPullRequestRenovateRebase'] 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)

rerunPullRequestChecks()

Operation rerunPullRequestChecks


    public
                    rerunPullRequestChecks(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['rerunPullRequestChecks'][0] ]) : void

Rerun only the failed jobs of one pull request's checks, on the signed-in user's behalf

Parameters

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

rerunPullRequestChecksAsync()

Operation rerunPullRequestChecksAsync


    public
                    rerunPullRequestChecksAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['rerunPullRequestChecks'][0] ]) : PromiseInterface

Rerun only the failed jobs of one pull request's checks, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

rerunPullRequestChecksAsyncWithHttpInfo()

Operation rerunPullRequestChecksAsyncWithHttpInfo


    public
                    rerunPullRequestChecksAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['rerunPullRequestChecks'][0] ]) : PromiseInterface

Rerun only the failed jobs of one pull request's checks, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

rerunPullRequestChecksRequest()

Create request for operation 'rerunPullRequestChecks'


    public
                    rerunPullRequestChecksRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['rerunPullRequestChecks'][0] ]) : Request

Parameters

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

Return values

Request

rerunPullRequestChecksWithHttpInfo()

Operation rerunPullRequestChecksWithHttpInfo


    public
                    rerunPullRequestChecksWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['rerunPullRequestChecks'][0] ]) : array<string|int, mixed>

Rerun only the failed jobs of one pull request's checks, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['rerunPullRequestChecks'][0]: The value for the Content-Type header. Check self::contentTypes['rerunPullRequestChecks'] 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)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

updatePullRequestBranch()

Operation updatePullRequestBranch


    public
                    updatePullRequestBranch(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['updatePullRequestBranch'][0] ]) : void

Bring one pull request's branch up to date with its base, on the signed-in user's behalf

Parameters

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

updatePullRequestBranchAsync()

Operation updatePullRequestBranchAsync


    public
                    updatePullRequestBranchAsync(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['updatePullRequestBranch'][0] ]) : PromiseInterface

Bring one pull request's branch up to date with its base, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

updatePullRequestBranchAsyncWithHttpInfo()

Operation updatePullRequestBranchAsyncWithHttpInfo


    public
                    updatePullRequestBranchAsyncWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['updatePullRequestBranch'][0] ]) : PromiseInterface

Bring one pull request's branch up to date with its base, on the signed-in user's behalf

Parameters

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

Return values

PromiseInterface

updatePullRequestBranchRequest()

Create request for operation 'updatePullRequestBranch'


    public
                    updatePullRequestBranchRequest(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['updatePullRequestBranch'][0] ]) : Request

Parameters

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

Return values

Request

updatePullRequestBranchWithHttpInfo()

Operation updatePullRequestBranchWithHttpInfo


    public
                    updatePullRequestBranchWithHttpInfo(PullRequestActionRequest $pull_request_action_request[, string $contentType = self::contentTypes['updatePullRequestBranch'][0] ]) : array<string|int, mixed>

Bring one pull request's branch up to date with its base, on the signed-in user's behalf

Parameters

$pull_request_action_request : PullRequestActionRequest: (required)
$contentType : string = self::contentTypes['updatePullRequestBranch'][0]: The value for the Content-Type header. Check self::contentTypes['updatePullRequestBranch'] 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

PullRequestsApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

closePullRequest()

Parameters

Tags

closePullRequestAsync()

Parameters

Tags

Return values

closePullRequestAsyncWithHttpInfo()

Parameters

Tags

Return values

closePullRequestRequest()

Parameters

Tags

Return values

closePullRequestWithHttpInfo()

Parameters

Tags

Return values

enablePullRequestAutoMerge()

Parameters

Tags

enablePullRequestAutoMergeAsync()

Parameters

Tags

Return values

enablePullRequestAutoMergeAsyncWithHttpInfo()

Parameters

Tags

Return values

enablePullRequestAutoMergeRequest()

Parameters

Tags

Return values

enablePullRequestAutoMergeWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

getPullRequestChecks()

Parameters

Tags

Return values

getPullRequestChecksAsync()

Parameters

Tags

Return values

getPullRequestChecksAsyncWithHttpInfo()

Parameters

Tags

Return values

getPullRequestChecksRequest()

Parameters

Tags

Return values

getPullRequestChecksWithHttpInfo()

Parameters

Tags

Return values

mergePullRequest()

Parameters

PullRequestsApi
in package

ForgeDashboard

Generated