[dcs-js](README.md) / Exports

# dcs-js

## Table of contents

### Classes

- [AdminApi](classes/AdminApi.md)
- [Configuration](classes/Configuration.md)
- [IssueApi](classes/IssueApi.md)
- [MiscellaneousApi](classes/MiscellaneousApi.md)
- [NotificationApi](classes/NotificationApi.md)
- [OrganizationApi](classes/OrganizationApi.md)
- [RepositoryApi](classes/RepositoryApi.md)
- [SettingsApi](classes/SettingsApi.md)
- [UserApi](classes/UserApi.md)

### Interfaces

- [APIError](interfaces/APIError.md)
- [AccessToken](interfaces/AccessToken.md)
- [AddCollaboratorOption](interfaces/AddCollaboratorOption.md)
- [AddTimeOption](interfaces/AddTimeOption.md)
- [AnnotatedTag](interfaces/AnnotatedTag.md)
- [AnnotatedTagObject](interfaces/AnnotatedTagObject.md)
- [Attachment](interfaces/Attachment.md)
- [Branch](interfaces/Branch.md)
- [BranchProtection](interfaces/BranchProtection.md)
- [CatalogStage](interfaces/CatalogStage.md)
- [CatalogStages](interfaces/CatalogStages.md)
- [CombinedStatus](interfaces/CombinedStatus.md)
- [Comment](interfaces/Comment.md)
- [Commit](interfaces/Commit.md)
- [CommitAffectedFiles](interfaces/CommitAffectedFiles.md)
- [CommitDateOptions](interfaces/CommitDateOptions.md)
- [CommitMeta](interfaces/CommitMeta.md)
- [CommitStatus](interfaces/CommitStatus.md)
- [CommitUser](interfaces/CommitUser.md)
- [ConfigurationParameters](interfaces/ConfigurationParameters.md)
- [ContentsResponse](interfaces/ContentsResponse.md)
- [CreateAccessTokenOption](interfaces/CreateAccessTokenOption.md)
- [CreateBranchProtectionOption](interfaces/CreateBranchProtectionOption.md)
- [CreateBranchRepoOption](interfaces/CreateBranchRepoOption.md)
- [CreateEmailOption](interfaces/CreateEmailOption.md)
- [CreateFileOptions](interfaces/CreateFileOptions.md)
- [CreateForkOption](interfaces/CreateForkOption.md)
- [CreateGPGKeyOption](interfaces/CreateGPGKeyOption.md)
- [CreateHookOption](interfaces/CreateHookOption.md)
- [CreateIssueCommentOption](interfaces/CreateIssueCommentOption.md)
- [CreateIssueOption](interfaces/CreateIssueOption.md)
- [CreateKeyOption](interfaces/CreateKeyOption.md)
- [CreateLabelOption](interfaces/CreateLabelOption.md)
- [CreateMilestoneOption](interfaces/CreateMilestoneOption.md)
- [CreateOAuth2ApplicationOptions](interfaces/CreateOAuth2ApplicationOptions.md)
- [CreateOrgOption](interfaces/CreateOrgOption.md)
- [CreatePullRequestOption](interfaces/CreatePullRequestOption.md)
- [CreatePullReviewComment](interfaces/CreatePullReviewComment.md)
- [CreatePullReviewOptions](interfaces/CreatePullReviewOptions.md)
- [CreateReleaseOption](interfaces/CreateReleaseOption.md)
- [CreateRepoOption](interfaces/CreateRepoOption.md)
- [CreateStatusOption](interfaces/CreateStatusOption.md)
- [CreateTagOption](interfaces/CreateTagOption.md)
- [CreateTeamOption](interfaces/CreateTeamOption.md)
- [CreateUserOption](interfaces/CreateUserOption.md)
- [CreateWikiPageOptions](interfaces/CreateWikiPageOptions.md)
- [Cron](interfaces/Cron.md)
- [DeleteEmailOption](interfaces/DeleteEmailOption.md)
- [DeleteFileOptions](interfaces/DeleteFileOptions.md)
- [DeployKey](interfaces/DeployKey.md)
- [DismissPullReviewOptions](interfaces/DismissPullReviewOptions.md)
- [EditAttachmentOptions](interfaces/EditAttachmentOptions.md)
- [EditBranchProtectionOption](interfaces/EditBranchProtectionOption.md)
- [EditDeadlineOption](interfaces/EditDeadlineOption.md)
- [EditGitHookOption](interfaces/EditGitHookOption.md)
- [EditHookOption](interfaces/EditHookOption.md)
- [EditIssueCommentOption](interfaces/EditIssueCommentOption.md)
- [EditIssueOption](interfaces/EditIssueOption.md)
- [EditLabelOption](interfaces/EditLabelOption.md)
- [EditMilestoneOption](interfaces/EditMilestoneOption.md)
- [EditOrgOption](interfaces/EditOrgOption.md)
- [EditPullRequestOption](interfaces/EditPullRequestOption.md)
- [EditReactionOption](interfaces/EditReactionOption.md)
- [EditReleaseOption](interfaces/EditReleaseOption.md)
- [EditRepoOption](interfaces/EditRepoOption.md)
- [EditTeamOption](interfaces/EditTeamOption.md)
- [EditUserOption](interfaces/EditUserOption.md)
- [Email](interfaces/Email.md)
- [ExternalTracker](interfaces/ExternalTracker.md)
- [ExternalWiki](interfaces/ExternalWiki.md)
- [FileCommitResponse](interfaces/FileCommitResponse.md)
- [FileDeleteResponse](interfaces/FileDeleteResponse.md)
- [FileLinksResponse](interfaces/FileLinksResponse.md)
- [FileResponse](interfaces/FileResponse.md)
- [GPGKey](interfaces/GPGKey.md)
- [GPGKeyEmail](interfaces/GPGKeyEmail.md)
- [GeneralAPISettings](interfaces/GeneralAPISettings.md)
- [GeneralAttachmentSettings](interfaces/GeneralAttachmentSettings.md)
- [GeneralRepoSettings](interfaces/GeneralRepoSettings.md)
- [GeneralUISettings](interfaces/GeneralUISettings.md)
- [GenerateRepoOption](interfaces/GenerateRepoOption.md)
- [GitBlobResponse](interfaces/GitBlobResponse.md)
- [GitEntry](interfaces/GitEntry.md)
- [GitHook](interfaces/GitHook.md)
- [GitObject](interfaces/GitObject.md)
- [GitTreeResponse](interfaces/GitTreeResponse.md)
- [Hook](interfaces/Hook.md)
- [Identity](interfaces/Identity.md)
- [InternalTracker](interfaces/InternalTracker.md)
- [Issue](interfaces/Issue.md)
- [IssueDeadline](interfaces/IssueDeadline.md)
- [IssueLabelsOption](interfaces/IssueLabelsOption.md)
- [IssueTemplate](interfaces/IssueTemplate.md)
- [Label](interfaces/Label.md)
- [MarkdownOption](interfaces/MarkdownOption.md)
- [MergePullRequestOption](interfaces/MergePullRequestOption.md)
- [MigrateRepoForm](interfaces/MigrateRepoForm.md)
- [MigrateRepoOptions](interfaces/MigrateRepoOptions.md)
- [Milestone](interfaces/Milestone.md)
- [NodeInfo](interfaces/NodeInfo.md)
- [NodeInfoServices](interfaces/NodeInfoServices.md)
- [NodeInfoSoftware](interfaces/NodeInfoSoftware.md)
- [NodeInfoUsage](interfaces/NodeInfoUsage.md)
- [NodeInfoUsageUsers](interfaces/NodeInfoUsageUsers.md)
- [Note](interfaces/Note.md)
- [NotificationCount](interfaces/NotificationCount.md)
- [NotificationSubject](interfaces/NotificationSubject.md)
- [NotificationThread](interfaces/NotificationThread.md)
- [OAuth2Application](interfaces/OAuth2Application.md)
- [Organization](interfaces/Organization.md)
- [OrganizationPermissions](interfaces/OrganizationPermissions.md)
- [PRBranchInfo](interfaces/PRBranchInfo.md)
- [PayloadCommit](interfaces/PayloadCommit.md)
- [PayloadCommitVerification](interfaces/PayloadCommitVerification.md)
- [PayloadUser](interfaces/PayloadUser.md)
- [Permission](interfaces/Permission.md)
- [PublicKey](interfaces/PublicKey.md)
- [PullRequest](interfaces/PullRequest.md)
- [PullRequestMeta](interfaces/PullRequestMeta.md)
- [PullReview](interfaces/PullReview.md)
- [PullReviewComment](interfaces/PullReviewComment.md)
- [PullReviewRequestOptions](interfaces/PullReviewRequestOptions.md)
- [Reaction](interfaces/Reaction.md)
- [Reference](interfaces/Reference.md)
- [Release](interfaces/Release.md)
- [RepoCommit](interfaces/RepoCommit.md)
- [RepoTopicOptions](interfaces/RepoTopicOptions.md)
- [RepoTransfer](interfaces/RepoTransfer.md)
- [Repository](interfaces/Repository.md)
- [RepositoryMeta](interfaces/RepositoryMeta.md)
- [SearchResults](interfaces/SearchResults.md)
- [ServerVersion](interfaces/ServerVersion.md)
- [StopWatch](interfaces/StopWatch.md)
- [SubmitPullReviewOptions](interfaces/SubmitPullReviewOptions.md)
- [Tag](interfaces/Tag.md)
- [Team](interfaces/Team.md)
- [TeamSearch200Response](interfaces/TeamSearch200Response.md)
- [TimelineComment](interfaces/TimelineComment.md)
- [TopicName](interfaces/TopicName.md)
- [TopicResponse](interfaces/TopicResponse.md)
- [TrackedTime](interfaces/TrackedTime.md)
- [TransferRepoOption](interfaces/TransferRepoOption.md)
- [UpdateFileOptions](interfaces/UpdateFileOptions.md)
- [User](interfaces/User.md)
- [UserHeatmapData](interfaces/UserHeatmapData.md)
- [UserSearch200Response](interfaces/UserSearch200Response.md)
- [UserSettings](interfaces/UserSettings.md)
- [UserSettingsOptions](interfaces/UserSettingsOptions.md)
- [WatchInfo](interfaces/WatchInfo.md)
- [WikiCommit](interfaces/WikiCommit.md)
- [WikiCommitList](interfaces/WikiCommitList.md)
- [WikiPage](interfaces/WikiPage.md)
- [WikiPageMetaData](interfaces/WikiPageMetaData.md)

### Type Aliases

- [CreateHookOptionTypeEnum](modules.md#createhookoptiontypeenum)
- [CreateMilestoneOptionStateEnum](modules.md#createmilestoneoptionstateenum)
- [CreateOrgOptionVisibilityEnum](modules.md#createorgoptionvisibilityenum)
- [CreateRepoOptionTrustModelEnum](modules.md#createrepooptiontrustmodelenum)
- [CreateTeamOptionPermissionEnum](modules.md#createteamoptionpermissionenum)
- [EditOrgOptionVisibilityEnum](modules.md#editorgoptionvisibilityenum)
- [EditTeamOptionPermissionEnum](modules.md#editteamoptionpermissionenum)
- [MergePullRequestOptionDoEnum](modules.md#mergepullrequestoptiondoenum)
- [MigrateRepoOptionsServiceEnum](modules.md#migraterepooptionsserviceenum)
- [TeamPermissionEnum](modules.md#teampermissionenum)

### Variables

- [CreateHookOptionTypeEnum](modules.md#createhookoptiontypeenum-1)
- [CreateMilestoneOptionStateEnum](modules.md#createmilestoneoptionstateenum-1)
- [CreateOrgOptionVisibilityEnum](modules.md#createorgoptionvisibilityenum-1)
- [CreateRepoOptionTrustModelEnum](modules.md#createrepooptiontrustmodelenum-1)
- [CreateTeamOptionPermissionEnum](modules.md#createteamoptionpermissionenum-1)
- [EditOrgOptionVisibilityEnum](modules.md#editorgoptionvisibilityenum-1)
- [EditTeamOptionPermissionEnum](modules.md#editteamoptionpermissionenum-1)
- [MergePullRequestOptionDoEnum](modules.md#mergepullrequestoptiondoenum-1)
- [MigrateRepoOptionsServiceEnum](modules.md#migraterepooptionsserviceenum-1)
- [TeamPermissionEnum](modules.md#teampermissionenum-1)

### Functions

- [AdminApiAxiosParamCreator](modules.md#adminapiaxiosparamcreator)
- [AdminApiFactory](modules.md#adminapifactory)
- [AdminApiFp](modules.md#adminapifp)
- [IssueApiAxiosParamCreator](modules.md#issueapiaxiosparamcreator)
- [IssueApiFactory](modules.md#issueapifactory)
- [IssueApiFp](modules.md#issueapifp)
- [MiscellaneousApiAxiosParamCreator](modules.md#miscellaneousapiaxiosparamcreator)
- [MiscellaneousApiFactory](modules.md#miscellaneousapifactory)
- [MiscellaneousApiFp](modules.md#miscellaneousapifp)
- [NotificationApiAxiosParamCreator](modules.md#notificationapiaxiosparamcreator)
- [NotificationApiFactory](modules.md#notificationapifactory)
- [NotificationApiFp](modules.md#notificationapifp)
- [OrganizationApiAxiosParamCreator](modules.md#organizationapiaxiosparamcreator)
- [OrganizationApiFactory](modules.md#organizationapifactory)
- [OrganizationApiFp](modules.md#organizationapifp)
- [RepositoryApiAxiosParamCreator](modules.md#repositoryapiaxiosparamcreator)
- [RepositoryApiFactory](modules.md#repositoryapifactory)
- [RepositoryApiFp](modules.md#repositoryapifp)
- [SettingsApiAxiosParamCreator](modules.md#settingsapiaxiosparamcreator)
- [SettingsApiFactory](modules.md#settingsapifactory)
- [SettingsApiFp](modules.md#settingsapifp)
- [UserApiAxiosParamCreator](modules.md#userapiaxiosparamcreator)
- [UserApiFactory](modules.md#userapifactory)
- [UserApiFp](modules.md#userapifp)

## Type Aliases

### <a id="createhookoptiontypeenum" name="createhookoptiontypeenum"></a> CreateHookOptionTypeEnum

Ƭ **CreateHookOptionTypeEnum**: typeof [`CreateHookOptionTypeEnum`](modules.md#createhookoptiontypeenum-1)[keyof typeof [`CreateHookOptionTypeEnum`](modules.md#createhookoptiontypeenum-1)]

#### Defined in

[models/create-hook-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-hook-option.ts#L67)

___

### <a id="createmilestoneoptionstateenum" name="createmilestoneoptionstateenum"></a> CreateMilestoneOptionStateEnum

Ƭ **CreateMilestoneOptionStateEnum**: typeof [`CreateMilestoneOptionStateEnum`](modules.md#createmilestoneoptionstateenum-1)[keyof typeof [`CreateMilestoneOptionStateEnum`](modules.md#createmilestoneoptionstateenum-1)]

#### Defined in

[models/create-milestone-option.ts:54](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-milestone-option.ts#L54)

___

### <a id="createorgoptionvisibilityenum" name="createorgoptionvisibilityenum"></a> CreateOrgOptionVisibilityEnum

Ƭ **CreateOrgOptionVisibilityEnum**: typeof [`CreateOrgOptionVisibilityEnum`](modules.md#createorgoptionvisibilityenum-1)[keyof typeof [`CreateOrgOptionVisibilityEnum`](modules.md#createorgoptionvisibilityenum-1)]

#### Defined in

[models/create-org-option.ts:73](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-org-option.ts#L73)

___

### <a id="createrepooptiontrustmodelenum" name="createrepooptiontrustmodelenum"></a> CreateRepoOptionTrustModelEnum

Ƭ **CreateRepoOptionTrustModelEnum**: typeof [`CreateRepoOptionTrustModelEnum`](modules.md#createrepooptiontrustmodelenum-1)[keyof typeof [`CreateRepoOptionTrustModelEnum`](modules.md#createrepooptiontrustmodelenum-1)]

#### Defined in

[models/create-repo-option.ts:98](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-repo-option.ts#L98)

___

### <a id="createteamoptionpermissionenum" name="createteamoptionpermissionenum"></a> CreateTeamOptionPermissionEnum

Ƭ **CreateTeamOptionPermissionEnum**: typeof [`CreateTeamOptionPermissionEnum`](modules.md#createteamoptionpermissionenum-1)[keyof typeof [`CreateTeamOptionPermissionEnum`](modules.md#createteamoptionpermissionenum-1)]

#### Defined in

[models/create-team-option.ts:73](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-team-option.ts#L73)

___

### <a id="editorgoptionvisibilityenum" name="editorgoptionvisibilityenum"></a> EditOrgOptionVisibilityEnum

Ƭ **EditOrgOptionVisibilityEnum**: typeof [`EditOrgOptionVisibilityEnum`](modules.md#editorgoptionvisibilityenum-1)[keyof typeof [`EditOrgOptionVisibilityEnum`](modules.md#editorgoptionvisibilityenum-1)]

#### Defined in

[models/edit-org-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/edit-org-option.ts#L67)

___

### <a id="editteamoptionpermissionenum" name="editteamoptionpermissionenum"></a> EditTeamOptionPermissionEnum

Ƭ **EditTeamOptionPermissionEnum**: typeof [`EditTeamOptionPermissionEnum`](modules.md#editteamoptionpermissionenum-1)[keyof typeof [`EditTeamOptionPermissionEnum`](modules.md#editteamoptionpermissionenum-1)]

#### Defined in

[models/edit-team-option.ts:73](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/edit-team-option.ts#L73)

___

### <a id="mergepullrequestoptiondoenum" name="mergepullrequestoptiondoenum"></a> MergePullRequestOptionDoEnum

Ƭ **MergePullRequestOptionDoEnum**: typeof [`MergePullRequestOptionDoEnum`](modules.md#mergepullrequestoptiondoenum-1)[keyof typeof [`MergePullRequestOptionDoEnum`](modules.md#mergepullrequestoptiondoenum-1)]

#### Defined in

[models/merge-pull-request-option.ts:75](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/merge-pull-request-option.ts#L75)

___

### <a id="migraterepooptionsserviceenum" name="migraterepooptionsserviceenum"></a> MigrateRepoOptionsServiceEnum

Ƭ **MigrateRepoOptionsServiceEnum**: typeof [`MigrateRepoOptionsServiceEnum`](modules.md#migraterepooptionsserviceenum-1)[keyof typeof [`MigrateRepoOptionsServiceEnum`](modules.md#migraterepooptionsserviceenum-1)]

#### Defined in

[models/migrate-repo-options.ts:152](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/migrate-repo-options.ts#L152)

___

### <a id="teampermissionenum" name="teampermissionenum"></a> TeamPermissionEnum

Ƭ **TeamPermissionEnum**: typeof [`TeamPermissionEnum`](modules.md#teampermissionenum-1)[keyof typeof [`TeamPermissionEnum`](modules.md#teampermissionenum-1)]

#### Defined in

[models/team.ts:90](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/team.ts#L90)

## Variables

### <a id="createhookoptiontypeenum-1" name="createhookoptiontypeenum-1"></a> CreateHookOptionTypeEnum

• `Const` **CreateHookOptionTypeEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Dingtalk` | ``"dingtalk"`` |
| `Discord` | ``"discord"`` |
| `Feishu` | ``"feishu"`` |
| `Gitea` | ``"gitea"`` |
| `Gogs` | ``"gogs"`` |
| `Msteams` | ``"msteams"`` |
| `Slack` | ``"slack"`` |
| `Telegram` | ``"telegram"`` |
| `Wechatwork` | ``"wechatwork"`` |

#### Defined in

[models/create-hook-option.ts:55](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-hook-option.ts#L55)

___

### <a id="createmilestoneoptionstateenum-1" name="createmilestoneoptionstateenum-1"></a> CreateMilestoneOptionStateEnum

• `Const` **CreateMilestoneOptionStateEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Closed` | ``"closed"`` |
| `Open` | ``"open"`` |

#### Defined in

[models/create-milestone-option.ts:49](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-milestone-option.ts#L49)

___

### <a id="createorgoptionvisibilityenum-1" name="createorgoptionvisibilityenum-1"></a> CreateOrgOptionVisibilityEnum

• `Const` **CreateOrgOptionVisibilityEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Limited` | ``"limited"`` |
| `Private` | ``"private"`` |
| `Public` | ``"public"`` |

#### Defined in

[models/create-org-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-org-option.ts#L67)

___

### <a id="createrepooptiontrustmodelenum-1" name="createrepooptiontrustmodelenum-1"></a> CreateRepoOptionTrustModelEnum

• `Const` **CreateRepoOptionTrustModelEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Collaborator` | ``"collaborator"`` |
| `Collaboratorcommitter` | ``"collaboratorcommitter"`` |
| `Committer` | ``"committer"`` |
| `Default` | ``"default"`` |

#### Defined in

[models/create-repo-option.ts:91](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-repo-option.ts#L91)

___

### <a id="createteamoptionpermissionenum-1" name="createteamoptionpermissionenum-1"></a> CreateTeamOptionPermissionEnum

• `Const` **CreateTeamOptionPermissionEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Admin` | ``"admin"`` |
| `Read` | ``"read"`` |
| `Write` | ``"write"`` |

#### Defined in

[models/create-team-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/create-team-option.ts#L67)

___

### <a id="editorgoptionvisibilityenum-1" name="editorgoptionvisibilityenum-1"></a> EditOrgOptionVisibilityEnum

• `Const` **EditOrgOptionVisibilityEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Limited` | ``"limited"`` |
| `Private` | ``"private"`` |
| `Public` | ``"public"`` |

#### Defined in

[models/edit-org-option.ts:61](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/edit-org-option.ts#L61)

___

### <a id="editteamoptionpermissionenum-1" name="editteamoptionpermissionenum-1"></a> EditTeamOptionPermissionEnum

• `Const` **EditTeamOptionPermissionEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Admin` | ``"admin"`` |
| `Read` | ``"read"`` |
| `Write` | ``"write"`` |

#### Defined in

[models/edit-team-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/edit-team-option.ts#L67)

___

### <a id="mergepullrequestoptiondoenum-1" name="mergepullrequestoptiondoenum-1"></a> MergePullRequestOptionDoEnum

• `Const` **MergePullRequestOptionDoEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `ManuallyMerged` | ``"manually-merged"`` |
| `Merge` | ``"merge"`` |
| `Rebase` | ``"rebase"`` |
| `RebaseMerge` | ``"rebase-merge"`` |
| `Squash` | ``"squash"`` |

#### Defined in

[models/merge-pull-request-option.ts:67](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/merge-pull-request-option.ts#L67)

___

### <a id="migraterepooptionsserviceenum-1" name="migraterepooptionsserviceenum-1"></a> MigrateRepoOptionsServiceEnum

• `Const` **MigrateRepoOptionsServiceEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Git` | ``"git"`` |
| `Gitea` | ``"gitea"`` |
| `Github` | ``"github"`` |
| `Gitlab` | ``"gitlab"`` |

#### Defined in

[models/migrate-repo-options.ts:145](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/migrate-repo-options.ts#L145)

___

### <a id="teampermissionenum-1" name="teampermissionenum-1"></a> TeamPermissionEnum

• `Const` **TeamPermissionEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Admin` | ``"admin"`` |
| `None` | ``"none"`` |
| `Owner` | ``"owner"`` |
| `Read` | ``"read"`` |
| `Write` | ``"write"`` |

#### Defined in

[models/team.ts:82](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/models/team.ts#L82)

## Functions

### <a id="adminapiaxiosparamcreator" name="adminapiaxiosparamcreator"></a> AdminApiAxiosParamCreator

▸ **AdminApiAxiosParamCreator**(`configuration?`): `Object`

AdminApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `adminAdoptRepository` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCreateOrg` | (`username`: `string`, `organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCreatePublicKey` | (`username`: `string`, `key?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCreateRepo` | (`username`: `string`, `repository`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCreateUser` | (`body?`: [`CreateUserOption`](interfaces/CreateUserOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCronList` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminCronRun` | (`task`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminDeleteUnadoptedRepository` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminDeleteUser` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminDeleteUserPublicKey` | (`username`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminEditUser` | (`username`: `string`, `body?`: [`EditUserOption`](interfaces/EditUserOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminGetAllOrgs` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminGetAllUsers` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `adminUnadoptedList` | (`page?`: `number`, `limit?`: `number`, `pattern?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/admin-api.ts:47](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/admin-api.ts#L47)

___

### <a id="adminapifactory" name="adminapifactory"></a> AdminApiFactory

▸ **AdminApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

AdminApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `adminAdoptRepository` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `adminCreateOrg` | (`username`: `string`, `organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\> |
| `adminCreatePublicKey` | (`username`: `string`, `key?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `any`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\> |
| `adminCreateRepo` | (`username`: `string`, `repository`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `adminCreateUser` | (`body?`: [`CreateUserOption`](interfaces/CreateUserOption.md), `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)\> |
| `adminCronList` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Cron`](interfaces/Cron.md)[]\> |
| `adminCronRun` | (`task`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `adminDeleteUnadoptedRepository` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `adminDeleteUser` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `adminDeleteUserPublicKey` | (`username`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `adminEditUser` | (`username`: `string`, `body?`: [`EditUserOption`](interfaces/EditUserOption.md), `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)\> |
| `adminGetAllOrgs` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\> |
| `adminGetAllUsers` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `adminUnadoptedList` | (`page?`: `number`, `limit?`: `number`, `pattern?`: `string`, `options?`: `any`) => `AxiosPromise`<`string`[]\> |

#### Defined in

[apis/admin-api.ts:1089](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/admin-api.ts#L1089)

___

### <a id="adminapifp" name="adminapifp"></a> AdminApiFp

▸ **AdminApiFp**(`configuration?`): `Object`

AdminApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `adminAdoptRepository` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `adminCreateOrg` | (`username`: `string`, `organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\>\> |
| `adminCreatePublicKey` | (`username`: `string`, `key?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\>\> |
| `adminCreateRepo` | (`username`: `string`, `repository`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `adminCreateUser` | (`body?`: [`CreateUserOption`](interfaces/CreateUserOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)\>\> |
| `adminCronList` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Cron`](interfaces/Cron.md)[]\>\> |
| `adminCronRun` | (`task`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `adminDeleteUnadoptedRepository` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `adminDeleteUser` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `adminDeleteUserPublicKey` | (`username`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `adminEditUser` | (`username`: `string`, `body?`: [`EditUserOption`](interfaces/EditUserOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)\>\> |
| `adminGetAllOrgs` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\>\> |
| `adminGetAllUsers` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `adminUnadoptedList` | (`page?`: `number`, `limit?`: `number`, `pattern?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> |

#### Defined in

[apis/admin-api.ts:911](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/admin-api.ts#L911)

___

### <a id="issueapiaxiosparamcreator" name="issueapiaxiosparamcreator"></a> IssueApiAxiosParamCreator

▸ **IssueApiAxiosParamCreator**(`configuration?`): `Object`

IssueApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `issueAddLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueAddSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueAddTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`AddTimeOption`](interfaces/AddTimeOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueCheckSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueClearLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueCreateComment` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`CreateIssueCommentOption`](interfaces/CreateIssueCommentOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueCreateIssue` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateIssueOption`](interfaces/CreateIssueOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueCreateLabel` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueCreateMilestone` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateMilestoneOption`](interfaces/CreateMilestoneOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueDeleteTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditIssueOption`](interfaces/EditIssueOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditIssueDeadline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditDeadlineOption`](interfaces/EditDeadlineOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueEditMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditMilestoneOption`](interfaces/EditMilestoneOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetCommentReactions` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `before?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetCommentsAndTimeline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `page?`: `number`, `limit?`: `number`, `before?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetIssueReactions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetMilestonesList` | (`owner`: `string`, `repo`: `string`, `state?`: `string`, `name?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueGetRepoComments` | (`owner`: `string`, `repo`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueListIssues` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `labels?`: `string`, `q?`: `string`, `type?`: ``"issues"`` \| ``"pulls"``, `milestones?`: `string`, `since?`: `string`, `before?`: `string`, `createdBy?`: `string`, `assignedBy?`: `string`, `mentionedBy?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueListLabels` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issuePostCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issuePostIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueRemoveLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueReplaceLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueResetTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueSearchIssues` | (`state?`: `string`, `labels?`: `string`, `milestones?`: `string`, `q?`: `string`, `priorityRepoId?`: `number`, `type?`: `string`, `since?`: `string`, `before?`: `string`, `assigned?`: `boolean`, `created?`: `boolean`, `mentioned?`: `boolean`, `reviewRequested?`: `boolean`, `owner?`: `string`, `team?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueStartStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueStopStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueSubscriptions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `issueTrackedTimes` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/issue-api.ts:71](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/issue-api.ts#L71)

___

### <a id="issueapifactory" name="issueapifactory"></a> IssueApiFactory

▸ **IssueApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

IssueApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `issueAddLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\> |
| `issueAddSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueAddTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`AddTimeOption`](interfaces/AddTimeOption.md), `options?`: `any`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)\> |
| `issueCheckSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\> |
| `issueClearLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueCreateComment` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`CreateIssueCommentOption`](interfaces/CreateIssueCommentOption.md), `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\> |
| `issueCreateIssue` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateIssueOption`](interfaces/CreateIssueOption.md), `options?`: `any`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\> |
| `issueCreateLabel` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `issueCreateMilestone` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateMilestoneOption`](interfaces/CreateMilestoneOption.md), `options?`: `any`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\> |
| `issueDeleteComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueDeleteTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueEditComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\> |
| `issueEditCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\> |
| `issueEditIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditIssueOption`](interfaces/EditIssueOption.md), `options?`: `any`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\> |
| `issueEditIssueDeadline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditDeadlineOption`](interfaces/EditDeadlineOption.md), `options?`: `any`) => `AxiosPromise`<[`IssueDeadline`](interfaces/IssueDeadline.md)\> |
| `issueEditLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `issueEditMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditMilestoneOption`](interfaces/EditMilestoneOption.md), `options?`: `any`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\> |
| `issueGetComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\> |
| `issueGetCommentReactions` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)[]\> |
| `issueGetComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `before?`: `string`, `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)[]\> |
| `issueGetCommentsAndTimeline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `page?`: `number`, `limit?`: `number`, `before?`: `string`, `options?`: `any`) => `AxiosPromise`<[`TimelineComment`](interfaces/TimelineComment.md)[]\> |
| `issueGetIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\> |
| `issueGetIssueReactions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)[]\> |
| `issueGetLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `issueGetLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\> |
| `issueGetMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `any`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\> |
| `issueGetMilestonesList` | (`owner`: `string`, `repo`: `string`, `state?`: `string`, `name?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)[]\> |
| `issueGetRepoComments` | (`owner`: `string`, `repo`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)[]\> |
| `issueListIssues` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `labels?`: `string`, `q?`: `string`, `type?`: ``"issues"`` \| ``"pulls"``, `milestones?`: `string`, `since?`: `string`, `before?`: `string`, `createdBy?`: `string`, `assignedBy?`: `string`, `mentionedBy?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)[]\> |
| `issueListLabels` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\> |
| `issuePostCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `any`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)\> |
| `issuePostIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `any`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)\> |
| `issueRemoveLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueReplaceLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\> |
| `issueResetTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueSearchIssues` | (`state?`: `string`, `labels?`: `string`, `milestones?`: `string`, `q?`: `string`, `priorityRepoId?`: `number`, `type?`: `string`, `since?`: `string`, `before?`: `string`, `assigned?`: `boolean`, `created?`: `boolean`, `mentioned?`: `boolean`, `reviewRequested?`: `boolean`, `owner?`: `string`, `team?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)[]\> |
| `issueStartStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueStopStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `issueSubscriptions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `issueTrackedTimes` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\> |

#### Defined in

[apis/issue-api.ts:4120](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/issue-api.ts#L4120)

___

### <a id="issueapifp" name="issueapifp"></a> IssueApiFp

▸ **IssueApiFp**(`configuration?`): `Object`

IssueApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `issueAddLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\>\> |
| `issueAddSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueAddTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`AddTimeOption`](interfaces/AddTimeOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)\>\> |
| `issueCheckSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\>\> |
| `issueClearLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueCreateComment` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`CreateIssueCommentOption`](interfaces/CreateIssueCommentOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\>\> |
| `issueCreateIssue` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateIssueOption`](interfaces/CreateIssueOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\>\> |
| `issueCreateLabel` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `issueCreateMilestone` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateMilestoneOption`](interfaces/CreateMilestoneOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\>\> |
| `issueDeleteComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueDeleteTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueEditComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\>\> |
| `issueEditCommentDeprecated` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body?`: [`EditIssueCommentOption`](interfaces/EditIssueCommentOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\>\> |
| `issueEditIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditIssueOption`](interfaces/EditIssueOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\>\> |
| `issueEditIssueDeadline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditDeadlineOption`](interfaces/EditDeadlineOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`IssueDeadline`](interfaces/IssueDeadline.md)\>\> |
| `issueEditLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `issueEditMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditMilestoneOption`](interfaces/EditMilestoneOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\>\> |
| `issueGetComment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)\>\> |
| `issueGetCommentReactions` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)[]\>\> |
| `issueGetComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `before?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)[]\>\> |
| `issueGetCommentsAndTimeline` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `since?`: `string`, `page?`: `number`, `limit?`: `number`, `before?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TimelineComment`](interfaces/TimelineComment.md)[]\>\> |
| `issueGetIssue` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)\>\> |
| `issueGetIssueReactions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)[]\>\> |
| `issueGetLabel` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `issueGetLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\>\> |
| `issueGetMilestone` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)\>\> |
| `issueGetMilestonesList` | (`owner`: `string`, `repo`: `string`, `state?`: `string`, `name?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Milestone`](interfaces/Milestone.md)[]\>\> |
| `issueGetRepoComments` | (`owner`: `string`, `repo`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Comment`](interfaces/Comment.md)[]\>\> |
| `issueListIssues` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `labels?`: `string`, `q?`: `string`, `type?`: ``"issues"`` \| ``"pulls"``, `milestones?`: `string`, `since?`: `string`, `before?`: `string`, `createdBy?`: `string`, `assignedBy?`: `string`, `mentionedBy?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)[]\>\> |
| `issueListLabels` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\>\> |
| `issuePostCommentReaction` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)\>\> |
| `issuePostIssueReaction` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `content?`: [`EditReactionOption`](interfaces/EditReactionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reaction`](interfaces/Reaction.md)\>\> |
| `issueRemoveLabel` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueReplaceLabels` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`IssueLabelsOption`](interfaces/IssueLabelsOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\>\> |
| `issueResetTime` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueSearchIssues` | (`state?`: `string`, `labels?`: `string`, `milestones?`: `string`, `q?`: `string`, `priorityRepoId?`: `number`, `type?`: `string`, `since?`: `string`, `before?`: `string`, `assigned?`: `boolean`, `created?`: `boolean`, `mentioned?`: `boolean`, `reviewRequested?`: `boolean`, `owner?`: `string`, `team?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Issue`](interfaces/Issue.md)[]\>\> |
| `issueStartStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueStopStopWatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `issueSubscriptions` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `issueTrackedTimes` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\>\> |

#### Defined in

[apis/issue-api.ts:3431](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/issue-api.ts#L3431)

___

### <a id="miscellaneousapiaxiosparamcreator" name="miscellaneousapiaxiosparamcreator"></a> MiscellaneousApiAxiosParamCreator

▸ **MiscellaneousApiAxiosParamCreator**(`configuration?`): `Object`

MiscellaneousApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getNodeInfo` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getSigningKey` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getVersion` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `renderMarkdown` | (`body?`: [`MarkdownOption`](interfaces/MarkdownOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `renderMarkdownRaw` | (`body`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/miscellaneous-api.ts:33](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/miscellaneous-api.ts#L33)

___

### <a id="miscellaneousapifactory" name="miscellaneousapifactory"></a> MiscellaneousApiFactory

▸ **MiscellaneousApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

MiscellaneousApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getNodeInfo` | (`options?`: `any`) => `AxiosPromise`<[`NodeInfo`](interfaces/NodeInfo.md)\> |
| `getSigningKey` | (`options?`: `any`) => `AxiosPromise`<`string`\> |
| `getVersion` | (`options?`: `any`) => `AxiosPromise`<[`ServerVersion`](interfaces/ServerVersion.md)\> |
| `renderMarkdown` | (`body?`: [`MarkdownOption`](interfaces/MarkdownOption.md), `options?`: `any`) => `AxiosPromise`<`string`\> |
| `renderMarkdownRaw` | (`body`: `string`, `options?`: `any`) => `AxiosPromise`<`string`\> |

#### Defined in

[apis/miscellaneous-api.ts:374](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/miscellaneous-api.ts#L374)

___

### <a id="miscellaneousapifp" name="miscellaneousapifp"></a> MiscellaneousApiFp

▸ **MiscellaneousApiFp**(`configuration?`): `Object`

MiscellaneousApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getNodeInfo` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NodeInfo`](interfaces/NodeInfo.md)\>\> |
| `getSigningKey` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `getVersion` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ServerVersion`](interfaces/ServerVersion.md)\>\> |
| `renderMarkdown` | (`body?`: [`MarkdownOption`](interfaces/MarkdownOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `renderMarkdownRaw` | (`body`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |

#### Defined in

[apis/miscellaneous-api.ts:312](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/miscellaneous-api.ts#L312)

___

### <a id="notificationapiaxiosparamcreator" name="notificationapiaxiosparamcreator"></a> NotificationApiAxiosParamCreator

▸ **NotificationApiAxiosParamCreator**(`configuration?`): `Object`

NotificationApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `notifyGetList` | (`all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyGetRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyGetThread` | (`id`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyNewAvailable` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyReadList` | (`lastReadAt?`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyReadRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `lastReadAt?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `notifyReadThread` | (`id`: `string`, `toStatus?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/notification-api.ts:31](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/notification-api.ts#L31)

___

### <a id="notificationapifactory" name="notificationapifactory"></a> NotificationApiFactory

▸ **NotificationApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

NotificationApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `notifyGetList` | (`all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\> |
| `notifyGetRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\> |
| `notifyGetThread` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)\> |
| `notifyNewAvailable` | (`options?`: `any`) => `AxiosPromise`<[`NotificationCount`](interfaces/NotificationCount.md)\> |
| `notifyReadList` | (`lastReadAt?`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\> |
| `notifyReadRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `lastReadAt?`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\> |
| `notifyReadThread` | (`id`: `string`, `toStatus?`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)\> |

#### Defined in

[apis/notification-api.ts:664](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/notification-api.ts#L664)

___

### <a id="notificationapifp" name="notificationapifp"></a> NotificationApiFp

▸ **NotificationApiFp**(`configuration?`): `Object`

NotificationApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `notifyGetList` | (`all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\>\> |
| `notifyGetRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `boolean`, `statusTypes?`: `string`[], `subjectType?`: (``"repository"`` \| ``"issue"`` \| ``"pull"`` \| ``"commit"``)[], `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\>\> |
| `notifyGetThread` | (`id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)\>\> |
| `notifyNewAvailable` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationCount`](interfaces/NotificationCount.md)\>\> |
| `notifyReadList` | (`lastReadAt?`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\>\> |
| `notifyReadRepoList` | (`owner`: `string`, `repo`: `string`, `all?`: `string`, `statusTypes?`: `string`[], `toStatus?`: `string`, `lastReadAt?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)[]\>\> |
| `notifyReadThread` | (`id`: `string`, `toStatus?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationThread`](interfaces/NotificationThread.md)\>\> |

#### Defined in

[apis/notification-api.ts:555](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/notification-api.ts#L555)

___

### <a id="organizationapiaxiosparamcreator" name="organizationapiaxiosparamcreator"></a> OrganizationApiAxiosParamCreator

▸ **OrganizationApiAxiosParamCreator**(`configuration?`): `Object`

OrganizationApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createOrgRepo` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `createOrgRepoDeprecated` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgAddTeamMember` | (`id`: `number`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgAddTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgConcealMember` | (`org`: `string`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgCreate` | (`organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgCreateHook` | (`org`: `string`, `body`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgCreateLabel` | (`org`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgCreateTeam` | (`org`: `string`, `body?`: [`CreateTeamOption`](interfaces/CreateTeamOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgDelete` | (`org`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgDeleteHook` | (`org`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgDeleteLabel` | (`org`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgDeleteMember` | (`org`: `string`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgDeleteTeam` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgEdit` | (`org`: `string`, `body`: [`EditOrgOption`](interfaces/EditOrgOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgEditHook` | (`org`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgEditLabel` | (`org`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgEditTeam` | (`id`: `number`, `body?`: [`EditTeamOption`](interfaces/EditTeamOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGet` | (`org`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGetAll` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGetHook` | (`org`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGetLabel` | (`org`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGetTeam` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgGetUserPermissions` | (`username`: `string`, `org`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgIsMember` | (`org`: `string`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgIsPublicMember` | (`org`: `string`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListCurrentUserOrgs` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListHooks` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListLabels` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListPublicMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListRepos` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListTeamMember` | (`id`: `number`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListTeamMembers` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListTeamRepos` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListTeams` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgListUserOrgs` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgPublicizeMember` | (`org`: `string`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgRemoveTeamMember` | (`id`: `number`, `username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `orgRemoveTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `teamSearch` | (`org`: `string`, `q?`: `string`, `includeDesc?`: `boolean`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/organization-api.ts:61](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/organization-api.ts#L61)

___

### <a id="organizationapifactory" name="organizationapifactory"></a> OrganizationApiFactory

▸ **OrganizationApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

OrganizationApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createOrgRepo` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `createOrgRepoDeprecated` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `orgAddTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgAddTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgConcealMember` | (`org`: `string`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgCreate` | (`organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\> |
| `orgCreateHook` | (`org`: `string`, `body`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `orgCreateLabel` | (`org`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `orgCreateTeam` | (`org`: `string`, `body?`: [`CreateTeamOption`](interfaces/CreateTeamOption.md), `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\> |
| `orgDelete` | (`org`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgDeleteHook` | (`org`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgDeleteLabel` | (`org`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgDeleteMember` | (`org`: `string`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgDeleteTeam` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgEdit` | (`org`: `string`, `body`: [`EditOrgOption`](interfaces/EditOrgOption.md), `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\> |
| `orgEditHook` | (`org`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `orgEditLabel` | (`org`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `orgEditTeam` | (`id`: `number`, `body?`: [`EditTeamOption`](interfaces/EditTeamOption.md), `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\> |
| `orgGet` | (`org`: `string`, `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\> |
| `orgGetAll` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\> |
| `orgGetHook` | (`org`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `orgGetLabel` | (`org`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\> |
| `orgGetTeam` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\> |
| `orgGetUserPermissions` | (`username`: `string`, `org`: `string`, `options?`: `any`) => `AxiosPromise`<[`OrganizationPermissions`](interfaces/OrganizationPermissions.md)\> |
| `orgIsMember` | (`org`: `string`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgIsPublicMember` | (`org`: `string`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgListCurrentUserOrgs` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\> |
| `orgListHooks` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)[]\> |
| `orgListLabels` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\> |
| `orgListMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `orgListPublicMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `orgListRepos` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `orgListTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)\> |
| `orgListTeamMembers` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `orgListTeamRepos` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `orgListTeams` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\> |
| `orgListUserOrgs` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\> |
| `orgPublicizeMember` | (`org`: `string`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgRemoveTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `orgRemoveTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `teamSearch` | (`org`: `string`, `q?`: `string`, `includeDesc?`: `boolean`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`TeamSearch200Response`](interfaces/TeamSearch200Response.md)\> |

#### Defined in

[apis/organization-api.ts:3127](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/organization-api.ts#L3127)

___

### <a id="organizationapifp" name="organizationapifp"></a> OrganizationApiFp

▸ **OrganizationApiFp**(`configuration?`): `Object`

OrganizationApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createOrgRepo` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `createOrgRepoDeprecated` | (`org`: `string`, `body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `orgAddTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgAddTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgConcealMember` | (`org`: `string`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgCreate` | (`organization`: [`CreateOrgOption`](interfaces/CreateOrgOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\>\> |
| `orgCreateHook` | (`org`: `string`, `body`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `orgCreateLabel` | (`org`: `string`, `body?`: [`CreateLabelOption`](interfaces/CreateLabelOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `orgCreateTeam` | (`org`: `string`, `body?`: [`CreateTeamOption`](interfaces/CreateTeamOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\>\> |
| `orgDelete` | (`org`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgDeleteHook` | (`org`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgDeleteLabel` | (`org`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgDeleteMember` | (`org`: `string`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgDeleteTeam` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgEdit` | (`org`: `string`, `body`: [`EditOrgOption`](interfaces/EditOrgOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\>\> |
| `orgEditHook` | (`org`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `orgEditLabel` | (`org`: `string`, `id`: `number`, `body?`: [`EditLabelOption`](interfaces/EditLabelOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `orgEditTeam` | (`id`: `number`, `body?`: [`EditTeamOption`](interfaces/EditTeamOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\>\> |
| `orgGet` | (`org`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)\>\> |
| `orgGetAll` | (`lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\>\> |
| `orgGetHook` | (`org`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `orgGetLabel` | (`org`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)\>\> |
| `orgGetTeam` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\>\> |
| `orgGetUserPermissions` | (`username`: `string`, `org`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`OrganizationPermissions`](interfaces/OrganizationPermissions.md)\>\> |
| `orgIsMember` | (`org`: `string`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgIsPublicMember` | (`org`: `string`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgListCurrentUserOrgs` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\>\> |
| `orgListHooks` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)[]\>\> |
| `orgListLabels` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Label`](interfaces/Label.md)[]\>\> |
| `orgListMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `orgListPublicMembers` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `orgListRepos` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `orgListTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)\>\> |
| `orgListTeamMembers` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `orgListTeamRepos` | (`id`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `orgListTeams` | (`org`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\>\> |
| `orgListUserOrgs` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Organization`](interfaces/Organization.md)[]\>\> |
| `orgPublicizeMember` | (`org`: `string`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgRemoveTeamMember` | (`id`: `number`, `username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `orgRemoveTeamRepository` | (`id`: `number`, `org`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `teamSearch` | (`org`: `string`, `q?`: `string`, `includeDesc?`: `boolean`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TeamSearch200Response`](interfaces/TeamSearch200Response.md)\>\> |

#### Defined in

[apis/organization-api.ts:2612](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/organization-api.ts#L2612)

___

### <a id="repositoryapiaxiosparamcreator" name="repositoryapiaxiosparamcreator"></a> RepositoryApiAxiosParamCreator

▸ **RepositoryApiAxiosParamCreator**(`configuration?`): `Object`

RepositoryApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `acceptRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `createFork` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateForkOption`](interfaces/CreateForkOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `generateRepo` | (`templateOwner`: `string`, `templateRepo`: `string`, `body?`: [`GenerateRepoOption`](interfaces/GenerateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getAnnotatedTag` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getBlob` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getTree` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `recursive?`: `boolean`, `page?`: `number`, `perPage?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `listForks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `rejectRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoAddCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `body?`: [`AddCollaboratorOption`](interfaces/AddCollaboratorOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoAddTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoAddTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCheckCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCheckTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateBranch` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchRepoOption`](interfaces/CreateBranchRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateBranchProtection` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchProtectionOption`](interfaces/CreateBranchProtectionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`CreateFileOptions`](interfaces/CreateFileOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateHook` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateKey` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreatePullRequest` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreatePullRequestOption`](interfaces/CreatePullRequestOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreatePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`CreatePullReviewOptions`](interfaces/CreatePullReviewOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreatePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateRelease` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateReleaseOption`](interfaces/CreateReleaseOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachment`: `File`, `name?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateStatus` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `body?`: [`CreateStatusOption`](interfaces/CreateStatusOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateTag` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateTagOption`](interfaces/CreateTagOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoCreateWikiPage` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDelete` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`DeleteFileOptions`](interfaces/DeleteFileOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeletePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeletePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDeleteWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`DismissPullReviewOptions`](interfaces/DismissPullReviewOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDownloadCommitDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `diffType`: ``"patch"`` \| ``"diff"``, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoDownloadPullDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `diffType`: ``"patch"`` \| ``"diff"``, `binary?`: `boolean`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEdit` | (`owner`: `string`, `repo`: `string`, `body?`: [`EditRepoOption`](interfaces/EditRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `body?`: [`EditBranchProtectionOption`](interfaces/EditBranchProtectionOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditGitHookOption`](interfaces/EditGitHookOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditPullRequestOption`](interfaces/EditPullRequestOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditReleaseOption`](interfaces/EditReleaseOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `body?`: [`EditAttachmentOptions`](interfaces/EditAttachmentOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoEditWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGet` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetAllCommits` | (`owner`: `string`, `repo`: `string`, `sha?`: `string`, `path?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetArchive` | (`owner`: `string`, `repo`: `string`, `archive`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetAssignees` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetByID` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetCombinedStatusByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetContents` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetContentsList` | (`owner`: `string`, `repo`: `string`, `ref?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetEditorConfig` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetIssueTemplates` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetLanguages` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetNote` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetPullRequestCommits` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetPullReviewComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetRawFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetReviewers` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetSingleCommit` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetWikiPageRevisions` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `page?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoGetWikiPages` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListAllGitRefs` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListBranchProtection` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListBranches` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListCollaborators` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListGitHooks` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListGitRefs` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListHooks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListKeys` | (`owner`: `string`, `repo`: `string`, `keyId?`: `number`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListPullRequests` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `sort?`: ``"priority"`` \| ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"mostcomment"`` \| ``"leastcomment"``, `milestone?`: `number`, `labels?`: `number`[], `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListPullReviews` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListReleaseAttachments` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListReleases` | (`owner`: `string`, `repo`: `string`, `draft?`: `boolean`, `preRelease?`: `boolean`, `perPage?`: `number`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListStargazers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListStatuses` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListStatusesByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListSubscribers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListTags` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListTeams` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoListTopics` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoMergePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`MergePullRequestOption`](interfaces/MergePullRequestOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoMigrate` | (`body?`: [`MigrateRepoOptions`](interfaces/MigrateRepoOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoMirrorSync` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoPullRequestIsMerged` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoSearch` | (`q?`: `string`, `topic?`: `boolean`, `includeDesc?`: `boolean`, `uid?`: `number`, `priorityOwnerId?`: `number`, `teamId?`: `number`, `starredBy?`: `number`, `_private?`: `boolean`, `isPrivate?`: `boolean`, `template?`: `boolean`, `archived?`: `boolean`, `mode?`: `string`, `exclusive?`: `boolean`, `repo?`: `string`, `owner?`: `string`, `lang?`: `string`, `subject?`: `string`, `book?`: `string`, `includeMetadata?`: `boolean`, `sort?`: `string`, `order?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoSigningKey` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoSubmitPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`SubmitPullReviewOptions`](interfaces/SubmitPullReviewOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoTestHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoTransfer` | (`owner`: `string`, `repo`: `string`, `body`: [`TransferRepoOption`](interfaces/TransferRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoUnDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoUpdateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`UpdateFileOptions`](interfaces/UpdateFileOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoUpdatePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `style?`: ``"merge"`` \| ``"rebase"``, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `repoUpdateTopics` | (`owner`: `string`, `repo`: `string`, `body?`: [`RepoTopicOptions`](interfaces/RepoTopicOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `topicSearch` | (`q`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentCheckSubscription` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentPutSubscription` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/repository-api.ts:159](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/repository-api.ts#L159)

___

### <a id="repositoryapifactory" name="repositoryapifactory"></a> RepositoryApiFactory

▸ **RepositoryApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

RepositoryApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `acceptRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `createFork` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateForkOption`](interfaces/CreateForkOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `generateRepo` | (`templateOwner`: `string`, `templateRepo`: `string`, `body?`: [`GenerateRepoOption`](interfaces/GenerateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `getAnnotatedTag` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `any`) => `AxiosPromise`<[`AnnotatedTag`](interfaces/AnnotatedTag.md)\> |
| `getBlob` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `any`) => `AxiosPromise`<[`GitBlobResponse`](interfaces/GitBlobResponse.md)\> |
| `getTree` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `recursive?`: `boolean`, `page?`: `number`, `perPage?`: `number`, `options?`: `any`) => `AxiosPromise`<[`GitTreeResponse`](interfaces/GitTreeResponse.md)\> |
| `listForks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `rejectRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoAddCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `body?`: [`AddCollaboratorOption`](interfaces/AddCollaboratorOption.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoAddTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoAddTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoCheckCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoCheckTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\> |
| `repoCreateBranch` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchRepoOption`](interfaces/CreateBranchRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)\> |
| `repoCreateBranchProtection` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchProtectionOption`](interfaces/CreateBranchProtectionOption.md), `options?`: `any`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\> |
| `repoCreateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`CreateFileOptions`](interfaces/CreateFileOptions.md), `options?`: `any`) => `AxiosPromise`<[`FileResponse`](interfaces/FileResponse.md)\> |
| `repoCreateHook` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `repoCreateKey` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `any`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)\> |
| `repoCreatePullRequest` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreatePullRequestOption`](interfaces/CreatePullRequestOption.md), `options?`: `any`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\> |
| `repoCreatePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`CreatePullReviewOptions`](interfaces/CreatePullReviewOptions.md), `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\> |
| `repoCreatePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)[]\> |
| `repoCreateRelease` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateReleaseOption`](interfaces/CreateReleaseOption.md), `options?`: `any`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\> |
| `repoCreateReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachment`: `File`, `name?`: `string`, `options?`: `any`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\> |
| `repoCreateStatus` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `body?`: [`CreateStatusOption`](interfaces/CreateStatusOption.md), `options?`: `any`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)\> |
| `repoCreateTag` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateTagOption`](interfaces/CreateTagOption.md), `options?`: `any`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)\> |
| `repoCreateWikiPage` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options?`: `any`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\> |
| `repoDelete` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`DeleteFileOptions`](interfaces/DeleteFileOptions.md), `options?`: `any`) => `AxiosPromise`<[`FileDeleteResponse`](interfaces/FileDeleteResponse.md)\> |
| `repoDeleteGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeletePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeletePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDeleteWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`DismissPullReviewOptions`](interfaces/DismissPullReviewOptions.md), `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\> |
| `repoDownloadCommitDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `diffType`: ``"patch"`` \| ``"diff"``, `options?`: `any`) => `AxiosPromise`<`string`\> |
| `repoDownloadPullDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `diffType`: ``"patch"`` \| ``"diff"``, `binary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`string`\> |
| `repoEdit` | (`owner`: `string`, `repo`: `string`, `body?`: [`EditRepoOption`](interfaces/EditRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoEditBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `body?`: [`EditBranchProtectionOption`](interfaces/EditBranchProtectionOption.md), `options?`: `any`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\> |
| `repoEditGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditGitHookOption`](interfaces/EditGitHookOption.md), `options?`: `any`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)\> |
| `repoEditHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `repoEditPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditPullRequestOption`](interfaces/EditPullRequestOption.md), `options?`: `any`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\> |
| `repoEditRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditReleaseOption`](interfaces/EditReleaseOption.md), `options?`: `any`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\> |
| `repoEditReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `body?`: [`EditAttachmentOptions`](interfaces/EditAttachmentOptions.md), `options?`: `any`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\> |
| `repoEditWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options?`: `any`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\> |
| `repoGet` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoGetAllCommits` | (`owner`: `string`, `repo`: `string`, `sha?`: `string`, `path?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)[]\> |
| `repoGetArchive` | (`owner`: `string`, `repo`: `string`, `archive`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoGetAssignees` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `repoGetBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options?`: `any`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)\> |
| `repoGetBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options?`: `any`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\> |
| `repoGetByID` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoGetCombinedStatusByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`CombinedStatus`](interfaces/CombinedStatus.md)\> |
| `repoGetContents` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options?`: `any`) => `AxiosPromise`<[`ContentsResponse`](interfaces/ContentsResponse.md)\> |
| `repoGetContentsList` | (`owner`: `string`, `repo`: `string`, `ref?`: `string`, `options?`: `any`) => `AxiosPromise`<[`ContentsResponse`](interfaces/ContentsResponse.md)[]\> |
| `repoGetEditorConfig` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoGetGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `any`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)\> |
| `repoGetHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\> |
| `repoGetIssueTemplates` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`IssueTemplate`](interfaces/IssueTemplate.md)[]\> |
| `repoGetKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)\> |
| `repoGetLanguages` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<{ `[key: string]`: `number`;  }\> |
| `repoGetNote` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `any`) => `AxiosPromise`<[`Note`](interfaces/Note.md)\> |
| `repoGetPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\> |
| `repoGetPullRequestCommits` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)[]\> |
| `repoGetPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\> |
| `repoGetPullReviewComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullReviewComment`](interfaces/PullReviewComment.md)[]\> |
| `repoGetRawFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoGetRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\> |
| `repoGetReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options?`: `any`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\> |
| `repoGetReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `any`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\> |
| `repoGetReviewers` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `repoGetSingleCommit` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `any`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)\> |
| `repoGetTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `any`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)\> |
| `repoGetWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options?`: `any`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\> |
| `repoGetWikiPageRevisions` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `page?`: `number`, `options?`: `any`) => `AxiosPromise`<[`WikiCommitList`](interfaces/WikiCommitList.md)\> |
| `repoGetWikiPages` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`WikiPageMetaData`](interfaces/WikiPageMetaData.md)[]\> |
| `repoListAllGitRefs` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`Reference`](interfaces/Reference.md)[]\> |
| `repoListBranchProtection` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)[]\> |
| `repoListBranches` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)[]\> |
| `repoListCollaborators` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `repoListGitHooks` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)[]\> |
| `repoListGitRefs` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `options?`: `any`) => `AxiosPromise`<[`Reference`](interfaces/Reference.md)[]\> |
| `repoListHooks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)[]\> |
| `repoListKeys` | (`owner`: `string`, `repo`: `string`, `keyId?`: `number`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)[]\> |
| `repoListPullRequests` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `sort?`: ``"priority"`` \| ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"mostcomment"`` \| ``"leastcomment"``, `milestone?`: `number`, `labels?`: `number`[], `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)[]\> |
| `repoListPullReviews` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)[]\> |
| `repoListReleaseAttachments` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)[]\> |
| `repoListReleases` | (`owner`: `string`, `repo`: `string`, `draft?`: `boolean`, `preRelease?`: `boolean`, `perPage?`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Release`](interfaces/Release.md)[]\> |
| `repoListStargazers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `repoListStatuses` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)[]\> |
| `repoListStatusesByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)[]\> |
| `repoListSubscribers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `repoListTags` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)[]\> |
| `repoListTeams` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\> |
| `repoListTopics` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`TopicName`](interfaces/TopicName.md)\> |
| `repoMergePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`MergePullRequestOption`](interfaces/MergePullRequestOption.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoMigrate` | (`body?`: [`MigrateRepoOptions`](interfaces/MigrateRepoOptions.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoMirrorSync` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoPullRequestIsMerged` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoSearch` | (`q?`: `string`, `topic?`: `boolean`, `includeDesc?`: `boolean`, `uid?`: `number`, `priorityOwnerId?`: `number`, `teamId?`: `number`, `starredBy?`: `number`, `_private?`: `boolean`, `isPrivate?`: `boolean`, `template?`: `boolean`, `archived?`: `boolean`, `mode?`: `string`, `exclusive?`: `boolean`, `repo?`: `string`, `owner?`: `string`, `lang?`: `string`, `subject?`: `string`, `book?`: `string`, `includeMetadata?`: `boolean`, `sort?`: `string`, `order?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`SearchResults`](interfaces/SearchResults.md)\> |
| `repoSigningKey` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`string`\> |
| `repoSubmitPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`SubmitPullReviewOptions`](interfaces/SubmitPullReviewOptions.md), `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\> |
| `repoTestHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\> |
| `repoTransfer` | (`owner`: `string`, `repo`: `string`, `body`: [`TransferRepoOption`](interfaces/TransferRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `repoUnDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `any`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\> |
| `repoUpdateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`UpdateFileOptions`](interfaces/UpdateFileOptions.md), `options?`: `any`) => `AxiosPromise`<[`FileResponse`](interfaces/FileResponse.md)\> |
| `repoUpdatePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `style?`: ``"merge"`` \| ``"rebase"``, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `repoUpdateTopics` | (`owner`: `string`, `repo`: `string`, `body?`: [`RepoTopicOptions`](interfaces/RepoTopicOptions.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `topicSearch` | (`q`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`TopicResponse`](interfaces/TopicResponse.md)[]\> |
| `userCurrentCheckSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\> |
| `userCurrentDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentPutSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\> |
| `userTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user`: `string`, `options?`: `any`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\> |

#### Defined in

[apis/repository-api.ts:10241](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/repository-api.ts#L10241)

___

### <a id="repositoryapifp" name="repositoryapifp"></a> RepositoryApiFp

▸ **RepositoryApiFp**(`configuration?`): `Object`

RepositoryApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `acceptRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `createFork` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateForkOption`](interfaces/CreateForkOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `generateRepo` | (`templateOwner`: `string`, `templateRepo`: `string`, `body?`: [`GenerateRepoOption`](interfaces/GenerateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `getAnnotatedTag` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AnnotatedTag`](interfaces/AnnotatedTag.md)\>\> |
| `getBlob` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GitBlobResponse`](interfaces/GitBlobResponse.md)\>\> |
| `getTree` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `recursive?`: `boolean`, `page?`: `number`, `perPage?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GitTreeResponse`](interfaces/GitTreeResponse.md)\>\> |
| `listForks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `rejectRepoTransfer` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoAddCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `body?`: [`AddCollaboratorOption`](interfaces/AddCollaboratorOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoAddTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoAddTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoCheckCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoCheckTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)\>\> |
| `repoCreateBranch` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchRepoOption`](interfaces/CreateBranchRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)\>\> |
| `repoCreateBranchProtection` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateBranchProtectionOption`](interfaces/CreateBranchProtectionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\>\> |
| `repoCreateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`CreateFileOptions`](interfaces/CreateFileOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileResponse`](interfaces/FileResponse.md)\>\> |
| `repoCreateHook` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateHookOption`](interfaces/CreateHookOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `repoCreateKey` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)\>\> |
| `repoCreatePullRequest` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreatePullRequestOption`](interfaces/CreatePullRequestOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\>\> |
| `repoCreatePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`CreatePullReviewOptions`](interfaces/CreatePullReviewOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\>\> |
| `repoCreatePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)[]\>\> |
| `repoCreateRelease` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateReleaseOption`](interfaces/CreateReleaseOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\>\> |
| `repoCreateReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachment`: `File`, `name?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\>\> |
| `repoCreateStatus` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `body?`: [`CreateStatusOption`](interfaces/CreateStatusOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)\>\> |
| `repoCreateTag` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateTagOption`](interfaces/CreateTagOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)\>\> |
| `repoCreateWikiPage` | (`owner`: `string`, `repo`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\>\> |
| `repoDelete` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteCollaborator` | (`owner`: `string`, `repo`: `string`, `collaborator`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`DeleteFileOptions`](interfaces/DeleteFileOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileDeleteResponse`](interfaces/FileDeleteResponse.md)\>\> |
| `repoDeleteGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeletePullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeletePullReviewRequests` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body`: [`PullReviewRequestOptions`](interfaces/PullReviewRequestOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteTeam` | (`owner`: `string`, `repo`: `string`, `team`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteTopic` | (`owner`: `string`, `repo`: `string`, `topic`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDeleteWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`DismissPullReviewOptions`](interfaces/DismissPullReviewOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\>\> |
| `repoDownloadCommitDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `diffType`: ``"patch"`` \| ``"diff"``, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `repoDownloadPullDiffOrPatch` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `diffType`: ``"patch"`` \| ``"diff"``, `binary?`: `boolean`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `repoEdit` | (`owner`: `string`, `repo`: `string`, `body?`: [`EditRepoOption`](interfaces/EditRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoEditBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `body?`: [`EditBranchProtectionOption`](interfaces/EditBranchProtectionOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\>\> |
| `repoEditGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `body?`: [`EditGitHookOption`](interfaces/EditGitHookOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)\>\> |
| `repoEditHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditHookOption`](interfaces/EditHookOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `repoEditPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`EditPullRequestOption`](interfaces/EditPullRequestOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\>\> |
| `repoEditRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `body?`: [`EditReleaseOption`](interfaces/EditReleaseOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\>\> |
| `repoEditReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `body?`: [`EditAttachmentOptions`](interfaces/EditAttachmentOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\>\> |
| `repoEditWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `body?`: [`CreateWikiPageOptions`](interfaces/CreateWikiPageOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\>\> |
| `repoGet` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoGetAllCommits` | (`owner`: `string`, `repo`: `string`, `sha?`: `string`, `path?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)[]\>\> |
| `repoGetArchive` | (`owner`: `string`, `repo`: `string`, `archive`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoGetAssignees` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `repoGetBranch` | (`owner`: `string`, `repo`: `string`, `branch`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)\>\> |
| `repoGetBranchProtection` | (`owner`: `string`, `repo`: `string`, `name`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)\>\> |
| `repoGetByID` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoGetCombinedStatusByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CombinedStatus`](interfaces/CombinedStatus.md)\>\> |
| `repoGetContents` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ContentsResponse`](interfaces/ContentsResponse.md)\>\> |
| `repoGetContentsList` | (`owner`: `string`, `repo`: `string`, `ref?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ContentsResponse`](interfaces/ContentsResponse.md)[]\>\> |
| `repoGetEditorConfig` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoGetGitHook` | (`owner`: `string`, `repo`: `string`, `id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)\>\> |
| `repoGetHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)\>\> |
| `repoGetIssueTemplates` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`IssueTemplate`](interfaces/IssueTemplate.md)[]\>\> |
| `repoGetKey` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)\>\> |
| `repoGetLanguages` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<{ `[key: string]`: `number`;  }\>\> |
| `repoGetNote` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Note`](interfaces/Note.md)\>\> |
| `repoGetPullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)\>\> |
| `repoGetPullRequestCommits` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)[]\>\> |
| `repoGetPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\>\> |
| `repoGetPullReviewComments` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReviewComment`](interfaces/PullReviewComment.md)[]\>\> |
| `repoGetRawFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `ref?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoGetRelease` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\>\> |
| `repoGetReleaseAttachment` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `attachmentId`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)\>\> |
| `repoGetReleaseByTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Release`](interfaces/Release.md)\>\> |
| `repoGetReviewers` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `repoGetSingleCommit` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Commit`](interfaces/Commit.md)\>\> |
| `repoGetTag` | (`owner`: `string`, `repo`: `string`, `tag`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)\>\> |
| `repoGetWikiPage` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WikiPage`](interfaces/WikiPage.md)\>\> |
| `repoGetWikiPageRevisions` | (`owner`: `string`, `repo`: `string`, `pageName`: `string`, `page?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WikiCommitList`](interfaces/WikiCommitList.md)\>\> |
| `repoGetWikiPages` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WikiPageMetaData`](interfaces/WikiPageMetaData.md)[]\>\> |
| `repoListAllGitRefs` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reference`](interfaces/Reference.md)[]\>\> |
| `repoListBranchProtection` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BranchProtection`](interfaces/BranchProtection.md)[]\>\> |
| `repoListBranches` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Branch`](interfaces/Branch.md)[]\>\> |
| `repoListCollaborators` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `repoListGitHooks` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GitHook`](interfaces/GitHook.md)[]\>\> |
| `repoListGitRefs` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Reference`](interfaces/Reference.md)[]\>\> |
| `repoListHooks` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Hook`](interfaces/Hook.md)[]\>\> |
| `repoListKeys` | (`owner`: `string`, `repo`: `string`, `keyId?`: `number`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeployKey`](interfaces/DeployKey.md)[]\>\> |
| `repoListPullRequests` | (`owner`: `string`, `repo`: `string`, `state?`: ``"all"`` \| ``"closed"`` \| ``"open"``, `sort?`: ``"priority"`` \| ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"mostcomment"`` \| ``"leastcomment"``, `milestone?`: `number`, `labels?`: `number`[], `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullRequest`](interfaces/PullRequest.md)[]\>\> |
| `repoListPullReviews` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)[]\>\> |
| `repoListReleaseAttachments` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Attachment`](interfaces/Attachment.md)[]\>\> |
| `repoListReleases` | (`owner`: `string`, `repo`: `string`, `draft?`: `boolean`, `preRelease?`: `boolean`, `perPage?`: `number`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Release`](interfaces/Release.md)[]\>\> |
| `repoListStargazers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `repoListStatuses` | (`owner`: `string`, `repo`: `string`, `sha`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)[]\>\> |
| `repoListStatusesByRef` | (`owner`: `string`, `repo`: `string`, `ref`: `string`, `sort?`: ``"oldest"`` \| ``"recentupdate"`` \| ``"leastupdate"`` \| ``"leastindex"`` \| ``"highestindex"``, `state?`: ``"error"`` \| ``"pending"`` \| ``"success"`` \| ``"failure"`` \| ``"warning"``, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CommitStatus`](interfaces/CommitStatus.md)[]\>\> |
| `repoListSubscribers` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `repoListTags` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Tag`](interfaces/Tag.md)[]\>\> |
| `repoListTeams` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\>\> |
| `repoListTopics` | (`owner`: `string`, `repo`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TopicName`](interfaces/TopicName.md)\>\> |
| `repoMergePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `body?`: [`MergePullRequestOption`](interfaces/MergePullRequestOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoMigrate` | (`body?`: [`MigrateRepoOptions`](interfaces/MigrateRepoOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoMirrorSync` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoPullRequestIsMerged` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoSearch` | (`q?`: `string`, `topic?`: `boolean`, `includeDesc?`: `boolean`, `uid?`: `number`, `priorityOwnerId?`: `number`, `teamId?`: `number`, `starredBy?`: `number`, `_private?`: `boolean`, `isPrivate?`: `boolean`, `template?`: `boolean`, `archived?`: `boolean`, `mode?`: `string`, `exclusive?`: `boolean`, `repo?`: `string`, `owner?`: `string`, `lang?`: `string`, `subject?`: `string`, `book?`: `string`, `includeMetadata?`: `boolean`, `sort?`: `string`, `order?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SearchResults`](interfaces/SearchResults.md)\>\> |
| `repoSigningKey` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `repoSubmitPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `body`: [`SubmitPullReviewOptions`](interfaces/SubmitPullReviewOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\>\> |
| `repoTestHook` | (`owner`: `string`, `repo`: `string`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user?`: `string`, `since?`: `string`, `before?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\>\> |
| `repoTransfer` | (`owner`: `string`, `repo`: `string`, `body`: [`TransferRepoOption`](interfaces/TransferRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `repoUnDismissPullReview` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PullReview`](interfaces/PullReview.md)\>\> |
| `repoUpdateFile` | (`owner`: `string`, `repo`: `string`, `filepath`: `string`, `body`: [`UpdateFileOptions`](interfaces/UpdateFileOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileResponse`](interfaces/FileResponse.md)\>\> |
| `repoUpdatePullRequest` | (`owner`: `string`, `repo`: `string`, `index`: `number`, `style?`: ``"merge"`` \| ``"rebase"``, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `repoUpdateTopics` | (`owner`: `string`, `repo`: `string`, `body?`: [`RepoTopicOptions`](interfaces/RepoTopicOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `topicSearch` | (`q`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TopicResponse`](interfaces/TopicResponse.md)[]\>\> |
| `userCurrentCheckSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\>\> |
| `userCurrentDeleteSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentPutSubscription` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WatchInfo`](interfaces/WatchInfo.md)\>\> |
| `userTrackedTimes` | (`owner`: `string`, `repo`: `string`, `user`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\>\> |

#### Defined in

[apis/repository-api.ts:8540](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/repository-api.ts#L8540)

___

### <a id="settingsapiaxiosparamcreator" name="settingsapiaxiosparamcreator"></a> SettingsApiAxiosParamCreator

▸ **SettingsApiAxiosParamCreator**(`configuration?`): `Object`

SettingsApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getGeneralAPISettings` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getGeneralAttachmentSettings` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getGeneralRepositorySettings` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getGeneralUISettings` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/settings-api.ts:35](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/settings-api.ts#L35)

___

### <a id="settingsapifactory" name="settingsapifactory"></a> SettingsApiFactory

▸ **SettingsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

SettingsApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getGeneralAPISettings` | (`options?`: `any`) => `AxiosPromise`<[`GeneralAPISettings`](interfaces/GeneralAPISettings.md)\> |
| `getGeneralAttachmentSettings` | (`options?`: `any`) => `AxiosPromise`<[`GeneralAttachmentSettings`](interfaces/GeneralAttachmentSettings.md)\> |
| `getGeneralRepositorySettings` | (`options?`: `any`) => `AxiosPromise`<[`GeneralRepoSettings`](interfaces/GeneralRepoSettings.md)\> |
| `getGeneralUISettings` | (`options?`: `any`) => `AxiosPromise`<[`GeneralUISettings`](interfaces/GeneralUISettings.md)\> |

#### Defined in

[apis/settings-api.ts:302](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/settings-api.ts#L302)

___

### <a id="settingsapifp" name="settingsapifp"></a> SettingsApiFp

▸ **SettingsApiFp**(`configuration?`): `Object`

SettingsApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `getGeneralAPISettings` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GeneralAPISettings`](interfaces/GeneralAPISettings.md)\>\> |
| `getGeneralAttachmentSettings` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GeneralAttachmentSettings`](interfaces/GeneralAttachmentSettings.md)\>\> |
| `getGeneralRepositorySettings` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GeneralRepoSettings`](interfaces/GeneralRepoSettings.md)\>\> |
| `getGeneralUISettings` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GeneralUISettings`](interfaces/GeneralUISettings.md)\>\> |

#### Defined in

[apis/settings-api.ts:252](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/settings-api.ts#L252)

___

### <a id="userapiaxiosparamcreator" name="userapiaxiosparamcreator"></a> UserApiAxiosParamCreator

▸ **UserApiAxiosParamCreator**(`configuration?`): `Object`

UserApi - axios parameter creator

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getUserSettings` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `getVerificationToken` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `updateUserSettings` | (`body?`: [`UserSettingsOptions`](interfaces/UserSettingsOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userAddEmail` | (`body?`: [`CreateEmailOption`](interfaces/CreateEmailOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCheckFollowing` | (`follower`: `string`, `followee`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCreateOAuth2Application` | (`body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCreateToken` | (`username`: `string`, `userCreateToken?`: [`CreateAccessTokenOption`](interfaces/CreateAccessTokenOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentCheckFollowing` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentCheckStarring` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentDeleteFollow` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentDeleteGPGKey` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentDeleteKey` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentDeleteStar` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentGetGPGKey` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentGetKey` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListFollowers` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListFollowing` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListGPGKeys` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListKeys` | (`fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListRepos` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListStarred` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentListSubscriptions` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentPostGPGKey` | (`form?`: [`CreateGPGKeyOption`](interfaces/CreateGPGKeyOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentPostKey` | (`body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentPutFollow` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentPutStar` | (`owner`: `string`, `repo`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userCurrentTrackedTimes` | (`since?`: `string`, `before?`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userDeleteAccessToken` | (`username`: `string`, `token`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userDeleteEmail` | (`body?`: [`DeleteEmailOption`](interfaces/DeleteEmailOption.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userDeleteOAuth2Application` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGet` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetCurrent` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetHeatmapData` | (`username`: `string`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetOAuth2Application` | (`id`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetOauth2Application` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetStopWatches` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userGetTokens` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListEmails` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListFollowers` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListFollowing` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListGPGKeys` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListKeys` | (`username`: `string`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListRepos` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListStarred` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListSubscriptions` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userListTeams` | (`page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userSearch` | (`q?`: `string`, `uid?`: `number`, `lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userUpdateOAuth2Application` | (`id`: `number`, `body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |
| `userVerifyGPGKey` | (`options`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> |

#### Defined in

[apis/user-api.ts:69](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/user-api.ts#L69)

___

### <a id="userapifactory" name="userapifactory"></a> UserApiFactory

▸ **UserApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object`

UserApi - factory interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |
| `basePath?` | `string` |
| `axios?` | `AxiosInstance` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\> |
| `getUserSettings` | (`options?`: `any`) => `AxiosPromise`<[`UserSettings`](interfaces/UserSettings.md)[]\> |
| `getVerificationToken` | (`options?`: `any`) => `AxiosPromise`<`string`\> |
| `updateUserSettings` | (`body?`: [`UserSettingsOptions`](interfaces/UserSettingsOptions.md), `options?`: `any`) => `AxiosPromise`<[`UserSettings`](interfaces/UserSettings.md)[]\> |
| `userAddEmail` | (`body?`: [`CreateEmailOption`](interfaces/CreateEmailOption.md), `options?`: `any`) => `AxiosPromise`<[`Email`](interfaces/Email.md)[]\> |
| `userCheckFollowing` | (`follower`: `string`, `followee`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCreateOAuth2Application` | (`body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options?`: `any`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\> |
| `userCreateToken` | (`username`: `string`, `userCreateToken?`: [`CreateAccessTokenOption`](interfaces/CreateAccessTokenOption.md), `options?`: `any`) => `AxiosPromise`<[`AccessToken`](interfaces/AccessToken.md)\> |
| `userCurrentCheckFollowing` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentCheckStarring` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentDeleteFollow` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentDeleteGPGKey` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentDeleteKey` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentDeleteStar` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentGetGPGKey` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\> |
| `userCurrentGetKey` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\> |
| `userCurrentListFollowers` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `userCurrentListFollowing` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `userCurrentListGPGKeys` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)[]\> |
| `userCurrentListKeys` | (`fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)[]\> |
| `userCurrentListRepos` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userCurrentListStarred` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userCurrentListSubscriptions` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userCurrentPostGPGKey` | (`form?`: [`CreateGPGKeyOption`](interfaces/CreateGPGKeyOption.md), `options?`: `any`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\> |
| `userCurrentPostKey` | (`body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `any`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\> |
| `userCurrentPutFollow` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentPutStar` | (`owner`: `string`, `repo`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userCurrentTrackedTimes` | (`since?`: `string`, `before?`: `string`, `options?`: `any`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\> |
| `userDeleteAccessToken` | (`username`: `string`, `token`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userDeleteEmail` | (`body?`: [`DeleteEmailOption`](interfaces/DeleteEmailOption.md), `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userDeleteOAuth2Application` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> |
| `userGet` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)\> |
| `userGetCurrent` | (`options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)\> |
| `userGetHeatmapData` | (`username`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserHeatmapData`](interfaces/UserHeatmapData.md)[]\> |
| `userGetOAuth2Application` | (`id`: `number`, `options?`: `any`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\> |
| `userGetOauth2Application` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)[]\> |
| `userGetStopWatches` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`StopWatch`](interfaces/StopWatch.md)[]\> |
| `userGetTokens` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`AccessToken`](interfaces/AccessToken.md)[]\> |
| `userListEmails` | (`options?`: `any`) => `AxiosPromise`<[`Email`](interfaces/Email.md)[]\> |
| `userListFollowers` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `userListFollowing` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\> |
| `userListGPGKeys` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)[]\> |
| `userListKeys` | (`username`: `string`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)[]\> |
| `userListRepos` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userListStarred` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userListSubscriptions` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\> |
| `userListTeams` | (`page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\> |
| `userSearch` | (`q?`: `string`, `uid?`: `number`, `lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`UserSearch200Response`](interfaces/UserSearch200Response.md)\> |
| `userUpdateOAuth2Application` | (`id`: `number`, `body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options?`: `any`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\> |
| `userVerifyGPGKey` | (`options?`: `any`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\> |

#### Defined in

[apis/user-api.ts:3666](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/user-api.ts#L3666)

___

### <a id="userapifp" name="userapifp"></a> UserApiFp

▸ **UserApiFp**(`configuration?`): `Object`

UserApi - functional programming interface

**`export`**

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration?` | [`Configuration`](classes/Configuration.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `createCurrentUserRepo` | (`body?`: [`CreateRepoOption`](interfaces/CreateRepoOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)\>\> |
| `getUserSettings` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserSettings`](interfaces/UserSettings.md)[]\>\> |
| `getVerificationToken` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> |
| `updateUserSettings` | (`body?`: [`UserSettingsOptions`](interfaces/UserSettingsOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserSettings`](interfaces/UserSettings.md)[]\>\> |
| `userAddEmail` | (`body?`: [`CreateEmailOption`](interfaces/CreateEmailOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Email`](interfaces/Email.md)[]\>\> |
| `userCheckFollowing` | (`follower`: `string`, `followee`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCreateOAuth2Application` | (`body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\>\> |
| `userCreateToken` | (`username`: `string`, `userCreateToken?`: [`CreateAccessTokenOption`](interfaces/CreateAccessTokenOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AccessToken`](interfaces/AccessToken.md)\>\> |
| `userCurrentCheckFollowing` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentCheckStarring` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentDeleteFollow` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentDeleteGPGKey` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentDeleteKey` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentDeleteStar` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentGetGPGKey` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\>\> |
| `userCurrentGetKey` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\>\> |
| `userCurrentListFollowers` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `userCurrentListFollowing` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `userCurrentListGPGKeys` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)[]\>\> |
| `userCurrentListKeys` | (`fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)[]\>\> |
| `userCurrentListRepos` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userCurrentListStarred` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userCurrentListSubscriptions` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userCurrentPostGPGKey` | (`form?`: [`CreateGPGKeyOption`](interfaces/CreateGPGKeyOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\>\> |
| `userCurrentPostKey` | (`body?`: [`CreateKeyOption`](interfaces/CreateKeyOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)\>\> |
| `userCurrentPutFollow` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentPutStar` | (`owner`: `string`, `repo`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userCurrentTrackedTimes` | (`since?`: `string`, `before?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TrackedTime`](interfaces/TrackedTime.md)[]\>\> |
| `userDeleteAccessToken` | (`username`: `string`, `token`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userDeleteEmail` | (`body?`: [`DeleteEmailOption`](interfaces/DeleteEmailOption.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userDeleteOAuth2Application` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> |
| `userGet` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)\>\> |
| `userGetCurrent` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)\>\> |
| `userGetHeatmapData` | (`username`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserHeatmapData`](interfaces/UserHeatmapData.md)[]\>\> |
| `userGetOAuth2Application` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\>\> |
| `userGetOauth2Application` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)[]\>\> |
| `userGetStopWatches` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`StopWatch`](interfaces/StopWatch.md)[]\>\> |
| `userGetTokens` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AccessToken`](interfaces/AccessToken.md)[]\>\> |
| `userListEmails` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Email`](interfaces/Email.md)[]\>\> |
| `userListFollowers` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `userListFollowing` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`User`](interfaces/User.md)[]\>\> |
| `userListGPGKeys` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)[]\>\> |
| `userListKeys` | (`username`: `string`, `fingerprint?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicKey`](interfaces/PublicKey.md)[]\>\> |
| `userListRepos` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userListStarred` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userListSubscriptions` | (`username`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Repository`](interfaces/Repository.md)[]\>\> |
| `userListTeams` | (`page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Team`](interfaces/Team.md)[]\>\> |
| `userSearch` | (`q?`: `string`, `uid?`: `number`, `lang?`: `string`, `page?`: `number`, `limit?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserSearch200Response`](interfaces/UserSearch200Response.md)\>\> |
| `userUpdateOAuth2Application` | (`id`: `number`, `body`: [`CreateOAuth2ApplicationOptions`](interfaces/CreateOAuth2ApplicationOptions.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`OAuth2Application`](interfaces/OAuth2Application.md)\>\> |
| `userVerifyGPGKey` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GPGKey`](interfaces/GPGKey.md)\>\> |

#### Defined in

[apis/user-api.ts:3071](https://github.com/unfoldingWord/dcs-js/blob/09d5a5e/apis/user-api.ts#L3071)