condoit/src/interfaces/iAlmanac.ts

[](https://securisec.github.io/condoit/) 

import {
	BeforeAfterLimit,
	RetSearchConstants,
	ErrorCodes,
	phid
} from './iGlobal';

export interface AlmanacBindingSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		servicePHIDs?: phid;
		devicePHIDs?: Array<phid>;
	};
	attachments?: {
		properties: boolean;
	};
	order?: 'newest' | 'oldest';
}

export interface retAlmanacBindingSearchData extends RetSearchConstants {
	fields: {
		servicePHID: phid;
		devicePHID: phid;
		interfacePHID: phid;
		disabled: boolean;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
	attachments: object;
}

export interface RetAlmanacBindingSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacBindingSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface AlmanacDeviceSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		match?: string;
		names?: Array<string>;
		isClusterDevice: boolean;
		devicePHIDs?: Array<phid>;
	};
	attachments?: {
		properties: boolean;
		projects: boolean;
	};
	order?: 'name' | 'newest' | 'oldest';
}

export interface retAlmanacDeviceSearchData extends RetSearchConstants {
	fields: {
		name: string;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
	attachments: {
		properties: { properties: Array<string> };
		projects: {
			projects: Array<{ key: string; value: string; builtin: boolean }>;
		};
	};
}

export interface RetAlmanacDeviceSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacDeviceSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface AlmanacInterfaceSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		devicePHIDs?: Array<phid>;
	};
	order?: 'name' | 'newest' | 'oldest';
}

export interface retAlmanacInterfaceSearchData extends RetSearchConstants {
	fields: {
		name: string;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
}

export interface RetAlmanacInterfaceSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacInterfaceSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface AlmanacNamespaceSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		match?: string;
		projects?: Array<string>;
	};
	attachments: { projects: boolean };
	order?: 'newest' | 'oldest';
}

export interface retAlmanacNamespaceSearchData extends RetSearchConstants {
	fields: {
		name: string;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
}

export interface RetAlmanacNamespaceSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacNamespaceSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface AlmanacNetworkSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		match?: string;
	};
	order?: 'newest' | 'oldest';
}

export interface retAlmanacNetworkSearchData extends RetSearchConstants {
	fields: {
		name: string;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
}

export interface RetAlmanacNetworkSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacNetworkSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface AlmanacServiceSearch extends BeforeAfterLimit {
	queryKey?: 'all';
	constraints?: {
		ids?: Array<number>;
		phids?: Array<phid>;
		match?: string;
		names?: Array<string>;
		serviceTypes?: Array<string>;
		devicePHIDs?: Array<phid>;
		projects?: Array<string>;
	};
	attachments: { projects: boolean; properties: boolean; bindings: boolean };
	order?: 'name' | 'newest' | 'oldest';
}

export interface retAlmanacServiceSearchData extends RetSearchConstants {
	fields: {
		name: string;
		serviceType: string;
		dateCreated: number;
		dateModified: number;
		policy: { view: string; edit: string };
	};
	attachments: {
		properties: {
			properties: Array<{ key: string; value: string; builtin: boolean }>;
		};
		projects: { projectPHIDs: Array<phid> };
		bindings: { bindings: Array<any> };
	};
}

export interface RetAlmanacServiceSearch extends ErrorCodes {
	result: {
		data: Array<retAlmanacServiceSearchData>;
		maps: object;
		query: { queryKey: string };
		cursor: {
			limit: number;
			after: string;
			before: any;
			order: any;
		};
	};
}

export interface almanacBindingEdit {
	type:
		| 'service'
		| 'interface'
		| 'disabled'
		| 'property.set'
		| 'property.delete'
		| 'mfa';
	value: any;
}

export interface AlmanacBindingEdit {
	transactions: Array<almanacBindingEdit>;
	objectIdentifier?: number | string;
}

export interface almanacDeviceEdit {
	type:
		| 'name'
		| 'view'
		| 'edit'
		| 'projects.add'
		| 'projects.remove'
		| 'projects.set'
		| 'property.set'
		| 'property.delete'
		| 'mfa';
	value: any;
}

export interface AlmanacDeviceEdit {
	transactions: Array<almanacDeviceEdit>;
	objectIdentifier?: number | string;
}

export interface almanacInterfaceEdit {
	type: 'device' | 'network' | 'address' | 'port' | 'mfa';
	value: any;
}

export interface AlmanacInterfaceEdit {
	transactions: Array<almanacInterfaceEdit>;
	objectIdentifier?: number | string;
}

export interface almanacNetworkEdit {
	type: 'view' | 'edit' | 'mfa';
	value: any;
}

export interface AlmanacNetworkEdit {
	transactions: Array<almanacNetworkEdit>;
	objectIdentifier?: number | string;
}

export interface almanacServiceEdit {
	type:
		| 'name'
		| 'type'
		| 'view'
		| 'edit'
		| 'projects.add'
		| 'projects.remove'
		| 'projects.set'
		| 'property.set'
		| 'property.delete'
		| 'mfa';
	value: any;
}

export interface AlmanacServiceEdit {
	transactions: Array<almanacServiceEdit>;
	objectIdentifier?: number | string;
}