@ynput/ayon-frontend-shared 0.2.19 → 0.2.21

package/dist/types/api/generated/views.d.ts

@@ -0,0 +1,230 @@
+declare const injectedRtkApi: import('@reduxjs/toolkit/query').Api<import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, {
+    listViews: import('@reduxjs/toolkit/query').QueryDefinition<ListViewsApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, ViewListModel, "restApi", unknown>;
+    createView: import('@reduxjs/toolkit/query').MutationDefinition<CreateViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, EntityIdResponse, "restApi", unknown>;
+    getWorkingView: import('@reduxjs/toolkit/query').QueryDefinition<GetWorkingViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, GetWorkingViewApiResponse, "restApi", unknown>;
+    getDefaultView: import('@reduxjs/toolkit/query').QueryDefinition<GetDefaultViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, GetDefaultViewApiResponse, "restApi", unknown>;
+    setDefaultView: import('@reduxjs/toolkit/query').MutationDefinition<SetDefaultViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, any, "restApi", unknown>;
+    getView: import('@reduxjs/toolkit/query').QueryDefinition<GetViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, GetViewApiResponse, "restApi", unknown>;
+    deleteView: import('@reduxjs/toolkit/query').MutationDefinition<DeleteViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, any, "restApi", unknown>;
+    updateView: import('@reduxjs/toolkit/query').MutationDefinition<UpdateViewApiArg, import('@reduxjs/toolkit/query').BaseQueryFn<string | import('@reduxjs/toolkit/query').FetchArgs, unknown, import('@reduxjs/toolkit/query').FetchBaseQueryError>, string, any, "restApi", unknown>;
+}, "restApi", string, typeof import('@reduxjs/toolkit/query').coreModuleName | typeof import('@reduxjs/toolkit/dist/query/react').reactHooksModuleName>;
+export { injectedRtkApi as api };
+export type ListViewsApiResponse = ViewListModel;
+export type ListViewsApiArg = {
+    viewType: string;
+    projectName?: string;
+};
+export type CreateViewApiResponse = EntityIdResponse;
+export type CreateViewApiArg = {
+    viewType: string;
+    projectName?: string;
+    payload: OverviewViewPostModel | TaskProgressViewPostModel | ListsViewPostModel;
+};
+export type GetWorkingViewApiResponse = OverviewViewModel | TaskProgressViewModel | ListsViewModel;
+export type GetWorkingViewApiArg = {
+    viewType: string;
+    projectName?: string;
+};
+export type GetDefaultViewApiResponse = OverviewViewModel | TaskProgressViewModel | ListsViewModel;
+export type GetDefaultViewApiArg = {
+    viewType: string;
+    projectName?: string;
+};
+export type SetDefaultViewApiResponse = any;
+export type SetDefaultViewApiArg = {
+    viewType: string;
+    projectName?: string;
+    setDefaultViewRequestModel: SetDefaultViewRequestModel;
+};
+export type GetViewApiResponse = OverviewViewModel | TaskProgressViewModel | ListsViewModel;
+export type GetViewApiArg = {
+    viewType: string;
+    viewId: string;
+    projectName?: string;
+};
+export type DeleteViewApiResponse = any;
+export type DeleteViewApiArg = {
+    viewType: string;
+    viewId: string;
+    projectName?: string;
+};
+export type UpdateViewApiResponse = any;
+export type UpdateViewApiArg = {
+    viewType: string;
+    viewId: string;
+    projectName?: string;
+    payload: OverviewViewPatchModel | TaskProgressViewPatchModel | ListsViewPatchModel;
+};
+export type ViewListItemModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Determines whether the view is only available for the given project or for all projects (studio). */
+    scope: 'project' | 'studio';
+    /** Name of the user who created the view. Owners have full control over the view,  */
+    owner: string;
+    /** Visibility of the view. Public views are visible to all users, private views are only visible to the owner. */
+    visibility: 'public' | 'private';
+    access: object;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working: boolean;
+    position: number;
+    editable: boolean;
+};
+export type ViewListModel = {
+    views: ViewListItemModel[];
+};
+export type ValidationError = {
+    loc: (string | number)[];
+    msg: string;
+    type: string;
+};
+export type HttpValidationError = {
+    detail?: ValidationError[];
+};
+export type EntityIdResponse = {
+    /** Entity ID */
+    id: string;
+};
+export type QueryCondition = {
+    /** Path to the key separated by slashes */
+    key: string;
+    /** Value to compare against */
+    value?: string | number | number | boolean | string[] | number[] | number[];
+    /** Comparison operator */
+    operator?: 'eq' | 'like' | 'lt' | 'gt' | 'lte' | 'gte' | 'ne' | 'isnull' | 'notnull' | 'in' | 'notin' | 'includes' | 'excludes' | 'includesall' | 'excludesall' | 'includesany' | 'excludesany';
+};
+export type QueryFilter = {
+    /** List of conditions to be evaluated */
+    conditions?: (QueryCondition | QueryFilter)[];
+    /** Operator to use when joining conditions */
+    operator?: 'and' | 'or';
+};
+export type ColumnItemModel = {
+    name: string;
+    visible?: boolean;
+    pinned?: boolean;
+    width?: number;
+};
+export type OverviewSettings = {
+    showHierarchy?: boolean;
+    groupBy?: string;
+    showEmptyGroups?: boolean;
+    sortBy?: string;
+    sortDesc?: boolean;
+    filter?: QueryFilter;
+    columns?: ColumnItemModel[];
+};
+export type OverviewViewPostModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working?: boolean;
+    settings: OverviewSettings;
+};
+export type TaskProgressSettings = {
+    filter?: QueryFilter;
+    columns?: ColumnItemModel[];
+};
+export type TaskProgressViewPostModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working?: boolean;
+    settings: TaskProgressSettings;
+};
+export type ListsSettings = {
+    sortBy?: string;
+    sortDesc?: boolean;
+    filter?: QueryFilter;
+    columns?: ColumnItemModel[];
+};
+export type ListsViewPostModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working?: boolean;
+    settings: ListsSettings;
+};
+export type OverviewViewModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Determines whether the view is only available for the given project or for all projects (studio). */
+    scope: 'project' | 'studio';
+    /** Name of the user who created the view. Owners have full control over the view,  */
+    owner: string;
+    /** Visibility of the view. Public views are visible to all users, private views are only visible to the owner. */
+    visibility: 'public' | 'private';
+    access: object;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working: boolean;
+    position: number;
+    editable: boolean;
+    settings: OverviewSettings;
+    viewType?: 'overview';
+};
+export type TaskProgressViewModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Determines whether the view is only available for the given project or for all projects (studio). */
+    scope: 'project' | 'studio';
+    /** Name of the user who created the view. Owners have full control over the view,  */
+    owner: string;
+    /** Visibility of the view. Public views are visible to all users, private views are only visible to the owner. */
+    visibility: 'public' | 'private';
+    access: object;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working: boolean;
+    position: number;
+    editable: boolean;
+    settings: TaskProgressSettings;
+    viewType?: 'taskProgress';
+};
+export type ListsViewModel = {
+    /** Unique identifier for the view within the given scope. */
+    id?: string;
+    /** Human-readable name of the view. */
+    label: string;
+    /** Determines whether the view is only available for the given project or for all projects (studio). */
+    scope: 'project' | 'studio';
+    /** Name of the user who created the view. Owners have full control over the view,  */
+    owner: string;
+    /** Visibility of the view. Public views are visible to all users, private views are only visible to the owner. */
+    visibility: 'public' | 'private';
+    access: object;
+    /** Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project  */
+    working: boolean;
+    position: number;
+    editable: boolean;
+    settings: ListsSettings;
+    viewType?: 'lists';
+};
+export type SetDefaultViewRequestModel = {
+    viewId: string;
+};
+export type OverviewViewPatchModel = {
+    label?: string;
+    owner?: string;
+    settings?: OverviewSettings;
+};
+export type TaskProgressViewPatchModel = {
+    label?: string;
+    owner?: string;
+    settings?: TaskProgressSettings;
+};
+export type ListsViewPatchModel = {
+    label?: string;
+    owner?: string;
+    settings?: ListsSettings;
+};