condoit
Version:
[](https://securisec.github.io/condoit/) 
623 lines (621 loc) • 17.9 kB
TypeScript
import { faIcons } from './extras/icons';
import { lang } from './extras/paste-lang';
declare type phid = string;
export declare const transactions: {
/**
* Badge edit transactions
*/
badge: {
/**
*Badge name
*
* @param {string} value
* @returns {object}
*/
name: (value: string) => object;
/**
*Short description of the badge.
*
* @param {string} value
* @returns {object}
*/
flavor: (value: string) => object;
/**
*Change the badge icon.
*
* @param {faIcons} value
* @returns {object}
*/
icon: (value: faIcons) => object;
/**
*Color and rarity of the badge.
*
* @param {('poor'|'common'|'uncommon'|'rare'|'epic'|'legendary'|'heirloom')} value
* @returns {object}
*/
quality: (value: 'poor' | 'common' | 'uncommon' | 'rare' | 'epic' | 'legendary' | 'heirloom') => object;
/**
*Badge long description
*
* @param {string} value
* @returns {object}
*/
description: (value: string) => object;
/**
*New badge award recipients.
*
* @param {Array<string>} value
* @returns {object}
*/
award: (value: Array<phid>) => object;
/**
*Revoke badge award recipients.
*
* @param {Array<phid>} value
* @returns {object}
*/
revoke: (value: Array<phid>) => object;
/**
*Change the edit policy of the object.
*
* @param {phid} value
* @returns {object}
*/
edit: (value: phid) => object;
subscribers: {
/**
*Add subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set subscribers, overwriting current value
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
comment: (value: string) => object;
mfa: (value: string) => object;
};
/**
* Conpherence edit transactions
*/
conpherence: {
/**
*Room name
*
* @param {string} value
* @returns {object}
*/
name: (value: string) => object;
/**
*Room topic
*
* @param {string} value
* @returns {object}
*/
topic: (value: string) => object;
participants: {
/**
*Add room participants.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove room participants.
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set room participants.
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
view: (value: string) => object;
edit: (value: string) => object;
comment: (value: string) => object;
mfa: (value: string) => object;
};
/**
* Maniphest edit transactions
*/
maniphest: {
/**
*Use this to set transactions with custom fields. The type
argument is the transaction type name, the value is value.
An example transaction type name is `custom.myfield`
*
* @param {string} type
* @param {*} value
* @returns
*/
custom: (type: string, value: any) => {
type: string;
value: any;
};
/**
*Create as a subtask of another task
*
* @param {phid} value
* @returns {object}
*/
parent: (value: phid) => object;
/**
*Move a task to one or more workboard columns.
You can use this transaction type to create a task into
a particular workboard column, or move an existing
task between columns.
*
* @param {Array<phid>} value
* @returns {object}
*/
column: (value: Array<phid>) => object;
/**
*Shift the object between spaces.
*
* @param {phid} value
* @returns {object}
*/
space: (value: phid) => object;
title: (value: string) => object;
/**
*Reassign the task
*
* @param {phid} value
* @returns {object}
*/
owner: (value: phid) => object;
/**
*Change the task status
*
* @param {('open'|'resolved'|'wontfix'|'invalid'|'duplicate'|'spite')} value
* @returns {object}
*/
status: (value: 'open' | 'resolved' | 'wontfix' | 'invalid' | 'duplicate' | 'spite' | string) => object;
/**
*Change the priority of the task
*
* @param {('unbreak'|'triage'|'high'|'normal'|'low'|'wishlist')} value
* @returns {object}
*/
priority: (value: 'unbreak' | 'triage' | 'high' | 'normal' | 'low' | 'wishlist') => object;
/**
*Update the task description
*
* @param {string} value
* @returns {object}
*/
description: (value: string) => object;
parents: {
/**
*Change the parents of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove the parents of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set the parents of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
subtasks: {
/**
*Change the subtasks of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove the subtasks of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set the subtasks of this task
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
commits: {
/**
*Change the related commits for this task
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove the related commits for this task
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set the related commits for this task
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
view: (value: string) => object;
edit: (value: string) => object;
projects: {
/**
*Add project tags.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
subscribers: {
/**
*Add subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set subscribers, overwriting current value
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
/**
*Change the object subtype
*
* @param {('default'|'bug'|'feature')} value
* @returns {object}
*/
subtype: (value: 'default' | 'bug' | 'feature' | string) => object;
comment: (value: string) => object;
mfa: (value: string) => object;
};
/**
* Paste edit transactions
*/
paste: {
/**
*Shift the object between spaces
*
* @param {string} value
* @returns {object}
*/
space: (value: string) => object;
title: (value: string) => object;
/**
*Change language for syntax highlighting
*
* @param {lang} value
* @returns {object}
*/
language: (value: lang) => object;
/**
*The paste content
*
* @param {string} value
* @returns {object}
*/
text: (value: string) => object;
/**
*Active or archive the paste
*
* @param {('active'|'archived')} value
* @returns {object}
*/
status: (value: 'active' | 'archived') => object;
view: (value: string) => object;
edit: (value: string) => object;
projects: {
/**
*Add project tags.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
subscribers: {
/**
*Add subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove subscribers.
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set subscribers, overwriting current value
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
comment: (value: string) => object;
mfa: (value: string) => object;
};
/**
* Portal edit transactions
*/
portal: {
/**
*Rename the portal
*
* @param {string} value
* @returns {object}
*/
name: (value: string) => object;
view: (value: string) => object;
edit: (value: string) => object;
projects: {
/**
*Add project tags.
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set project tags
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
mfa: (value: string) => object;
};
/**
* Project edit transactions
*/
project: {
/**
*Choose a parent project to create a subproject beneath.
*
* @param {phid} value
* @returns {object}
*/
parent: (value: phid) => object;
/**
*Choose a parent project to create a new milestone for.
*
* @param {phid} value
* @returns {object}
*/
milestone: (value: phid) => object;
/**
*Shift the object between spaces
*
* @param {phid} value
* @returns {object}
*/
space: (value: phid) => object;
/**
*New project name or rename
*
* @param {string} value
* @returns {object}
*/
name: (value: string) => object;
/**
*Short project description
*
* @param {string} value
* @returns {object}
*/
description: (value: string) => object;
/**
*Change the project icon
*
* @param {('project'|
* 'tag'|
* 'policy'|
* 'group'|
* 'folder'|
* 'timeline'|
* 'goal'|
* 'release'|
* 'bugs'|
* 'cleanup'|
* 'umbrella'|
* 'communication'|
* 'organization'|
* 'infrastructure'|
* 'account'|
* 'experimental')} value
* @returns {object}
*/
icon: (value: 'project' | 'tag' | 'policy' | 'group' | 'folder' | 'timeline' | 'goal' | 'release' | 'bugs' | 'cleanup' | 'umbrella' | 'communication' | 'organization' | 'infrastructure' | 'account' | 'experimental') => object;
/**
*Change the project tag color
*
* @param {colors} value
* @returns {object}
*/
color: (value: 'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'indigo' | 'violet' | 'pink' | 'grey' | 'checkered') => object;
/**
*Change project slugs
*
* @param {Array<string>} value
* @returns {object}
*/
slugs: (value: Array<string>) => object;
members: {
/**
*Add project members
*
* @param {Array<phid>} value
* @returns {object}
*/
add: (value: Array<phid>) => object;
/**
*Remove project members
*
* @param {Array<phid>} value
* @returns {object}
*/
remove: (value: Array<phid>) => object;
/**
*Set project members
*
* @param {Array<phid>} value
* @returns {object}
*/
set: (value: Array<phid>) => object;
};
view: (value: string) => object;
edit: (value: string) => object;
/**
*Change the join policy of the object.
*
* @param {string} value
* @returns {object}
*/
join: (value: string) => object;
subtype: (value: 'default' | string) => object;
mfa: (value: string) => object;
};
/**
* User edit transactions
*/
user: {
/**
*Disable or enable the user
*
* @param {boolean} value true to disable
* @returns {object}
*/
disabled: (value: boolean) => object;
/**
*Approve or reject the user
*
* @param {boolean} value true to approve the user
* @returns {object}
*/
approved: (value: boolean) => object;
/**
*Stores the real name of the user, like "Abraham Lincoln".
*
* @param {string} value
* @returns {object}
*/
realName: (value: string) => object;
/**
*User title, like "CEO" or "Assistant to the Manager".
*
* @param {string} value
* @returns {object}
*/
title: (value: string) => object;
/**
*User icon to accompany their title.
*
* @param {string} value
* @returns {object}
*/
icon: (value: 'person' | 'engineering' | 'operations' | 'resources' | 'camera' | 'music' | 'spy' | 'android' | 'relationships' | 'administration' | 'security' | 'logistics' | 'research' | 'analysis' | 'executive' | 'animal') => object;
/**
*Short blurb about the user
*
* @param {string} value
* @returns {object}
*/
blurb: (value: string) => object;
/**
*Sign the transaction group with MFA
*
* @param {boolean} value
* @returns {object}
*/
mfa: (value: boolean) => object;
};
};
export {};