Service Design Specification - Object Design for additionalQuota

aifitapp-aicoach-service documentation

Document Overview

This document outlines the object design for the additionalQuota model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.

additionalQuota Data Object

Object Overview

Description: No description provided.

This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.

Core Configuration

• Soft Delete: Enabled — Determines whether records are marked inactive (isActive = false) instead of being physically deleted.
• Public Access: accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules.

Stripe Integration

This data object is configured to integrate with Stripe for order management of additionalQuota. It is designed to handle payment processing and order tracking. To manage payments, Mindbricks will design additional Business API routes arround this data object, which will be used checkout orders and charge customers.

• Order Name: additionalQuota

• Order Id Property: This MScript expression is used to extract the order’s unique identifier from the data object.

• Order Amount Property: This MScript expression is used to determine the order amount for payment. It should return a numeric value representing the total amount to be charged.

• Order Currency Property: This MScript expression is used to determine the currency for the order. It should return a string representing the currency code (e.g., “USD”, “EUR”).

• Order Description Property: 'additionalquota addition' This MScript expression is used to provide a description for the order, which will be shown in Stripe and on customer receipts. It should return a string that describes the order.

• Order Status Property: status This property is selected as the order status property, which will be used to track the current status of the order. It will be automatically updated based on payment results from Stripe.

• Order Status Update Date Property: statusUpdatedAt This property is selected to record the timestamp of the last order status update. It will be automatically managed during payment events to reflect when the status was last changed.

• Order Owner Id Property: userId This property is selected as the order owner property, which will be used to track the user who owns the order. It will be used to ensure correct access control in payment flows, allowing only the owner to manage their orders.

• Map Payment Result to Order Status: This configuration defines how Stripe’s payment results (e.g., started, success, failed, canceled) map to internal order statuses., paymentResultStarted status will be mapped to a local value using 'pending' and will be set to statusproperty. paymentResultCanceled status will be mapped to a local value using 'cancelled' and will be set to status property. paymentResultFailed status will be mapped to a local value using 'failed' and will be set to status property. paymentResultSuccess status will be mapped to a local value using 'active' and will be set to status property.

• On Checkout Error:

if an error occurs during the checkout process, the API will continue to execute, allowing for custom error handling. In this case, the payment error will ve recorded as a status update. To make a retry a new checkout, a new order will be created with the same data as the original order.

Properties Schema

Property	Type	Required	Description
userId	String	Yes
additionalMessage	Integer	Yes
status	Enum	Yes
currency	String	Yes
pricePaid	Integer	Yes
statusUpdatedAt	Date	No
activatedAt	Date	No
cancelledAt	Date	No
periodEnd	Date	No
periodStart	Date	No
paymentConfirmation	Enum	Yes	An automatic property that is used to check the confirmed status of the payment set by webhooks.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.

Default Values

Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.

• userId: ‘default’
• additionalMessage: 0
• status: pending
• currency: ‘default’
• pricePaid: 0
• paymentConfirmation: pending

Always Create with Default Values

Some of the default values are set to be always used when creating a new object, even if the property value is provided in the request body. It ensures that the property is always initialized with a default value when the object is created.

• paymentConfirmation: Will be created with value pending

Auto Update Properties

userId additionalMessage status currency pricePaid statusUpdatedAt activatedAt cancelledAt periodEnd periodStart

An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false. These properties will be added to the update API’s body parameters and can be updated by the user if any value is provided in the request body.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values.

• status: [pending, cancelled, failed, active, expired]

• paymentConfirmation: [pending, processing, paid, canceled]

Elastic Search Indexing

userId additionalMessage status currency pricePaid statusUpdatedAt activatedAt cancelledAt periodEnd periodStart paymentConfirmation

Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.

Database Indexing

userId additionalMessage status currency pricePaid statusUpdatedAt activatedAt cancelledAt periodEnd periodStart paymentConfirmation

Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.

Secondary Key Properties

paymentConfirmation

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Session Data Properties

userId

Session data properties are used to store data that is specific to the user session, allowing for personalized experiences and temporary data storage. If a property is configured as session data, it will be automatically mapped to the related field in the user session during CRUD operations. Note that session data properties can not be mutated by the user, but only by the system.

• userId: String property will be mapped to the session parameter userId.

This property is also used to store the owner of the session data, allowing for ownership checks and access control.

Filter Properties

paymentConfirmation

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.

• paymentConfirmation: Enum has a filter named paymentConfirmation