condoit
Version:
[](https://securisec.github.io/condoit/) 
1,162 lines • 66.6 kB
TypeScript
import { AxiosInstance } from 'axios';
import * as iAlmanac from './interfaces/iAlmanac';
import * as iAudit from './interfaces/iAudit';
import * as iAuth from './interfaces/iAuth';
import * as iBadge from './interfaces/iBadge';
import * as iConduit from './interfaces/iConduit';
import * as iConpherence from './interfaces/iConpherence';
import * as iCountdown from './interfaces/iCountdown';
import * as iDifferential from './interfaces/iDifferential';
import * as iDiffusion from './interfaces/iDiffusion';
import * as iDrydock from './interfaces/iDrydock';
import * as iEdge from './interfaces/iEdge';
import * as iFeed from './interfaces/iFeed';
import * as iFile from './interfaces/iFile';
import * as iFlag from './interfaces/iFlag';
import * as iHarbormaster from './interfaces/iHarbormaster';
import * as iMacro from './interfaces/iMacro';
import * as iManiphest from './interfaces/iManiphest';
import * as iOwners from './interfaces/iOwners';
import * as iPassphrase from './interfaces/iPassphrase';
import * as iPaste from './interfaces/iPaste';
import * as iPhame from './interfaces/iPhame';
import * as iPhid from './interfaces/iPhid';
import * as iPhriction from './interfaces/iPhriction';
import * as iPortal from './interfaces/iPortal';
import * as iProject from './interfaces/iProject';
import * as iRemarkup from './interfaces/iRemarkup';
import * as iRepository from './interfaces/iRepository';
import * as iSlowvote from './interfaces/iSlowvote';
import * as iToken from './interfaces/iToken';
import * as iTransactions from './interfaces/iTransactions';
import * as iUser from './interfaces/iUser';
import { WebhookParse } from './interfaces/iWebook';
import { Transactions, GenericReturn } from './interfaces/iGlobal';
import { transactions } from './transactions';
export { transactions };
/**
*The class to create an instance to use the Phabricator api
*
* @class Condoit
*/
export declare class Condoit {
private baseUrl;
private apiToken;
private headers;
private axiosInstance;
/**
*Creates an instance of Condoit.
* @param {string} baseUrl The base url for a phabricator instance
* @param {string} apiToken A valid phabricator conduit api token
* @param {object} headers Optional headers to pass to the phabricator endpoint
* @param {AxiosInstance | undefined} axiosInstance Optional axios instance to use. If a
* custom axios instance is used, it needs to be set up with the baseURL.
* @memberof Condoit
*/
constructor(baseUrl: string, apiToken: string, headers?: object, axiosInstance?: AxiosInstance | undefined);
/**
*Make a base request to the phabricator api using Axios
*
* @private
* @param {string} endpoint The name of the phabricator api endpoint
* @param {object} params Options or info passed to the api
* @returns {Promise<GenericReturn>}
* @memberof Condoit
*/
private makeRequest;
private returnOptions;
private returnOptionsAttachments;
private transactionOptions;
/**
*Service Directory
*
* @memberof Condoit
*/
almanac: {
/**
*Apply transactions to create a new binding or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.binding.edit/}
*
* @param {iAlmanac.AlmanacBindingEdit} options
* @returns {Promise<Transactions>}
*/
bindingEdit: (options: iAlmanac.AlmanacBindingEdit) => Promise<Transactions>;
/**
*Read information about Almanac bindings.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.binding.search/}
*
* @param {iAlmanac.AlmanacBindingSearch} options
* @returns {Promise<iAlmanac.RetAlmanacBindingSearch>}
*/
bindingSearch: (options: iAlmanac.AlmanacBindingSearch) => Promise<iAlmanac.RetAlmanacBindingSearch>;
/**
*Apply transactions to create a new device or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.device.edit/}
*
* @param {iAlmanac.AlmanacDeviceEdit} options
* @returns {Promise<Transactions>}
*/
deviceEdit: (options: iAlmanac.AlmanacDeviceEdit) => Promise<Transactions>;
/**
*Read information about Almanac devices.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.device.search/}
*
* @param {iAlmanac.AlmanacDeviceSearch} options
* @returns {Promise<iAlmanac.RetAlmanacDeviceSearch>}
*/
deviceSearch: (options: iAlmanac.AlmanacDeviceSearch) => Promise<iAlmanac.RetAlmanacDeviceSearch>;
/**
*Apply transactions to create a new interface or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.interface.edit/}
*
* @param {iAlmanac.AlmanacInterfaceEdit} options
* @returns {Promise<Transactions>}
*/
interfaceEdit: (options: iAlmanac.AlmanacInterfaceEdit) => Promise<Transactions>;
/**
*Read information about Almanac interfaces.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.interface.search/}
*
* @param {iAlmanac.AlmanacInterfaceSearch} options
* @returns {Promise<iAlmanac.RetAlmanacInterfaceSearch>}
*/
interfaceSearch: (options: iAlmanac.AlmanacInterfaceSearch) => Promise<iAlmanac.RetAlmanacInterfaceSearch>;
namespaceEdit: () => never;
/**
*Read information about Almanac namespaces.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.namespace.search/}
*
* @param {iAlmanac.AlmanacNamespaceSearch} options
* @returns {Promise<iAlmanac.RetAlmanacNamespaceSearch>}
*/
namespaceSearch: (options: iAlmanac.AlmanacNamespaceSearch) => Promise<iAlmanac.RetAlmanacNamespaceSearch>;
/**
*Apply transactions to create a new network or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.network.edit/}
*
* @param {iAlmanac.AlmanacNetworkEdit} options
* @returns {Promise<Transactions>}
*/
networkEdit: (options: iAlmanac.AlmanacNetworkEdit) => Promise<Transactions>;
/**
*Read information about Almanac bindings.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.network.search/}
*
* @param {iAlmanac.AlmanacNetworkSearch} options
* @returns {Promise<iAlmanac.RetAlmanacNetworkSearch>}
*/
networkSearch: (options: iAlmanac.AlmanacNetworkSearch) => Promise<iAlmanac.RetAlmanacNetworkSearch>;
/**
*Apply transactions to create a new service or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.service.edit/}
*
* @param {iAlmanac.AlmanacServiceEdit} options
* @returns {Promise<Transactions>}
*/
serviceEdit: (options: iAlmanac.AlmanacServiceEdit) => Promise<Transactions>;
/**
*Read information about Almanac services.
[Docs]{@link https://secure.phabricator.com/conduit/method/almanac.service.search/}
*
* @param {iAlmanac.AlmanacServiceSearch} options
* @returns {Promise<iAlmanac.RetAlmanacServiceSearch>}
*/
serviceSearch: (options: iAlmanac.AlmanacServiceSearch) => Promise<iAlmanac.RetAlmanacServiceSearch>;
};
/**
***Marked for deprecation** Query audit requests.
[Docs]{@link https://secure.phabricator.com/conduit/method/audit.query/}
*
* @memberof Condoit
*/
audit: {
query: (options: iAudit.AuditQuery) => Promise<iAudit.RetAuditQuery>;
};
/**
*Login/Registration
*
* @memberof Condoit
*/
auth: {
/**
*Logout of all sessions.
[Docs]{@link https://secure.phabricator.com/conduit/method/auth.logout/}
*
* @returns {Promise<void>}
*/
logout: () => Promise<void>;
/**
*Query public keys.
[Docs]{@link https://secure.phabricator.com/conduit/method/auth.querypublickeys/}
*
* @param {iAuth.AuthQuerypublickeys} options
* @returns {Promise<iAuth.RetAuthQuerypublickeys>}
*/
querypublickeys: (options: iAuth.AuthQuerypublickeys) => Promise<iAuth.RetAuthQuerypublickeys>;
};
/**
*Achievements and Notoriety
*
* @memberof Condoit
*/
badge: {
/**
*Create or edit a Badge.
[Docs]{@link https://secure.phabricator.com/conduit/method/badge.edit/}
*
* @param {iBadge.BadgeEdit} options
* @returns {Promise<Transactions>}
*/
edit: (options: iBadge.BadgeEdit) => Promise<Transactions>;
/**
*Read information about badges.
[Docs]{@link https://secure.phabricator.com/conduit/method/badge.search/}
*
* @param {iBadge.BadgeSearch} options
* @returns {Promise<iBadge.RetBadgeSearch>}
*/
search: (options: iBadge.BadgeSearch) => Promise<iBadge.RetBadgeSearch>;
};
/**
*Developer API
*
* @memberof Condoit
*/
conduit: {
/**
*Connect a session based client.
[Docs]{@link https://secure.phabricator.com/conduit/method/conduit.connect/}
*
* @param {iConduit.ConduitConnect} options
* @returns {Promise<any>}
*/
connect: (options: iConduit.ConduitConnect) => Promise<any>;
/**
*List capabilities, wire formats, and authentication protocols available on this server.
[Docs]{@link https://secure.phabricator.com/conduit/method/conduit.capabilities/}
*
* @returns {Promise<iConduit.RetConduitCapabilities>}
*/
getcapabilities: () => Promise<iConduit.RetConduitCapabilities>;
/**
*Retreive certificate information for a user.
[Docs]{@link https://secure.phabricator.com/conduit/method/conduit.getcertificate/}
*
* @param {{token: string, host: string}} options
* @returns {Promise<any>}
*/
getcertificate: (options: {
token: string;
host: string;
}) => Promise<any>;
/**
*Basic ping for monitoring or a health-check.
[Docs]{@link https://secure.phabricator.com/conduit/method/conduit.ping/}
*
* @returns {Promise<iConduit.RetConduitPing>}
*/
ping: () => Promise<iConduit.RetConduitPing>;
/**
*Returns the parameters of the Conduit methods.
[Docs]{@link https://secure.phabricator.com/conduit/method/conduit.query/}
*
* @returns {Promise<GenericReturn>}
*/
query: () => Promise<GenericReturn>;
};
/**
*Chat with others.
*
* @memberof Condoit
*/
conpherence: {
/**
***Marked for deprecation** Create a new conpherence thread.
[Docs]{@link https://secure.phabricator.com/conduit/method/conpherence.createthread/}
*
* @param {iConpherence.ConperhenceCreatethread} options
* @returns {Promise<iConpherence.RetConperhenceCreatethread>}
*/
createthread: (options: iConpherence.ConperhenceCreatethread) => Promise<iConpherence.RetConperhenceCreatethread>;
/**
*Apply transactions to create a new room or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/conpherence.edit/}
*
* @param {iConpherence.ConperhenceEdit} options
* @returns {Promise<Transactions>}
*/
edit: (options: iConpherence.ConperhenceEdit) => Promise<Transactions>;
/**
*Query for Conpherence threads for the logged in user. You can query by
IDs or PHIDs for specific Conpherence threads. Otherwise, specify limit
and offset to query the most recently updated Conpherences for the logged in user.
[Docs]{@link https://secure.phabricator.com/conduit/method/conpherence.querythread/}
*
* @param {iConpherence.ConpherenceQuerythread} options
* @returns {Promise<iConpherence.RetConpherenceQuerythread>}
*/
querythread: (options: iConpherence.ConpherenceQuerythread) => Promise<iConpherence.RetConpherenceQuerythread>;
/**
*Query for transactions for the logged in user within a specific
Conpherence room. You can specify the room by ID or PHID. Otherwise,
specify limit and offset to query the most recent transactions within
the Conpherence room for the logged in user.
[Docs]{@link https://secure.phabricator.com/conduit/method/conpherence.querytransaction/}
*
* @param {iConpherence.ConpherenceQuerytransaction} options
* @returns {Promise<iConpherence.RetConpherenceQuerytransaction>}
*/
querytransaction: (options: iConpherence.ConpherenceQuerytransaction) => Promise<iConpherence.RetConpherenceQuerytransaction>;
/**
***Marked for deprecation** Update an existing conpherence room.
[Docs]{@link https://secure.phabricator.com/conduit/method/conpherence.updatethread/}
*
* @param {iConpherence.ConperhenceUpdatethread} options
* @returns {Promise<GenericReturn>}
*/
updatethread: (options: iConpherence.ConperhenceUpdatethread) => Promise<GenericReturn>;
};
/**
*Countdown to Events.
*
* @memberof Condoit
*/
countdown: {
/**
*Read information about countdowns.
[Docs]{@link https://secure.phabricator.com/conduit/method/countdown.search/}
*
* @param {iCountdown.CountdownServiceSearch} options
* @returns {Promise<iCountdown.RetCountdownServiceSearch>}
*/
search: (options: iCountdown.CountdownServiceSearch) => Promise<iCountdown.RetCountdownServiceSearch>;
/**
*Apply transactions to create a new countdown or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/countdown.edit/}
*
* @param {iCountdown.CountdownEdit} options
* @returns {Promise<Transactions>}
*/
edit: (options: iCountdown.CountdownEdit) => Promise<Transactions>;
};
dashboard: {
panelEdit: () => never;
};
/**
*Pre-commit review
*
* @memberof Condoit
*/
differential: {
/**
***Marked for deprecation** Close a differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.close/}
*
* @param {{revisionID: number}} options
* @returns {Promise<GenericReturn>}
*/
close: (options: {
revisionID: number;
}) => Promise<GenericReturn>;
/**
***Marked for deprecation** Add a comment to a differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.createcomment/}
*
* @param {iDifferential.DiffComment} options
* @returns {Promise<GenericReturn>}
*/
createcomment: (options: iDifferential.DiffComment) => Promise<GenericReturn>;
/**
*Create a new Differential diff.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.creatediff/}
*
* @param {iDifferential.DiffCreatediff} options
* @returns {Promise<GenericReturn>}
*/
creatediff: (options: iDifferential.DiffCreatediff) => Promise<GenericReturn>;
/**
*Add an inline comment to a Differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.createinline/}
*
* @param {iDifferential.DiffCreateinline} options
* @returns {Promise<string>}
*/
createinline: (options: iDifferential.DiffCreateinline) => Promise<string>;
/**
*Create a new Differential diff from a raw diff source.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.createrawdiff/}
*
* @param {iDifferential.DiffCreaterawdiff} options
* @returns {Promise<GenericReturn>}
*/
createrawdiff: (options: iDifferential.DiffCreaterawdiff) => Promise<GenericReturn>;
/**
***Marked for deprecation** Create a new differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.createrevision/}
*
* @param {{
* diffid: string;
* fields: object;
* }} options
* @returns {Promise<GenericReturn>}
*/
createrevision: (options: {
diffid: string;
fields: object;
}) => Promise<GenericReturn>;
/**
*Read information about diffs.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.diff.search/}
*
* @param {iDifferential.DiffDiffSearch} options
* @returns {Promise<iDifferential.RetDiffDiffSearch>}
*/
diffSearch: (options: iDifferential.DiffDiffSearch) => Promise<iDifferential.RetDiffDiffSearch>;
/**
*Retrieve Differential commit messages or message templates.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.getcommitmessage/}
*
* @param {iDifferential.DiffGetcommitmessage} options
* @returns {Promise<GenericReturn>}
*/
getcommitmessage: (options: iDifferential.DiffGetcommitmessage) => Promise<GenericReturn>;
/**
*Query which paths should be included when committing a Differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.getcommitpaths/}
*
* @param {{revision_id: number}} options
* @returns {Promise<GenericReturn>}
*/
getcommitpaths: (options: {
revision_id: number;
}) => Promise<GenericReturn>;
/**
*Retreive a raw diff.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.getrawdiff/}
*
* @param {{diffID: string}} options
* @returns {Promise<GenericReturn>}
*/
getrawdiff: (options: {
diffID: string;
}) => Promise<GenericReturn>;
/**
*Parse commit messages for Differential fields.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.parsecommitmessage/}
*
* @param {{corpus: string, partial?: boolean}} options
* @returns {Promise<GenericReturn>}
*/
parsecommitmessage: (options: {
corpus: string;
partial?: boolean;
}) => Promise<GenericReturn>;
/**
***Marked for deprecation** Query Differential revisions which match certain criteria.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.query/}
*
* @param {iDifferential.DiffQuery} options
* @returns {Promise<GenericReturn>}
*/
query: (options: iDifferential.DiffQuery) => Promise<GenericReturn>;
/**
***Marked for deprecation** Query differential diffs which match certain criteria.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.querydiffs/}
*
* @param {{ids?: Array<number>, revisionIDs?: Array<number>}} options
* @returns {Promise<GenericReturn>}
*/
querydiffs: (options: {
ids?: Array<number>;
revisionIDs?: Array<number>;
}) => Promise<GenericReturn>;
/**
*Apply transactions to create or update a revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.revision.edit/}
*
* @param {iDifferential.DiffRevisionEdit} options
* @returns {Promise<Transactions>}
*/
revisionEdit: (options: iDifferential.DiffRevisionEdit) => Promise<Transactions>;
/**
*Read information about revisions.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.revision.search/}
*
* @param {iDifferential.DiffRevisionSearch} options
* @returns {Promise<iDifferential.RetDiffRevisionSearch>}
*/
revisionSearch: (options: iDifferential.DiffRevisionSearch) => Promise<iDifferential.RetDiffRevisionSearch>;
/**
*Attach properties to Differential diffs.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.setdiffproperty/}
*
* @param {{
* diff_id: string;
* name: string;
* data: string;
* }} options
* @returns {Promise<GenericReturn>}
*/
setdiffproperty: (options: {
diff_id: string;
name: string;
data: string;
}) => Promise<GenericReturn>;
/**
***Marked for deprecation** Update a differential revision.
[Docs]{@link https://secure.phabricator.com/conduit/method/differential.updaterevision/}
*
* @param {iDifferential.DiffUpdateRevision} options
* @returns {Promise<GenericReturn>}
*/
updaterevision: (options: iDifferential.DiffUpdateRevision) => Promise<GenericReturn>;
};
/**
*Host and Browse Repositories
*
* @memberof Condoit
*/
diffusion: {
/**
*Get blame information for a list of paths.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.blame/}
*
* @param {iDiffusion.DiffusionBlame} options
* @returns {Promise<GenericReturn>}
*/
blame: (options: iDiffusion.DiffusionBlame) => Promise<GenericReturn>;
/**
*Determine what branches exist for a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.branchquery/}
*
* @param {iDiffusion.DiffusionBranchQuery} options
* @returns {Promise<Array<iDiffusion.RetDiffusionBranchquery>>}
*/
branchquery: (options: iDiffusion.DiffusionBranchQuery) => Promise<Array<iDiffusion.RetDiffusionBranchquery>>;
/**
*File(s) information for a repository at an (optional) path and (optional) commit.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.browsequery/}
*
* @param {iDiffusion.DiffusionBrowsequery} options
* @returns {Promise<iDiffusion.RetDiffusionBrowsequery>}
*/
browsequery: (options: iDiffusion.DiffusionBrowsequery) => Promise<iDiffusion.RetDiffusionBrowsequery>;
/**
*Apply transactions to edit an existing commit. This method can not create new commits.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.commit.edit/}
*
* @param {iDiffusion.DiffusionCommitEdit} options
* @returns {Promise<Transactions>}
*/
commitEdit: (options: iDiffusion.DiffusionCommitEdit) => Promise<Transactions>;
/**
*Read information about commits.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.commit.search/}
*
* @param {iDiffusion.DiffusionCommitSearch} options
* @returns {Promise<iDiffusion.RetDiffusionCommitSearch>}
*/
commitSearch: (options: iDiffusion.DiffusionCommitSearch) => Promise<iDiffusion.RetDiffusionCommitSearch>;
/**
*Get the commit identifiers for a commit's parent or parents.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.commitparentsquery/}
*
* @param {iDiffusion.DiffusionCommitparentsquery} options
* @returns {Promise<GenericReturn>}
*/
commitparentsquery: (options: iDiffusion.BranchCommitRepo) => Promise<GenericReturn>;
/**
*Get diff information from a repository for a specific path at an (optional) commit.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.diffquery/}
*
* @param {iDiffusion.DiffusionDiffQuery} options
* @returns {Promise<iDiffusion.RetDiffusionDiffquery>}
*/
diffquery: (options: iDiffusion.DiffusionDiffQuery) => Promise<iDiffusion.RetDiffusionDiffquery>;
/**
*Determine if code exists in a version control system.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.existsquery/}
*
* @param {iDiffusion.DiffusionExistsquery} options
* @returns {Promise<any>}
*/
existsquery: (options: iDiffusion.BranchCommitRepo) => Promise<any>;
/**
*Retreive file content from a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.filecontentquery/}
*
* @param {iDiffusion.DiffusionFilecontentquery} options
* @returns {Promise<iDiffusion.RetDiffusionFilecontentquery>}
*/
filecontentquery: (options: iDiffusion.DiffusionFilecontentquery) => Promise<iDiffusion.RetDiffusionFilecontentquery>;
/**
*Retrieve Diffusion symbol information.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.findsymbols/}
*
* @param {iDiffusion.DiffusionFindsymbols} options
* @returns {Promise<GenericReturn>}
*/
findsymbols: (options: iDiffusion.DiffusionFindsymbols) => Promise<GenericReturn>;
/**
*Returns history information for a repository at a specific commit and path.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.historyquery/}
*
* @param {iDiffusion.DiffusionHistoryquery} options
* @returns {Promise<iDiffusion.RetDiffusionHistoryquery>}
*/
historyquery: (options: iDiffusion.DiffusionHistoryquery) => Promise<iDiffusion.RetDiffusionHistoryquery>;
/**
*Get the commits at which paths were last modified.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.lastmodifiedquery/}
*
* @param {iDiffusion.DiffusionLastmodifiedQuery} options
* @returns {Promise<GenericReturn>}
*/
lastmodifiedquery: (options: iDiffusion.DiffusionLastmodifiedQuery) => Promise<GenericReturn>;
/**
*Merged commit information for a specific commit in a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.mergedcommitsquery/}
*
* @param {iDiffusion.DiffusionMergedcommitsquery} options
* @returns {Promise<GenericReturn>}
*/
mergedcommitsquery: (options: iDiffusion.DiffusionMergedcommitsquery) => Promise<GenericReturn>;
/**
***Marked for deprecation** Retreive information about commits.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.querycommits/}
*
* @param {iDiffusion.DiffusionQuerycommits} options
* @returns {Promise<iDiffusion.RetDiffusionQuerycommits>}
*/
querycommits: (options: iDiffusion.DiffusionQuerycommits) => Promise<iDiffusion.RetDiffusionQuerycommits>;
/**
*Filename search on a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.querypaths/}
*
* @param {iDiffusion.DiffusionQuerypaths} [options]
* @returns {Promise<GenericReturn>}
*/
querypaths: (options?: iDiffusion.DiffusionQuerypaths | undefined) => Promise<GenericReturn>;
/**
*Get raw diff information from a repository for a specific commit at an (optional) path.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.rawdiffquery/}
*
* @param {iDiffusion.DiffusionRawdiffquery} options
* @returns {Promise<GenericReturn>}
*/
rawdiffquery: (options: iDiffusion.DiffusionRawdiffquery) => Promise<GenericReturn>;
/**
*Query a git repository for ref information at a specific commit.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.refsquery/}
*
* @param {iDiffusion.BranchCommitRepo} options
* @returns {Promise<iDiffusion.RetDiffusionRefsquery>}
*/
refsquery: (options: iDiffusion.BranchCommitRepo) => Promise<iDiffusion.RetDiffusionRefsquery>;
/**
*Apply transactions to create a new repository or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.repository.edit/}
*
* @param {iDiffusion.DiffusionRepositoryEdit} options
* @returns {Promise<Transactions>}
*/
repositoryEdit: (options: iDiffusion.DiffusionRepositoryEdit) => Promise<Transactions>;
/**
*Read information about repositories.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.repository.search/}
*
* @param {iDiffusion.DiffusionRepositorySearch} options
* @returns {Promise<iDiffusion.RetDiffusionRepositorySearch>}
*/
repositorySearch: (options: iDiffusion.DiffusionRepositorySearch) => Promise<iDiffusion.RetDiffusionRepositorySearch>;
/**
*Resolve references into stable, canonical identifiers.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.resolverefs/}
*
* @param {iDiffusion.DiffusionResolverefs} options
* @returns {Promise<GenericReturn>}
*/
resolverefs: (options: iDiffusion.DiffusionResolverefs) => Promise<GenericReturn>;
/**
*Search (grep) a repository at a specific path and commit.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.searchquery/}
*
* @param {iDiffusion.DiffusionSearchquery} options
* @returns {Promise<GenericReturn>}
*/
searchquery: (options: iDiffusion.DiffusionSearchquery) => Promise<GenericReturn>;
/**
*Retrieve information about tags in a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.tagsquery/}
*
* @param {iDiffusion.DiffusionTagsquery} options
* @returns {Promise<GenericReturn>}
*/
tagsquery: (options: iDiffusion.DiffusionTagsquery) => Promise<GenericReturn>;
/**
*Apply transactions to create a new repository URI or edit an existing one.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.uri.edit/}
*
* @param {iDiffusion.DiffusionUriedit} options
* @returns {Promise<Transactions>}
*/
uriEdit: (options: iDiffusion.DiffusionUriedit) => Promise<Transactions>;
/**
*Get lint messages for existing code.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.getlintmessages/}
*
* @param {iDiffusion.DiffusionGetlinemessages} options
* @returns {Promise<GenericReturn>}
*/
getlintmessages: (options: iDiffusion.DiffusionGetlinemessages) => Promise<GenericReturn>;
/**
*Advises Phabricator to look for new commits in a repository as soon
as possible. This advice is most useful if you have just pushed
new commits to that repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.looksoon/}
*
* @param {{repositories?: Array<string>, urgency?: string}} options
* @returns {Promise<GenericReturn>}
*/
looksoon: (options: {
repositories?: Array<string>;
urgency?: string;
}) => Promise<GenericReturn>;
/**
*Publish coverage information for a repository.
[Docs]{@link https://secure.phabricator.com/conduit/method/diffusion.updatecoverage/}
*
* @param {iDiffusion.DiffusionUpdatecoverage} options
* @returns {Promise<GenericReturn>}
*/
updatecoverage: (options: iDiffusion.DiffusionUpdatecoverage) => Promise<GenericReturn>;
};
/**
*Allocate software resources.
*
* @memberof Condoit
*/
drydock: {
/**
*Retrieve information about Drydock authorizations.
[Docs]{@link https://secure.phabricator.com/conduit/method/drydock.authorization.search/}
*
* @param {iDrydock.DrydockAlmanacSearch} options
* @returns {Promise<iDrydock.RetHarbormasterArtifactSearch>}
*/
authorizationSearch: (options: iDrydock.DrydockAlmanacSearch) => Promise<iDrydock.RetDDAlmanacSearch>;
/**
*Apply transactions to create or edit a blueprint.
[Docs]{@link https://secure.phabricator.com/conduit/method/drydock.blueprint.edit/}
*
* @param {iDrydock.DrydockBlueprintEdit} options
* @returns {Promise<Transactions>}
*/
blueprintEdit: (options: iDrydock.DrydockBlueprintEdit) => Promise<Transactions>;
/**
*Retrieve information about Drydock blueprints.
[Docs]{@link https://secure.phabricator.com/conduit/method/drydock.blueprint.search/}
*
* @param {iDrydock.DrydockBlueprintSearch} options
* @returns {Promise<iDrydock.RetDDBlueprintSearch>}
*/
blueprintSearch: (options: iDrydock.DrydockBlueprintSearch) => Promise<iDrydock.RetDDBlueprintSearch>;
/**
*Retrieve information about Drydock leases.
[Docs]{@link https://secure.phabricator.com/conduit/method/drydock.lease.search/}
*
* @param {iDrydock.DrydockLeaseSearch} options
* @returns {Promise<iDrydock.RetDDLeaseSearch>}
*/
leaseSearch: (options: iDrydock.DrydockLeaseSearch) => Promise<iDrydock.RetDDLeaseSearch>;
/**
*Retrieve information about Drydock resources.
[Docs]{@link https://secure.phabricator.com/conduit/method/drydock.resource.search/}
*
* @param {iDrydock.DrydockResourceSearch} options
* @returns {Promise<iDrydock.RetDDResourceSearch>}
*/
resourceSearch: (options: iDrydock.DrydockResourceSearch) => Promise<iDrydock.RetDDResourceSearch>;
};
/**
*Edge relationships between objects.
*
* @memberof Condoit
*/
edge: {
/**
*Read edge relationships between objects.
[Docs]{@link https://secure.phabricator.com/conduit/method/edge.search/}
*
* @param {iEdge.EdgeSearch} options
* @returns {Promise<iEdge.RetEdgeSearch>}
*/
search: (options: iEdge.EdgeSearch) => Promise<iEdge.RetEdgeSearch>;
};
/**
*Review recent activity.
*
* @memberof Condoit
*/
feed: {
/**
*Publish a story to the feed.
[Docs]{@link https://secure.phabricator.com/conduit/method/feed.publish/}
*
* @param {{
* type: string;
* data: object;
* time?: number;
* }} options
* @returns {Promise<GenericReturn>}
*/
publish: (options: {
type: string;
data: object;
time?: number;
}) => Promise<GenericReturn>;
/**
*Query the feed for stories.
[Docs]{@link https://secure.phabricator.com/conduit/method/feed.query/}
*
* @param {iFeed.FeedQuery} [options]
* @returns {Promise<iFeed.RetFeedQuery>}
*/
query: (options: iFeed.FeedQuery) => Promise<iFeed.RetFeedQuery>;
};
/**
*Store and Share files.
*
* @memberof Condoit
*/
file: {
/**
*Allocate space to upload a file.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.allocate/}
*
* @param {iFile.FileAllocate} options
* @returns {Promise<iFile.RetFileAllocate>}
*/
allocate: (options: iFile.FileAllocate) => Promise<iFile.RetFileAllocate>;
/**
*Down a stored file.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.download/}
*
* @param {{phid: string}} options
* @returns {Promise<string>} Base64 encoded file as string.
*/
download: (options: {
phid: string;
path: string;
encoding: string;
}) => Promise<string | object>;
/**
***Marked for deprecation** Get information about a file.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.info/}
*
* @param {{ id?: number; phid?: string }} options
* @returns {Promise<GenericReturn>}
*/
info: (options: {
id?: number;
phid?: string;
}) => Promise<iFile.RetFileInfo>;
/**
*Get information about file chunks.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.querychunks/}
*
* @param {{
* filePHID: string;
* }} options
* @returns {Promise<iFile.RetFileQuerychunks>}
*/
querychunks: (options: {
filePHID: string;
}) => Promise<iFile.RetFileQuerychunks>;
/**
*Search for files.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.search/}
*
* @param {iFile.FileSearch} options
* @returns {Promise<iFile.RetFileSearch>}
*/
search: (options: iFile.FileSearch) => Promise<iFile.RetFileSearch>;
/**
*Upload a file. The Phabricator API makes the name optional, but this
method requires it.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.upload/}
*
* @param {iFile.FileUpload} options
* @returns {Promise<iFile.RetFileUpload>}
*/
upload: (options: iFile.FileUpload) => Promise<iFile.RetFileUpload>;
/**
*Upload a chunk of file data to the server.
[Docs]{@link https://secure.phabricator.com/conduit/method/file.uploadchunk/}
*
* @param {iFile.FileUploadchunk} options
* @returns {Promise<GenericReturn>}
*/
uploadchunk: (options: iFile.FileUploadchunk) => Promise<null>;
};
/**
*Personal bookmarks.
*
* @memberof Condoit
*/
flag: {
/**
*Clear or delete a flag or bookmark
[Docs]{@link https://secure.phabricator.com/conduit/method/flag.delete/}
*
* @param {{
* id: number;
* objectPHID: string;
* }} options
* @returns {Promise<iFlag.RetFlagDelete>}
*/
delete: (options: {
id: number;
objectPHID: string;
}) => Promise<iFlag.RetFlagDelete>;
/**
*Create or modify a flag
[Docs]{@link https://secure.phabricator.com/conduit/method/flag.edit/}
*
* @param {{
* objectPHID: string;
* color: number;
* note: string;
* }} options
* @returns {Promise<iFlag.RetFlagEdit>}
*/
edit: (options: {
objectPHID: string;
color: number;
note: string;
}) => Promise<iFlag.RetFlagEdit>;
/**
*Query flag markers. Flags can also be considered as bookmarks.
[Docs]{@link https://secure.phabricator.com/conduit/method/flag.query/}
*
* @param {iFlag.FlagQuery} options
* @returns {Promise<iFlag.RetFlagQuery>}
*/
query: (options: iFlag.FlagQuery) => Promise<iFlag.RetFlagQuery>;
};
/**
*Harbormaster is the application used to track and manage CI/CD within Phabricator
*
* @memberof Condoit
*/
harbormaster: {
/**
*Query Harbormaster for build artifacts.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.artifact.search/}
*
* @param {iHarbormaster.HarbormasterArtifactSearch} [options]
* @returns {Promise<iHarbormaster.RetHarbormasterArtifactSearch>}
*/
artifactSearch: (options: iHarbormaster.HarbormasterArtifactSearch) => Promise<iHarbormaster.RetHarbormasterArtifactSearch>;
/**
*Search Harbormaster build information.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.build.search/}
*
* @param {iHarbormaster.HarbormasterBuildSearch} [options]
* @returns {Promise<iHarbormaster.RetHarbormasterBuildSearch>}
*/
buildSearch: (options: iHarbormaster.HarbormasterBuildSearch) => Promise<iHarbormaster.RetHarbormasterBuildSearch>;
/**
*Endpoint for buildable artifacts and their statuses.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.buildable.search/}
*
* @param {iHarbormaster.HarbormasterBuildplanSearch} options
* @returns {Promise<iHarbormaster.RetHarbormasterBuildplanSearch>}
*/
buildableSearch: (options: iHarbormaster.HarbormasterBuildplanSearch) => Promise<iHarbormaster.RetHarbormasterBuildplanSearch>;
/**
*Edit a Harbormaster buildplan.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.buildplan.edit/}
*
* @param {iHarbormaster.HarbormasterBuildplanEdit} options
* @returns {Promise<Transactions>}
*/
buildplanEdit: (options: iHarbormaster.HarbormasterBuildplanEdit) => Promise<Transactions>;
/**
*Query build plans in Harbormaster.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.buildplan.search/}
*
* @param {iHarbormaster.HarbormasterBuildableSearch} [options]
* @returns {Promise<iHarbormaster.RetHarbormasterBuildableSearch>}
*/
buildplanSearch: (options: iHarbormaster.HarbormasterBuildplanSearch) => Promise<iHarbormaster.RetHarbormasterBuildplanSearch>;
/**
*Search logs for builds.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.log.search/}
*
* @param {iHarbormaster.HarbormasterLogSearch} options
* @returns {Promise<iHarbormaster.RetHarbormasterLogSearch>}
*/
logSearch: (options: iHarbormaster.HarbormasterLogSearch) => Promise<iHarbormaster.RetHarbormasterLogSearch>;
/**
*Search build targets.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.target.search/}
*
* @param {iHarbormaster.HarbormasterTargetSearch} options
* @returns {Promise<iHarbormaster.RetHarbormasterTargetSearch>}
*/
targetSearch: (options: iHarbormaster.HarbormasterTargetSearch) => Promise<iHarbormaster.RetHarbormasterTargetSearch>;
/**
*Create a harbormaster build artifact.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.createartifact/}
*
* @param {iHarbormaster.HarbormasterCreateartifact} options
* @returns {Promise<GenericReturn>}
*/
createArtifact: (options: iHarbormaster.HarbormasterCreateartifact) => Promise<GenericReturn>;
/**
*Load or create build autotargets.
* [Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.queryautotargets/}
*
* @param {{
* objectPHID: string;
* targetKeys: Array<string>;
* }} options
* @returns {Promise<GenericReturn>}
*/
queryAutotargets: (options: {
objectPHID: string;
targetKeys: Array<string>;
}) => Promise<GenericReturn>;
/**
* Query Harbormaster buildables.
* [Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.querybuildables/}
*
* @param {iHarbormaster.HarbormasterQuerybuildables} [options]
* @returns {Promise<GenericReturn>}
*/
querybuildables: (options: iHarbormaster.HarbormasterQuerybuildables) => Promise<GenericReturn>;
/**
*Send a message about the status of a build target to Harbormaster,
notifying the application of build results in an external system.
[Docs]{@link https://secure.phabricator.com/conduit/method/harbormaster.sendmessage/}
*
* @param {iHarbormaster.HarbormasterSendmessage} options
* @returns {Promise<GenericReturn>}
*/
sendmessage: (options: iHarbormaster.HarbormasterSendmessage) => Promise<GenericReturn>;
};
/**
*The Macro application is used for image hosting.
*
* @memberof Condoit
*/
macro: {
/**
*Edit or add a new image to Macro application.
[Docs]{@link https://secure.phabricator.com/conduit/method/macro.edit/}
*
* @param {iMacro.MarcoEdit} options
* @returns {Promise<Transactions>}
*/
edit: (options: iMacro.MarcoEdit) => Promise<Transactions>;
/**
*Query Macro application for images.
[Docs]{@link https://secure.phabricator.com/conduit/method/macro.query/}
*
* @param {iMacro.MacroQuery} [options]
* @returns {Promise<iMacro.RetMacroQuery>}
*/
query: (options: iMacro.MacroQuery) => Promise<iMacro.RetMacroQuery>;
/**
*Create a meme from an existing image.
[Docs]{@link https://secure.phabricator.com/conduit/method/phriction.creatememe/}
*
* @param {{
* macroName: string;
* upperText?: string;
* lowerText?: string;
* }} options
* @returns {Promise<iMacro.RetMacroCreatememe>}
*/
creatememe: (options: {
macroName: string;
upperText?: string;
lowerText?: string;
}) => Promise<iMacro.RetMacroCreatememe>;
};
/**
*API endpoints for Maniphest which is Phabricators task management
system.
*
* @memberof Condoit
*/
maniphest: {
/**
***Marked for deprecation.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.createtask/}
*
* @param {iManiphest.ManiphestCreatetask} options
* @returns {Promise<iManiphest.RetManiphestCreatetask>}
*/
createtask: (options: iManiphest.ManiphestCreatetask) => Promise<iManiphest.RetManiphestCreatetask>;
/**
*Edit a maniphest task.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.edit/}
*
* @param {iManiphest.ManiphestEdit} options
* @returns {Promise<Transactions>}
*/
edit: (options: iManiphest.ManiphestEdit) => Promise<Transactions>;
/**
***Marked for deprecation** Retrieve Maniphest task transactions.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.gettasktransactions/}
*
* @param {Array<number>} ids
* @returns {Promise<iManiphest.RetManiphestGettasktransactions>}
*/
gettasktransactions: (options: {
ids: Array<number>;
}) => Promise<iManiphest.RetManiphestGettasktransactions>;
/**
***Marked for deprecation** Retrieve information about a Maniphest task, given its ID.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.info}
*
* @param {number} taskId
* @returns {Promise<iManiphest.RetManiphestInfo>}
*/
info: (options: {
taskId: number;
}) => Promise<iManiphest.RetManiphestInfo>;
/**
*Returns information about the possible priorities for Maniphest tasks.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.priority.search/}
*
* @returns {Promise<iManiphest.RetManiphestPrioritySearch>}
*/
prioritySearch: () => Promise<iManiphest.RetManiphestPrioritySearch>;
/**
***Marked for deprecation** Execute complex searches for Maniphest tasks.
[Docs]{@link https://secure.phabricator.com/conduit/method/user.whoami/}
*
* @param {iManiphest.ManiphestQuery} options
* @returns {Promise<iManiphest.RetManiphestQuery>}
*/
query: (options: iManiphest.ManiphestQuery) => Promise<iManiphest.RetManiphestQuery>;
/**
***Marked for deprecation** Retrieve information about possible Maniphest task status values.
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.querystatuses/}
*
* @returns {Promise<iManiphest.RetManiphestQuerystatuses>}
*/
querystatuses: () => Promise<iManiphest.RetManiphestQuerystatuses>;
/**
**Search Maniphest tasks
[Docs]{@link https://secure.phabricator.com/conduit/method/maniphest.search/}
*
* @param {iManiphest.ManiphestSearch} options
* @returns {Promise<iManiphest.RetManiphestSearch>}
*/
search: (options: iManiphest.ManiphestSearch) => Promise<iManiphest.RetManiphestSearch>;
/**
*Returns information about the