zurichat / zc_core Goto Github PK

As an organisation, I want to get the list of all apps so that I can install the one(s) I want

Activate App will contain logic for activating the organization installed plugin

As a user in an organization, I should be able to join public channels available in that organization

As a user, I should be able to update my profile information for each organization i'm in

UUID should be assigned to the user instead of an id for security reasons.

Provision an operation to retrieve all members of an organization
Endpoint: /organizations/{org_id}/members method=GET

a user should be able to edit a message after deleting it

As a registered user of zurichat I should be able to create a profile for a specific organization I'm in.

as a user, I want to be able to send messages to a room

Deletes a User with the specified ID

Provision an operation to alter the value of an organization name

Note
When name is updated, the organization url is also updated, the organization url is set with a default value at the point of creation (since it was not required) e.g. name.slack.com, if name exists already, random word should be appended and verified to be unique before saving. E.g. name-group.slack.com or nameworkspace.slack.com. Organization names are NOT unique, organization url MUST be unique.

Endpoint: /organizations/{org_id}/name method=PATCH body=name

As a registered user, I should be able to delete my avatar in ZuriChat

Provision an operation to create organization instance in the database

• Required field to create an organization → Owner email
• Default Organization name (e.g Slack) is also set for the organization. Name is NOT unique
• Default UNIQUE (to the owner) organization-url is set after validation. format = org_name+.zuri.com E.g slack.zuri.com
• If name exists, random words should be appended to org_name to make it unique, e.g slack-hq.zuri.com

Endpoint: /organizations method=POST body=owner_email

Provision an operation that retrieves ALL organization instances in the database
Endpoint: /organizations method=GET

To test:
https://api.zuri.chat/organizations

Newly Registered User(s) data should be saved

Create user model with methods to perform crud operations

Log in and registration with jwt

User should be able to login with email, password and company_id

As a registered user, I should be able to create an avatar in ZuriChat

As a User or an Organisation, I want to be able to upload or list custom / third-party apps either for personal or public use in the Marketplace

As a new user I should be able to verify my email address

this endpoint should return a list of messages in a particular room

Provision an operation that retrieves a single organization instance in the database
Endpoint: /organizations/{org_id} method=GET

As a user in an organization, i want to have a collection of saved items where i can bookmark important items i might need later.

Provision an operation that deletes an organization instance in the database

Endpoint: /organizations/{org_id} method=DELETE

Note
*Password verification must be done before operation is executed

Provision an operation to retrieve a single member record of an organization
Endpoint: /organizations/{org_id}/members/{member_id} method=GET

Some tips on choosing a good icon:

• Use a solid background color.
• Use a graphical logo or image rather than text.
• Leave some space around your icon.
• Upload an image that is 132px square or larger.

File is stored on an external server that returns a url of the image. This url is what is stored.

Endpoint: /organizations/{org_id}/logo POST form file upload

As a user I should be able to authenticate my phone number on ZuriChat.

As I as a User, I should be able to reset password

Provision an operation to alter the value of an organization url
Endpoint: /organizations/{org_id}/url method=PATCH body=url

As a user i want to be able to set my status, so others can know when I'm available or not

As a user with appropriate rights in an organization, i should be able to install approved plugins from the marketplace

As a new user, I should be able to join zurichat with a verified work email, so that I can join organizations

Provision an operation to alter the value of a member status

Endpoint: /organizations/{org_id}/members/{member_id}/status method=PUT body=status

A definition of the schema of an organization instance
Fields:

• ID : string (*MongoDb generates and returns ID for created objects, this may suffice.)
• Name : string
• LogoUrl : string
• Owner email : string
• Organization url : string
• Date Created : time
• Members : key, value type of -> user_id: User (user defined type)
• Channels : key, value type of -> channel_id: Channel (user defined type)
• Apps: key, value type of -> app_id: App(user defined type)
• Settings : Settings (user defined type)

Who is a member?
A member is user (registered on the platform) that is invited to join an organization through invitation links sent to their email.
Schema

• ID
• Files
• Logo
• Name
• Email
• Display Name
• Bio
• Pronouns
• Phone number
• Time Zone
• Socials: Social user defined type (url, title, id)
• Preferences
• isActive

Provision an operation to create a member instance in an organization
Endpoint: /organizations/{org_id}/member method=POST body=member_email

As an organisation, I want to remove the app(s) that I no longer use or need

As a plugin that a registered user uses, I want to store the file(s) my user uploaded to the database

A user should be able to exchange message with other users present in a room.

Establish a web socket connection so that messages can sync realtime and a user should be able to detect when another user is typing

As a user, i should be able to add information about me and what i do to my profile for a workspace

As a user of an organization, I should be able to leave a room (or channel) that I am present in and would no longer like to be a part of.

Provision an operation to alter a member profile image
Endpoint: /organizations/{org_id}/members/{member_id}/image POST file upload

As a user, i should be able to set timezone so that others in my organization can know my working hours.

As an organisation, I want to search for an app so that I can install it without going through the list of all apps

As a user, i should be able to update my avatar for a workspace

This endpoint will retrieve a list of all the rooms the authenticated user is in

Company should be able to register with the following information
https://github.com/zuriinternship/zurichat/blob/main/db/users.document.json