> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

# Objects

> Every object and enum the Pulls tools accept.

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#pullcreatebody">PullCreateBody</a></div><div className="tree-node"><a href="#reviewcomment">ReviewComment</a></div></div></div>

## PullCreateBody

The body of a create-pull-request request.

<div className="reference-table">
  | Field                                                        | Type      | Description                                                                                                                                    |
  | ------------------------------------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
  | `title`                                                      | `string`  | The title of the new pull request. Required unless `issue` is given.                                                                           |
  | `head` <span className="required" title="required">\*</span> | `string`  | The name of the branch where your changes are implemented. For cross-repository pull requests, prefix with a username, e.g. `username:branch`. |
  | `headRepo`                                                   | `string`  | The name of the repository where the changes in the pull request were made. Used for cross-repository pull requests from forks.                |
  | `base` <span className="required" title="required">\*</span> | `string`  | The name of the branch you want the changes pulled into. This should be an existing branch on the current repository.                          |
  | `body`                                                       | `string`  | The contents of the pull request.                                                                                                              |
  | `maintainerCanModify`                                        | `boolean` | Indicates whether maintainers can modify the pull request.                                                                                     |
  | `draft`                                                      | `boolean` | Indicates whether the pull request is a draft.                                                                                                 |
  | `issue`                                                      | `integer` | An issue number to convert into a pull request. Required unless `title` is given. The issue's title, body and comments carry over.             |
</div>

## ReviewComment

One inline comment left as part of a review.

<div className="reference-table">
  | Field                                                        | Type                      | Description                                                                                        |
  | ------------------------------------------------------------ | ------------------------- | -------------------------------------------------------------------------------------------------- |
  | `path` <span className="required" title="required">\*</span> | `string`                  | The file the comment is on, relative to the repo root.                                             |
  | `body` <span className="required" title="required">\*</span> | `string`                  | The comment text.                                                                                  |
  | `line`                                                       | `integer`                 | The line in the diff the comment applies to. For a multi-line comment, the last line of the range. |
  | `side`                                                       | [ReviewSide](#reviewside) | Which side of the diff: 'LEFT' is the old file, 'RIGHT' the new.                                   |
  | `startLine`                                                  | `integer`                 | The first line of a multi-line comment.                                                            |
  | `startSide`                                                  | [ReviewSide](#reviewside) | Which side the multi-line range starts on.                                                         |
</div>

## CodeScanningSort

<div className="enum-table">
  | Value     |
  | --------- |
  | `created` |
  | `updated` |
</div>

## MergeMethod

<div className="enum-table">
  | Value    |
  | -------- |
  | `merge`  |
  | `squash` |
  | `rebase` |
</div>

## RepoReviewCommentSort

<div className="enum-table">
  | Value        |
  | ------------ |
  | `created`    |
  | `updated`    |
  | `created_at` |
</div>

## ReviewEvent

<div className="enum-table">
  | Value             |
  | ----------------- |
  | `APPROVE`         |
  | `REQUEST_CHANGES` |
  | `COMMENT`         |
</div>

## ReviewSide

<div className="enum-table">
  | Value   |
  | ------- |
  | `LEFT`  |
  | `RIGHT` |
</div>

## SubjectType

<div className="enum-table">
  | Value  |
  | ------ |
  | `line` |
  | `file` |
</div>

## PullSort

<div className="enum-table">
  | Value          |
  | -------------- |
  | `created`      |
  | `updated`      |
  | `popularity`   |
  | `long-running` |
</div>