Service Design Specification

clonesahibinden-listing-service documentation Version: 1.0.3

Scope

This document provides a structured architectural overview of the listing microservice, detailing its configuration, data model, authorization logic, business rules, and API design. It has been automatically generated based on the service definition within Mindbricks, ensuring that the information reflects the source of truth used during code generation and deployment.

The document is intended to serve multiple audiences:

Note for Frontend Developers: While this document is valuable for understanding business logic and data interactions, please refer to the Service API Documentation for endpoint-level specifications and integration details.

Note for Backend Developers: Since the code for this service is automatically generated by Mindbricks, you typically won’t need to implement or modify it manually. However, this document is especially valuable when you’re building other services—whether within Mindbricks or externally—that need to interact with or depend on this service. It provides a clear reference to the service’s data contracts, business rules, and API structure, helping ensure compatibility and correct integration.

Listing Service Settings

Manages classified listings, their lifecycle, premium features, status transitions, and provides filtering/search for marketplace ads. Integrates with users, categories, locations, and Stripe for premium ad upgrades. Enforces ad and user type business logic.

Service Overview

This service is configured to listen for HTTP requests on port 3001, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

The service uses a PostgreSQL database for data storage, with the database name set to clonesahibinden-listing-service.

This service is accessible via the following environment-specific URLs:

Authentication & Security

This service does not require user authentication for access. It is designed to be publicly accessible, allowing anonymous users to interact with its endpoints. However, certain CRUD routes may still require login based on their specific configurations.

Service Data Objects

The service uses a PostgreSQL database for data storage, with the database name set to clonesahibinden-listing-service.

Data deletion is managed using a soft delete strategy. Instead of removing records from the database, they are flagged as inactive by setting the isActive field to false.

Object Name Description Public Access
listing Core object for classified ads. Contains main listing information, relations, status, premium logic, price, attributes, contact info, and custom attributes. Supports premium upgrades via Stripe and lifecycle management. accessProtected
sys_listingPayment A payment storage object to store the payment life cyle of orders based on listing object. It is autocreated based on the source object's checkout config accessPrivate
sys_paymentCustomer A payment storage object to store the customer values of the payment platform accessPrivate
sys_paymentMethod A payment storage object to store the payment methods of the platform customers accessPrivate

listing Data Object

Object Overview

Description: Core object for classified ads. Contains main listing information, relations, status, premium logic, price, attributes, contact info, and custom attributes. Supports premium upgrades via Stripe and lifecycle management.

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

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: doInsert

The new record will be inserted without checking for duplicates. This means that the composite index is designed for search purposes only.

Stripe Integration

This data object is configured to integrate with Stripe for order management of listing. 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.

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
attributes Object No JSON object for custom per-category attributes (structured as required by category schema).
categoryId ID Yes Main category for the listing (categoryLocation:category).
condition Enum Yes Item condition: new, used, other.
contactEmail String No Contact email (recommended to send via platform only).
contactPhone String No Display phone/contact for listing; may be masked by front end.
currency String Yes Currency (ISO-4217 code, e.g. 'TRY', 'USD').
description Text Yes Full description/body of listing.
expiresAt Date No UTC expiry for listing; after this, listing is automatically expired.
favoriteCount Integer Yes Favorite count (updated asynchronously by favorite service, not directly settable by user).
isPremium Boolean Yes If true, the listing is premium (highlighted/pinned, eligible for special placement).
listingType Enum Yes Type of listing (sale, rent, service, etc.).
locationId ID Yes Location (categoryLocation:location).
_paymentConfirmation String No Stripe payment result details (Stripe webhook metadata, internal use only).
premiumExpiry Date No UTC date when premium status expires. Null if not premium or not applicable.
premiumType Enum No Which premium package (gold, silver, none, etc.).
price Double Yes Listing price.
status Enum Yes Lifecycle status: pending_review, active, denied, sold, expired, deleted.
subcategoryId ID No Subcategory for the listing, can be null for top-level (categoryLocation:category).
title String Yes Listing title, short and clear.
userId ID Yes Owner (poster) of the listing (auth:user).
viewsCount Integer Yes View count (updated asynchronously; not directly settable by user).
paymentConfirmation Enum Yes An automatic property that is used to check the confirmed status of the payment set by webhooks.

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.

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.

Constant Properties

favoriteCount _paymentConfirmation userId viewsCount

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

attributes categoryId condition contactEmail contactPhone currency description expiresAt isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title

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.

Elastic Search Indexing

attributes categoryId condition currency description expiresAt favoriteCount isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title userId viewsCount 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

categoryId condition currency isPremium listingType locationId premiumExpiry premiumType price status subcategoryId userId 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.

Relation Properties

categoryId locationId subcategoryId userId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: Yes

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: Yes

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: No

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

On Delete: Set Null Required: Yes

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.

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

Formula Properties

isPremium

Formula properties are used to define calculated fields that derive their values from other properties or external data. These properties are automatically calculated based on the defined formula and can be used for dynamic data retrieval.

Filter Properties

categoryId condition expiresAt isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title userId 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.

sys_listingPayment Data Object

Object Overview

Description: A payment storage object to store the payment life cyle of orders based on listing object. It is autocreated based on the source object's checkout config

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

Properties Schema

Property Type Required Description
ownerId ID No An ID value to represent owner user who created the order
orderId ID Yes an ID value to represent the orderId which is the ID parameter of the source listing object
paymentId String Yes A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
paymentStatus String Yes A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
statusLiteral String Yes A string value to represent the logical payment status which belongs to the application lifecycle itself.
redirectUrl String No A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

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.

Constant Properties

orderId

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

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.

Elastic Search Indexing

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

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

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

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.

Unique Properties

orderId

Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.

Secondary Key Properties

orderId

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

ownerId

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.

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

Filter Properties

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

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.

sys_paymentCustomer Data Object

Object Overview

Description: A payment storage object to store the customer values of the payment platform

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

Properties Schema

Property Type Required Description
userId ID No An ID value to represent the user who is created as a stripe customer
customerId String Yes A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway
platform String Yes A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

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.

Constant Properties

customerId platform

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

userId customerId platform

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.

Elastic Search Indexing

userId customerId platform

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 customerId platform

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.

Unique Properties

userId customerId

Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.

Secondary Key Properties

userId customerId

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.

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

Filter Properties

userId customerId platform

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.

sys_paymentMethod Data Object

Object Overview

Description: A payment storage object to store the payment methods of the platform customers

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

Properties Schema

Property Type Required Description
paymentMethodId String Yes A string value to represent the id of the payment method on the payment platform.
userId ID Yes An ID value to represent the user who owns the payment method
customerId String Yes A string value to represent the customer id which is generated on the payment gateway.
cardHolderName String No A string value to represent the name of the card holder. It can be different than the registered customer.
cardHolderZip String No A string value to represent the zip code of the card holder. It is used for address verification in specific countries.
platform String Yes A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.
cardInfo Object Yes A Json value to store the card details of the payment method.

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.

Constant Properties

paymentMethodId userId customerId cardHolderName cardHolderZip platform

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

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.

Elastic Search Indexing

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

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

paymentMethodId userId customerId platform cardInfo

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.

Unique Properties

paymentMethodId

Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.

Secondary Key Properties

paymentMethodId userId customerId

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.

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

Filter Properties

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

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.

Business Logic

listing has got 24 Business APIs to manage its internal and crud logic. For the details of each business API refer to its chapter.

Edge Controllers

m2mCreateListing

Configuration:

REST Settings:

m2mBulkCreateListing

Configuration:

REST Settings:

m2mUpdateListingById

Configuration:

REST Settings:

m2mDeleteListingById

Configuration:

REST Settings:

m2mUpdateListingByQuery

Configuration:

REST Settings:

m2mDeleteListingByQuery

Configuration:

REST Settings:

m2mUpdateListingByIdList

Configuration:

REST Settings:

m2mCreateSys_listingPayment

Configuration:

REST Settings:

m2mBulkCreateSys_listingPayment

Configuration:

REST Settings:

m2mUpdateSys_listingPaymentById

Configuration:

REST Settings:

m2mDeleteSys_listingPaymentById

Configuration:

REST Settings:

m2mUpdateSys_listingPaymentByQuery

Configuration:

REST Settings:

m2mDeleteSys_listingPaymentByQuery

Configuration:

REST Settings:

m2mUpdateSys_listingPaymentByIdList

Configuration:

REST Settings:

m2mCreateSys_paymentCustomer

Configuration:

REST Settings:

m2mBulkCreateSys_paymentCustomer

Configuration:

REST Settings:

m2mUpdateSys_paymentCustomerById

Configuration:

REST Settings:

m2mDeleteSys_paymentCustomerById

Configuration:

REST Settings:

m2mUpdateSys_paymentCustomerByQuery

Configuration:

REST Settings:

m2mDeleteSys_paymentCustomerByQuery

Configuration:

REST Settings:

m2mUpdateSys_paymentCustomerByIdList

Configuration:

REST Settings:

m2mCreateSys_paymentMethod

Configuration:

REST Settings:

m2mBulkCreateSys_paymentMethod

Configuration:

REST Settings:

m2mUpdateSys_paymentMethodById

Configuration:

REST Settings:

m2mDeleteSys_paymentMethodById

Configuration:

REST Settings:

m2mUpdateSys_paymentMethodByQuery

Configuration:

REST Settings:

m2mDeleteSys_paymentMethodByQuery

Configuration:

REST Settings:

m2mUpdateSys_paymentMethodByIdList

Configuration:

REST Settings:

Service Library

Functions

No general functions defined.

Hook Functions

No hook functions defined.

Edge Functions

m2mCreateListing.js

module.exports = async (request) => {
        const { createListing } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const data = request.body?.data || request.data || request;
        const result = await createListing(data, context);
        return { status: 200, content: result };
      }

m2mBulkCreateListing.js

module.exports = async (request) => {
        const { createBulkListing } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataList = request.body?.dataList || request.dataList || (Array.isArray(request.body) ? request.body : [request.body]);
        if (!Array.isArray(dataList) || dataList.length === 0) {
          return { status: 400, message: "dataList must be a non-empty array" };
        }
        const result = await createBulkListing(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateListingById.js

module.exports = async (request) => {
        const { updateListingById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.id) delete dataClause.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await updateListingById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteListingById.js

module.exports = async (request) => {
        const { deleteListingById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await deleteListingById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateListingByQuery.js

module.exports = async (request) => {
        const { updateListingByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await updateListingByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteListingByQuery.js

module.exports = async (request) => {
        const { deleteListingByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await deleteListingByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateListingByIdList.js

module.exports = async (request) => {
        const { updateListingByIdList } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const idList = request.body?.idList || request.idList || [];
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.idList) delete dataClause.idList;
        if (!Array.isArray(idList) || idList.length === 0) {
          return { status: 400, message: "idList must be a non-empty array" };
        }
        const result = await updateListingByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

m2mCreateSys_listingPayment.js 

module.exports = async (request) => {
        const { createSys_listingPayment } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const data = request.body?.data || request.data || request;
        const result = await createSys_listingPayment(data, context);
        return { status: 200, content: result };
      }

m2mBulkCreateSys_listingPayment.js 

module.exports = async (request) => {
        const { createBulkSys_listingPayment } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataList = request.body?.dataList || request.dataList || (Array.isArray(request.body) ? request.body : [request.body]);
        if (!Array.isArray(dataList) || dataList.length === 0) {
          return { status: 400, message: "dataList must be a non-empty array" };
        }
        const result = await createBulkSys_listingPayment(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_listingPaymentById.js 

module.exports = async (request) => {
        const { updateSys_listingPaymentById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.id) delete dataClause.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await updateSys_listingPaymentById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_listingPaymentById.js 

module.exports = async (request) => {
        const { deleteSys_listingPaymentById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await deleteSys_listingPaymentById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_listingPaymentByQuery.js 

module.exports = async (request) => {
        const { updateSys_listingPaymentByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await updateSys_listingPaymentByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_listingPaymentByQuery.js 

module.exports = async (request) => {
        const { deleteSys_listingPaymentByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await deleteSys_listingPaymentByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_listingPaymentByIdList.js 

module.exports = async (request) => {
        const { updateSys_listingPaymentByIdList } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const idList = request.body?.idList || request.idList || [];
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.idList) delete dataClause.idList;
        if (!Array.isArray(idList) || idList.length === 0) {
          return { status: 400, message: "idList must be a non-empty array" };
        }
        const result = await updateSys_listingPaymentByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

m2mCreateSys_paymentCustomer.js 

module.exports = async (request) => {
        const { createSys_paymentCustomer } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const data = request.body?.data || request.data || request;
        const result = await createSys_paymentCustomer(data, context);
        return { status: 200, content: result };
      }

m2mBulkCreateSys_paymentCustomer.js 

module.exports = async (request) => {
        const { createBulkSys_paymentCustomer } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataList = request.body?.dataList || request.dataList || (Array.isArray(request.body) ? request.body : [request.body]);
        if (!Array.isArray(dataList) || dataList.length === 0) {
          return { status: 400, message: "dataList must be a non-empty array" };
        }
        const result = await createBulkSys_paymentCustomer(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentCustomerById.js 

module.exports = async (request) => {
        const { updateSys_paymentCustomerById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.id) delete dataClause.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await updateSys_paymentCustomerById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_paymentCustomerById.js 

module.exports = async (request) => {
        const { deleteSys_paymentCustomerById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await deleteSys_paymentCustomerById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentCustomerByQuery.js 

module.exports = async (request) => {
        const { updateSys_paymentCustomerByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await updateSys_paymentCustomerByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_paymentCustomerByQuery.js 

module.exports = async (request) => {
        const { deleteSys_paymentCustomerByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await deleteSys_paymentCustomerByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentCustomerByIdList.js 

module.exports = async (request) => {
        const { updateSys_paymentCustomerByIdList } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const idList = request.body?.idList || request.idList || [];
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.idList) delete dataClause.idList;
        if (!Array.isArray(idList) || idList.length === 0) {
          return { status: 400, message: "idList must be a non-empty array" };
        }
        const result = await updateSys_paymentCustomerByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

m2mCreateSys_paymentMethod.js

module.exports = async (request) => {
        const { createSys_paymentMethod } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const data = request.body?.data || request.data || request;
        const result = await createSys_paymentMethod(data, context);
        return { status: 200, content: result };
      }

m2mBulkCreateSys_paymentMethod.js 

module.exports = async (request) => {
        const { createBulkSys_paymentMethod } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataList = request.body?.dataList || request.dataList || (Array.isArray(request.body) ? request.body : [request.body]);
        if (!Array.isArray(dataList) || dataList.length === 0) {
          return { status: 400, message: "dataList must be a non-empty array" };
        }
        const result = await createBulkSys_paymentMethod(dataList, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentMethodById.js 

module.exports = async (request) => {
        const { updateSys_paymentMethodById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.id) delete dataClause.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await updateSys_paymentMethodById(id, dataClause, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_paymentMethodById.js 

module.exports = async (request) => {
        const { deleteSys_paymentMethodById } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const id = request.body?.id || request.params?.id || request.id;
        if (!id) {
          return { status: 400, message: "ID is required" };
        }
        const result = await deleteSys_paymentMethodById(id, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentMethodByQuery.js 

module.exports = async (request) => {
        const { updateSys_paymentMethodByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await updateSys_paymentMethodByQuery(dataClause, query, context);
        return { status: 200, content: result };
      }

m2mDeleteSys_paymentMethodByQuery.js 

module.exports = async (request) => {
        const { deleteSys_paymentMethodByQuery } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const query = request.body?.query || request.query || {};
        if (!query || typeof query !== "object" || Object.keys(query).length === 0) {
          return { status: 400, message: "Query is required and must be a non-empty object" };
        }
        const result = await deleteSys_paymentMethodByQuery(query, context);
        return { status: 200, content: result };
      }

m2mUpdateSys_paymentMethodByIdList.js 

module.exports = async (request) => {
        const { updateSys_paymentMethodByIdList } = require("dbLayer");
        const context = { session: request.session, requestId: request.requestId };
        const idList = request.body?.idList || request.idList || [];
        const dataClause = request.body?.dataClause || request.dataClause || request.body;
        if (dataClause && dataClause.idList) delete dataClause.idList;
        if (!Array.isArray(idList) || idList.length === 0) {
          return { status: 400, message: "idList must be a non-empty array" };
        }
        const result = await updateSys_paymentMethodByIdList(idList, dataClause, context);
        return { status: 200, content: result };
      }

Templates

No templates defined.

Assets

No assets defined.

Public Assets

No public assets defined.

Event Emission

Integration Patterns

Deployment Considerations

Environment Configuration

Implementation Guidelines

Development Workflow

  1. Data Model Implementation: Generate database schema from data object definitions
  2. CRUD Route Generation: Implement auto-generated routes with custom logic
  3. Custom Logic Integration: Implement hook functions and edge functions
  4. Authentication Integration: Configure with project-level authentication
  5. Testing: Unit and integration testing for all components

Code Generation Expectations

Custom Code Integration Points

Testing Strategy

Unit Testing

Integration Testing

Performance Testing

Appendices

Data Type Reference

Type Description Storage
ID Unique identifier UUID (SQL) / ObjectID (NoSQL)
String Short text (≤255 chars) VARCHAR
Text Long-form text TEXT
Integer 32-bit whole numbers INT
Boolean True/false values BOOLEAN
Double 64-bit floating point DOUBLE
Float 32-bit floating point FLOAT
Short 16-bit integers SMALLINT
Object JSON object JSONB (PostgreSQL) / Object (MongoDB)
Date ISO 8601 timestamp TIMESTAMP
Enum Fixed numeric values SMALLINT with lookup

Enum Value Mappings

Request Locations

HTTP Methods

Edge Function Signature

async function edgeFunction(request) {
  // Custom request processing
  // Return response object or throw error
  return {
    data: {},
    status: 200,
    message: "Success"
  };
}

This document was generated from the service architecture definition and should be kept in sync with implementation changes.