jourycms-sdk 1.0.1

package/typings/v1/services/auth/api/user.d.ts

@@ -0,0 +1,391 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Users {
+        export namespace Api {
+          export namespace Users {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.Create
+             * @param {Levelup.V2.Users.Api.Users.Create.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildCreateRequest<Entity.User>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.Update
+             * @param {Levelup.V2.Users.Api.Users.Update.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<Entity.User>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdateProfile
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.UpdateProfile
+             * @param {Levelup.V2.Users.Api.Users.UpdateProfile.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.UpdateProfile.Response}
+             * @method PUT
+             * @link /profile/:id
+             *
+             */
+            export namespace UpdateProfile {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<
+                  Entity.User["profile"]
+                >;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdatePreferences
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.UpdatePreferences
+             * @param {Levelup.V2.Users.Api.Users.UpdatePreferences.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.UpdatePreferences.Response}
+             * @method PUT
+             * @link /preferences/:id
+             *
+             */
+            export namespace UpdatePreferences {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<
+                  Entity.User["preferences"]
+                >;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdateLoginInfo
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/:id/update-login-info
+             * @fires UsersService.updateLoginInfo
+             * @param {Levelup.V2.Users.Api.Users.UpdateLoginInfo.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.UpdateLoginInfo.Response}
+             *
+             */
+            export namespace UpdateLoginInfo {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  email: string | undefined;
+                  password: string;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdateSettings
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.UpdateSettings
+             * @param {Levelup.V2.Users.Api.Users.UpdateSettings.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.UpdateSettings.Response}
+             * @method PUT
+             *
+             */
+            export namespace UpdateSettings {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  userPreferences?: Partial<Entity.IUserPreferences>;
+                  delivererSettings?: Entity.IDelivererSettings;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  userPreferences?: Partial<Entity.IUserPreferences>;
+                  delivererSettings?: Entity.IDelivererSettings;
+                }>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.Delete
+             * @param {Levelup.V2.Users.Api.Users.Delete.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<
+                Record<string, never>
+              >;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            BulkDelete
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.BulkDelete
+             * @param {Levelup.V2.Users.Api.Users.BulkDelete.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.BulkDelete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace BulkDelete {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<{
+                items: string[];
+                hard?: boolean;
+              }>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            one
+             * --------------------------------------------------------------------------
+             * @method GET
+             * @link /api/v2/users/:id
+             * @fires UsersService.One
+             * @param {Levelup.V2.Users.Api.Users.GetOne.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.GetOne.Response}
+             *
+             */
+            export namespace GetOne {
+              export type Scope = "autocomplete";
+
+              export type Request = Levelup.V2.Utils.Api.Request.Build<
+                Record<string, unknown>
+              >;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.List
+             * @param {Levelup.V2.Users.Api.Users.List.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              export type Scope = "";
+
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.ExposedUser> & {
+                  filters?: {
+                    store?: Utils.Common.ID | Utils.Common.ID[];
+                    office?: Utils.Common.ID | Utils.Common.ID[];
+                    country?: Utils.Common.ID | Utils.Common.ID[];
+                    state?: Utils.Common.ID | Utils.Common.ID[];
+                    city?: Utils.Common.ID | Utils.Common.ID[];
+                  };
+                };
+              export type Response = Utils.Api.Response.BuildListResponse<
+                Entity.ExposedUser,
+                "companies" | "stores"
+              >;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            ChangeRole
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/:id/change-role
+             * @fires UsersService.ChangeRole
+             * @param {Levelup.V2.Users.Api.Users.ChangeRole.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.ChangeRole.Response}
+             *
+             */
+            export namespace ChangeRole {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  user_id?: Utils.Common.ID;
+                  /**
+                   * Role name or ID
+                   */
+                  role: string;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            ChangePermissions
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/:id/change-permissions
+             * @fires Service.ChangePermissions
+             * @param {Levelup.V2.Users.Api.Users.ChangePermissions.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.ChangePermissions.Response}
+             *
+             */
+            export namespace ChangePermissions {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  user_id?: Utils.Common.ID;
+                  permissions: Utils.Common.ID[];
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            ChangeSuspendStatus
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/:id/change-suspend-status
+             * @fires Service.ChangeSuspendStatus
+             * @param {Levelup.V2.Users.Api.Users.ChangeSuspendStatus.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.ChangeSuspendStatus.Response}
+             *
+             */
+            export namespace ChangeSuspendStatus {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<never>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedUser>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            SetLastManagedStore
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/set-last-managed-store
+             * @fires Service.SetLastManagedStore
+             * @param {Levelup.V2.Users.Api.Users.SetLastManagedStore.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.SetLastManagedStore.Response}
+             *
+             */
+            export namespace SetLastManagedStore {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  store_id: Utils.Common.ID;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{}>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            SetLastManagedOffice
+             * --------------------------------------------------------------------------
+             * @method PUT
+             * @link /api/v2/users/set-last-managed-office
+             * @fires Service.SetLastManagedOffice
+             * @param {Levelup.V2.Users.Api.Users.SetLastManagedOffice.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.SetLastManagedOffice.Response}
+             *
+             */
+            export namespace SetLastManagedOffice {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<{
+                  office1_id: Utils.Common.ID;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{}>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            ListUserPermissions
+             * --------------------------------------------------------------------------
+             * @method GET
+             * @link /api/v2/users/:id/permissions
+             * @fires UsersService.listUserPermissions
+             * @param {Levelup.V2.Users.Api.Users.ListUserPermissions.Request} query
+             * @returns {Levelup.V2.Users.Api.Users.ListUserPermissions.Response}
+             *
+             */
+            export namespace ListUserPermissions {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<
+                Record<string, unknown>
+              >;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  /**
+                   * List of permission names
+                   */
+                  permissions: {
+                    _id: Utils.Common.ID;
+                    group: Utils.Common.ID;
+                    name: string;
+                  }[];
+                  user: Entity.ExposedUser;
+                }>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            GetInsightsHierarchySnapshotList
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UsersService.GetInsightsHierarchySnapshotList
+             * @param {Levelup.V2.Users.Api.Users.GetInsightsHierarchySnapshotList.Request}
+             * @returns {Levelup.V2.Users.Api.Users.GetInsightsHierarchySnapshotList.Response}
+             */
+            export namespace GetInsightsHierarchySnapshotList {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<
+                Record<string, unknown>
+              >;
+              type ItemDatum = {
+                _id: Utils.Common.ID;
+                tr: string;
+                dl: boolean;
+                usr: string | null;
+                cr: Date;
+                fst: string | null;
+                fml: string | null;
+                r: string;
+                p: string | null;
+                c?: string | null;
+                sn?: string | null;
+                st?: string | null;
+              };
+              export type Response = Utils.Api.Response.DefaultResponse & {
+                data?: {
+                  data?: ItemDatum[];
+                  last_update?: Date;
+                  found: boolean;
+                  expired: boolean;
+                };
+              };
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/_shared.d.ts

@@ -0,0 +1,11 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export type TJWTTokenSpace = "default" | "payment";
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/api-key.d.ts

@@ -0,0 +1,29 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export type ApiKey = Utils.Entity.General.ICreatable &
+            Utils.Entity.General.IHasSearchMeta & {
+              _id: Utils.Common.ID;
+              name: string;
+              related_to: ("company" | "app" | "store")[];
+              app: string | null;
+              company: string | null;
+              store: string | null;
+              last_use: Date;
+              token: string;
+              encryptedKey: string;
+              salt: string;
+              permissions: string[];
+            };
+
+          export type ExposedApiKey = Omit<
+            Entity.ApiKey,
+            "salt" | "encryptedKey"
+          >;
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/federated-credential.d.ts

@@ -0,0 +1,22 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export interface FederatedCredential {
+            created_at?: Date;
+            updated_at?: Date;
+            is_deleted?: boolean;
+            deleted_at?: Date | null;
+            _id: Utils.Common.ID;
+            //
+            user_id: Utils.Common.ID;
+            provider: string;
+            issuer: string;
+            id: Utils.Common.ID;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/index.d.ts

@@ -0,0 +1,9 @@
+'generated by levelup';
+
+export * from "./user.d.ts";
+export * from "./role.d.ts";
+export * from "./permission.d.ts";
+export * from "./permission-group.d.ts";
+export * from "./api-key.d.ts";
+export * from "./_shared.d.ts";
+export * from "./federated-credential.d.ts";

package/typings/v1/services/auth/entities/permission-group.d.ts

@@ -0,0 +1,20 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export interface PermissionGroup
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            is_system: boolean;
+            service: string | null;
+            name: string;
+            description: string;
+            permissions: Utils.Common.ID[];
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/permission.d.ts

@@ -0,0 +1,24 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export interface Permission
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            is_system: boolean;
+            service: string | null;
+            group: Utils.Common.ID | null | PermissionGroup;
+            name: string;
+            description: string;
+            roles: Utils.Common.ID[];
+            insights?: {
+              user_count?: number;
+            };
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/role.d.ts

@@ -0,0 +1,25 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Entity {
+          export interface Role
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            is_system: boolean;
+            is_company_related: boolean;
+            name: string;
+            description: string;
+            has_all_permissions?: boolean;
+            permissions?: Utils.Common.ID[];
+
+            insights?: {
+              user_count?: number;
+            };
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/entities/user.d.ts

@@ -0,0 +1,153 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Users {
+        export namespace Entity {
+          export type Sex = "male" | "female";
+
+          export interface IUserProfile {
+            full_name?: string;
+            first_name: string;
+            family_name: string;
+            sex: Sex | null;
+            photo: Utils.Common.FileAttribute;
+            phones: string[];
+            website: string | null;
+            address: Utils.Entity.Snapshots.Locations.Address;
+            has_work_address: boolean;
+            work_address: Utils.Entity.Snapshots.Locations.Address | null;
+            social_links?: {
+              network: Utils.Common.SocialNetworks;
+              url: string;
+            }[];
+          }
+
+          export interface IUserPreferences {
+            ui_mode?: UI.Mode;
+            ui_language?: Levelup.V2.Cm.Translation.Entity.TLanguageCode;
+            printer_format?: Reports.Settings.PrinterFormat;
+          }
+          export interface IDelivererData {
+            today_total_parcels?: {
+              tracking_id: Utils.Common.TrackingID;
+              amount: number;
+            }[];
+            today_delivered_parcels?: {
+              tracking_id: Utils.Common.TrackingID;
+              amount: number;
+            }[];
+            today_failed_parcels?: {
+              tracking_id: Utils.Common.TrackingID;
+              amount: number;
+            }[];
+          }
+
+          export interface IUserInsights {
+            last_updated: Date | null;
+            rating: number;
+            parcel_count: number;
+            delivered_parcel_count: number;
+            returned_parcel_count: number;
+            delivered_parcel_percentage: number;
+            returned_parcel_percentage: number;
+            complaint_count: number;
+            resolved_complaint_count: number;
+            resolved_complaint_percentage: number;
+            balance: number;
+          }
+
+          export interface IUserAttributes {
+            is_suspended?: boolean;
+            is_approved?: boolean;
+            is_active?: boolean;
+            inactive_since?: Date | null;
+
+            nid?: string | null;
+            driving_license_id?: string | null;
+            started_at?: Date | null;
+
+            multi_office_user?: {
+              is_related_to_offices?: boolean;
+              can_manage_all_offices?: boolean;
+              subscribed_at_office?: Utils.Common.ID | null;
+              managed_offices?: Utils.Common.ID[];
+              last_managed_office?: Utils.Common.ID | null;
+            } | null;
+
+            seller?: {
+              stores: Utils.Common.ID[];
+              last_managed_store?: Utils.Common.ID;
+            } | null;
+
+            deliverer?: {
+              countries?: Utils.Common.LocationAdministrativeCode[];
+              states?: Utils.Common.LocationAdministrativeCode[];
+              cities?: Utils.Common.LocationAdministrativeCode[];
+              is_freelancer?: boolean;
+              default_delivery_fees?: number;
+              delivery_fees?: {
+                city: {
+                  country: Utils.Common.LocationAdministrativeCode;
+                  state: Utils.Common.LocationAdministrativeCode;
+                  city: Utils.Common.LocationAdministrativeCode;
+                };
+                is_default: boolean;
+                fees: number;
+              }[];
+            } | null;
+
+            team?: {
+              has_team: boolean;
+              team?: {
+                leader: string;
+                members: string[];
+              };
+            };
+          }
+
+          export interface IUserSnapshots {
+            stores?: Utils.Entity.Snapshots.Accounts.Store[];
+            company?: Utils.Entity.Snapshots.Accounts.Company;
+            offices?: Utils.Entity.Snapshots.Logistics.Office[];
+            team_leader?: Utils.Entity.Snapshots.Auth.User;
+            team_members?: Utils.Entity.Snapshots.Auth.User[];
+          }
+
+          export interface User
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            tracking_id: Utils.Common.TrackingID;
+            //
+            email: string;
+            password?: string;
+            salt?: string;
+            role: Auth.Entity.TDefaultUserRoles | string;
+            permissions: Utils.Common.ID[];
+            permissions_other_than_role?: boolean;
+
+            profile: IUserProfile;
+            preferences?: IUserPreferences;
+            deliverer_data?: IDelivererData;
+            attributes: IUserAttributes;
+            snapshots?: IUserSnapshots;
+            insights?: IUserInsights;
+            auth_meta?: {
+              last_login: Date | null;
+              last_logout: Date | null;
+              last_password_change: Date | null;
+              last_password_reset: Date | null;
+              last_password_reset_request: Date | null;
+              password_reset_token: string | null;
+              password_reset_token_expiration: Date | null;
+              password_reset_token_used: boolean;
+              password_reset_token_used_at: Date | null;
+            } | null;
+          }
+
+          export type ExposedUser = Omit<User, "password" | "salt">;
+        }
+      }
+    }
+  }
+}