datadirect
Version:
Types for working with Blackbaud's front-end APIs
85 lines (84 loc) • 2.01 kB
TypeScript
import { NumericString } from '@battis/descriptive-types';
type DropDownItem = {
Value: number;
Display: string;
};
type DropDownList = {
DropDownList: DropDownItem[];
};
type Column = {
DatabaseColumn?: string;
PropertyName?: string;
DataType?: number;
Selected: boolean;
Required?: boolean;
CanDisplay?: boolean;
ColumnOrder?: number;
Width?: number;
CategoryId?: number;
IsSearchDisabled?: boolean;
SeeMoreText?: boolean;
Checksum?: string;
DisplayName?: string;
Description?: string;
SortOrder?: number;
OrderColumnAdded?: number;
SortColumn?: string;
AdditionalDatabaseColumns?: string[];
DisplayFormat?: number;
DisplayLink?: boolean;
AdditionalDatabaseColumn?: string;
DropDown?: DropDownList;
};
type Action = {
DisplayName: string;
Css: string;
ContextProperty: string;
VisibilityColumn: string;
};
type FilterValue = {
Description: string;
Key: number;
Selected: boolean;
};
type Filter = {
Column?: Column;
Values: FilterValue[];
Category: string;
FilterType: number;
UserDefinedId: number;
Selected: boolean;
SelectedOption?: number | NumericString;
HasChildFilters: boolean;
SelectedValues: any[];
FilterClass: string;
ServiceFilterClass: string;
FilterLabel?: string;
UseViewerId: boolean;
FilterAlwaysSelected: boolean;
FilterOn?: string;
DoNotClear?: boolean;
Hidden?: boolean;
};
export type Payload = {
UseReadOnlyDb: boolean;
UseLiveDBOverride: boolean;
IsSmallCollege: boolean;
IsOneRoster: boolean;
Columns: Column[];
Actions: Action[];
SortColumn: string;
SortDesc: boolean;
PageSize: number;
CurrentPage: number;
TotalCount: number;
PageOnClient: boolean;
Filters: Filter[];
Categories: any[];
AlwaysSearchServer: boolean;
Name: string;
Id: number;
ListType: number;
ShowFilterLandingPage?: boolean;
};
export {};