@reviza/api-client 0.0.0 → 0.0.1-SNAPSHOT-7a83b30d

package/dist/controllers/index.d.ts

@@ -0,0 +1,627 @@
+import { LoginPayload, LoginData, RegistrationTokenData, RegisterPayload, ForgotPasswordPayload, PasswordPayload, InvitationPayload } from '../App/Data/Auth';
+import { RevizaResponseData } from '../App/Data';
+import { DataCollection } from '../Spatie/LaravelData';
+import { CategoryData, CategoryCreatePayload, CategoryUpdatePayload, CategoryTreeData } from '../App/Data/Category';
+import { ConfigData } from '../App/Data/Config';
+import { FacilityListData, FacilityData, FacilityCreatePayload, FacilityUpdatePayload, FacilityPicturePayload, FacilityIssueResolvedPayload, RelatedFacilityCreatePayload } from '../App/Data/Facility';
+import { DemoRequestCreatePayload, DemoRequestData } from '../App/Data/Demo';
+import { MapExtentData, MapData } from '../App/Data/Map';
+import { DocumentData, DocumentCreatePayload, DocumentUpdatePayload } from '../App/Data/Document';
+import { FrontendRouteRedirectRequest, FrontendRouteRedirectData } from '../App/Data/FrontendRoute';
+import { MeData, MeUpdatePayload } from '../App/Data/Me';
+import { UserSettingsPayload, UserData } from '../App/Data/User';
+import { NotificationSettingsData, NotificationSettingsPayload } from '../App/Data/Notification';
+import { OrganizationData, OrganizationUpdatePayload } from '../App/Data/Organization';
+import { SubscriptionData } from '../App/Data/Subscription';
+import { UserPermissionData, UserPermissionPayload } from '../App/Data/Permission';
+import { RevisionData, RevisionCreatePayload, RevisionUpdatePayload, RevisionIssueData } from '../App/Data/Revision';
+import { SearchData } from '../App/Data/Search';
+type ActionFunction<P extends RouteParams | undefined> = P extends undefined ? (options?: RouteOptions) => ActionResult : (params: P, options?: RouteOptions) => ActionResult;
+type ActionResult = RouteDefinition & {
+    url: string;
+};
+type ActionWithMethods<P extends RouteParams | undefined, M extends string> = ActionFunction<P> & {
+    [K in M]: ActionFunction<P>;
+};
+export declare const AuthController: {
+    readonly login: ActionWithMethods<undefined, string>;
+    readonly logout: ActionWithMethods<undefined, string>;
+    readonly verifyRegistrationToken: ActionWithMethods<{
+        token: string | number;
+    }, string>;
+    readonly register: ActionWithMethods<{
+        token: string | number;
+    }, string>;
+    readonly forgotPassword: ActionWithMethods<undefined, string>;
+    readonly resetPassword: ActionWithMethods<{
+        token: string | number;
+    }, string>;
+};
+export declare namespace AuthController {
+    namespace login {
+        type Request = LoginPayload;
+        type Response = RevizaResponseData<LoginData>;
+    }
+    namespace logout {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace verifyRegistrationToken {
+        type Request = object;
+        type Response = RevizaResponseData<RegistrationTokenData>;
+    }
+    namespace register {
+        type Request = RegisterPayload;
+        type Response = RevizaResponseData<LoginData>;
+    }
+    namespace forgotPassword {
+        type Request = ForgotPasswordPayload;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace resetPassword {
+        type Request = PasswordPayload;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export declare const CategoryController: {
+    readonly index: ActionWithMethods<undefined, string>;
+    readonly store: ActionWithMethods<undefined, string>;
+    readonly show: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+};
+export declare namespace CategoryController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, CategoryData>>;
+    }
+    namespace store {
+        type Request = CategoryCreatePayload;
+        type Response = RevizaResponseData<CategoryData>;
+    }
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<CategoryData | null>;
+    }
+    namespace update {
+        type Request = CategoryUpdatePayload;
+        type Response = RevizaResponseData<CategoryData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export declare const ConfigController: {
+    readonly config: ActionWithMethods<undefined, string>;
+};
+export declare namespace ConfigController {
+    namespace config {
+        type Request = object;
+        type Response = RevizaResponseData<ConfigData>;
+    }
+}
+export declare const DashboardController: {
+    readonly categoryTree: ActionWithMethods<undefined, string>;
+    readonly facilityList: ActionWithMethods<undefined, string>;
+};
+export declare namespace DashboardController {
+    namespace categoryTree {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, CategoryTreeData>>;
+    }
+    namespace facilityList {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, FacilityListData>>;
+    }
+}
+export declare const DemoRequestController: {
+    readonly store: ActionWithMethods<undefined, string>;
+    readonly index: ActionWithMethods<undefined, string>;
+};
+export declare namespace DemoRequestController {
+    namespace store {
+        type Request = DemoRequestCreatePayload;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, DemoRequestData>>;
+    }
+}
+export declare const FacilityController: {
+    readonly getMapExtent: ActionWithMethods<{
+        facility: string | number;
+        map: string | number;
+    }, string>;
+    readonly index: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly store: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly show: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly storePicture: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly viewPicture: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly deletePicture: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly viewQrCode: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly resolveIssue: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        issue: string | number;
+    }, string>;
+};
+export declare namespace FacilityController {
+    namespace getMapExtent {
+        type Request = object;
+        type Response = RevizaResponseData<MapExtentData | null>;
+    }
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, FacilityData>>;
+    }
+    namespace store {
+        type Request = FacilityCreatePayload;
+        type Response = RevizaResponseData<FacilityData>;
+    }
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<FacilityData>;
+    }
+    namespace update {
+        type Request = FacilityUpdatePayload;
+        type Response = RevizaResponseData<FacilityData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace storePicture {
+        type Request = FacilityPicturePayload;
+        type Response = RevizaResponseData<FacilityData | null>;
+    }
+    namespace viewPicture {
+        type Request = object;
+        type Response = object;
+    }
+    namespace deletePicture {
+        type Request = object;
+        type Response = RevizaResponseData<FacilityData | null>;
+    }
+    namespace viewQrCode {
+        type Request = object;
+        type Response = object;
+    }
+    namespace resolveIssue {
+        type Request = FacilityIssueResolvedPayload;
+        type Response = RevizaResponseData<FacilityData | null>;
+    }
+}
+export declare const FacilityDocumentController: {
+    readonly index: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly store: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        document: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        document: string | number;
+    }, string>;
+    readonly download: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        document: string | number;
+    }, string>;
+};
+export declare namespace FacilityDocumentController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, DocumentData>>;
+    }
+    namespace store {
+        type Request = DocumentCreatePayload;
+        type Response = RevizaResponseData<DocumentData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace update {
+        type Request = DocumentUpdatePayload;
+        type Response = RevizaResponseData<DocumentData | null>;
+    }
+    namespace download {
+        type Request = object;
+        type Response = object;
+    }
+}
+export declare const FrontendErrorController: {
+    readonly logError: ActionWithMethods<undefined, string>;
+};
+export declare namespace FrontendErrorController {
+    namespace logError {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export declare const FrontendRouteController: {
+    readonly redirect: ActionWithMethods<undefined, string>;
+};
+export declare namespace FrontendRouteController {
+    namespace redirect {
+        type Request = FrontendRouteRedirectRequest;
+        type Response = RevizaResponseData<FrontendRouteRedirectData | null>;
+    }
+}
+export declare const MapController: {
+    readonly index: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly getTile: ActionWithMethods<{
+        category: string | number;
+        map: string | number;
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }, string>;
+};
+export declare namespace MapController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, MapData>>;
+    }
+    namespace getTile {
+        type Request = object;
+        type Response = object;
+    }
+}
+export declare const MeController: {
+    readonly me: ActionWithMethods<undefined, string>;
+    readonly update: ActionWithMethods<undefined, string>;
+    readonly tutorial: ActionWithMethods<undefined, string>;
+    readonly changePassword: ActionWithMethods<undefined, string>;
+    readonly updateSettings: ActionWithMethods<undefined, string>;
+};
+export declare namespace MeController {
+    namespace me {
+        type Request = object;
+        type Response = RevizaResponseData<MeData>;
+    }
+    namespace update {
+        type Request = MeUpdatePayload;
+        type Response = RevizaResponseData<MeData>;
+    }
+    namespace tutorial {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace changePassword {
+        type Request = PasswordPayload;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace updateSettings {
+        type Request = UserSettingsPayload;
+        type Response = RevizaResponseData<MeData>;
+    }
+}
+export type MethodRoute = {
+    method: 'get' | 'post' | 'put' | 'patch' | 'delete';
+    url: string;
+};
+export declare const NotificationSettingsController: {
+    readonly show: ActionWithMethods<undefined, string>;
+    readonly update: ActionWithMethods<undefined, string>;
+};
+export declare namespace NotificationSettingsController {
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<NotificationSettingsData>;
+    }
+    namespace update {
+        type Request = NotificationSettingsPayload;
+        type Response = RevizaResponseData<NotificationSettingsData>;
+    }
+}
+export declare const OrganizationController: {
+    readonly index: ActionWithMethods<undefined, string>;
+    readonly show: ActionWithMethods<{
+        organization: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        organization: string | number;
+    }, string>;
+    readonly getSubscriptions: ActionWithMethods<{
+        organization: string | number;
+    }, string>;
+};
+export declare namespace OrganizationController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, OrganizationData>>;
+    }
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<OrganizationData>;
+    }
+    namespace update {
+        type Request = OrganizationUpdatePayload;
+        type Response = RevizaResponseData<OrganizationData>;
+    }
+    namespace getSubscriptions {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, SubscriptionData>>;
+    }
+}
+export declare const PermissionController: {
+    readonly show: ActionWithMethods<{
+        organization: string | number;
+        user: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        organization: string | number;
+        user: string | number;
+    }, string>;
+};
+export declare namespace PermissionController {
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<UserPermissionData | null>;
+    }
+    namespace update {
+        type Request = UserPermissionPayload;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export type QueryParams = Record<string, string | number | boolean | null | undefined | (string | number | boolean)[]>;
+export declare const RelatedFacilityController: {
+    readonly options: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly store: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        relatedFacility: string | number;
+    }, string>;
+};
+export declare namespace RelatedFacilityController {
+    namespace options {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, FacilityData>>;
+    }
+    namespace store {
+        type Request = RelatedFacilityCreatePayload;
+        type Response = RevizaResponseData<FacilityData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<FacilityData | null>;
+    }
+}
+export declare const RevisionController: {
+    readonly index: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly store: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+    }, string>;
+    readonly show: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+};
+export declare namespace RevisionController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, RevisionData> | null>;
+    }
+    namespace store {
+        type Request = RevisionCreatePayload;
+        type Response = RevizaResponseData<RevisionData>;
+    }
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<RevisionData | null>;
+    }
+    namespace update {
+        type Request = RevisionUpdatePayload;
+        type Response = RevizaResponseData<RevisionData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export declare const RevisionDocumentController: {
+    readonly index: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+    readonly store: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+        document: string | number;
+    }, string>;
+    readonly update: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+        document: string | number;
+    }, string>;
+    readonly download: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+        document: string | number;
+    }, string>;
+};
+export declare namespace RevisionDocumentController {
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, DocumentData> | null>;
+    }
+    namespace store {
+        type Request = DocumentCreatePayload;
+        type Response = RevizaResponseData<DocumentData>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace update {
+        type Request = DocumentUpdatePayload;
+        type Response = RevizaResponseData<DocumentData | null>;
+    }
+    namespace download {
+        type Request = object;
+        type Response = object;
+    }
+}
+export declare const RevisionIssueController: {
+    readonly getForCategory: ActionWithMethods<{
+        category: string | number;
+    }, string>;
+    readonly index: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+    }, string>;
+    readonly show: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+        issue: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        category: string | number;
+        facility: string | number;
+        revision: string | number;
+        issue: string | number;
+    }, string>;
+};
+export declare namespace RevisionIssueController {
+    namespace getForCategory {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, RevisionIssueData> | null>;
+    }
+    namespace index {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, RevisionIssueData> | null>;
+    }
+    namespace show {
+        type Request = object;
+        type Response = RevizaResponseData<RevisionIssueData | null>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export type RouteDefinition = {
+    url: string;
+    method: 'get' | 'post' | 'put' | 'patch' | 'delete';
+};
+export type RouteOptions = {
+    query?: QueryParams;
+};
+export type RouteParams = Record<string, string | number>;
+export declare const SearchController: {
+    readonly search: ActionWithMethods<undefined, string>;
+};
+export declare namespace SearchController {
+    namespace search {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, SearchData>>;
+    }
+}
+export declare const UserController: {
+    readonly organizationUsers: ActionWithMethods<{
+        organization: string | number;
+    }, string>;
+    readonly invite: ActionWithMethods<{
+        organization: string | number;
+    }, string>;
+    readonly destroy: ActionWithMethods<{
+        organization: string | number;
+        user: string | number;
+    }, string>;
+};
+export declare namespace UserController {
+    namespace organizationUsers {
+        type Request = object;
+        type Response = RevizaResponseData<DataCollection<number, UserData>>;
+    }
+    namespace invite {
+        type Request = InvitationPayload;
+        type Response = RevizaResponseData<null>;
+    }
+    namespace destroy {
+        type Request = object;
+        type Response = RevizaResponseData<null>;
+    }
+}
+export declare function buildUrl(path: string, params?: RouteParams, options?: RouteOptions): string;
+export declare function createActionWithMethods<P extends RouteParams | undefined = undefined, M extends string = string>(routes: MethodRoute[]): ActionWithMethods<P, M>;
+export {};