Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to entity schemas #59

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Add links to entity schemas #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 190 additions & 22 deletions docs/entities/schemas-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,102 +9,270 @@ import Icon from '@site/src/components/Icon';

## Customer Relations

<h3 id="contact"><Icon name="contact" size={28} style={{ position: 'relative', top: '4px' }} /> Contact</h3>
<h3 id="contact">
<a href="/api/customer#tag/contact_schema">
<Icon
name="contact"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Contact
</a>
</h3>

Contacts store details about customers or individuals managed by the epilot organization.

<h3 id="account"><Icon name="account" size={28} style={{ position: 'relative', top: '4px' }} /> Account</h3>
<h3 id="account">
<a href="/api/customer#tag/account_schema">
<Icon
name="account"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Account
</a>
</h3>

Accounts store details about companies. Contacts can be linked to an account to represent a business customer.

<h3 id="partner"><Icon name="partner" size={28} style={{ position: 'relative', top: '4px' }} /> Partner</h3>
<h3 id="partner">
<a href="/api/partner#tag/partner_schema">
<Icon
name="partner"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Partner
</a>
</h3>

Partners store details about collaborating third parties, such as installation partners, OEMs and other business partners.

<h3 id="request"><Icon name="request" size={28} style={{ position: 'relative', top: '4px' }} /> Request</h3>
<h3 id="request">
<Icon name="request" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Request
</h3>

Requests store customer-initiated service requests or inquiries, usually submitted through contact forms or support channels.

## Sales

<h3 id="opportunity"><Icon name="opportunity" size={28} style={{ position: 'relative', top: '4px' }} /> Opportunity</h3>
<h3 id="opportunity">
<a href="/api/opportunity#tag/opportunity_schema">
<Icon
name="opportunity"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Opportunity
</a>
</h3>

Opportunities store details about sales leads or product inquiries usually made through journeys.

<h3 id="order"><Icon name="order" size={28} style={{ position: 'relative', top: '4px' }} /> Order</h3>
<h3 id="order">
<a href="/api/order#tag/order_schema">
<Icon name="order" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Order
</a>
</h3>

Orders store details about requested products, pricing and past orders placed by customers.

## Product Hub

<h3 id="product"><Icon name="product" size={28} style={{ position: 'relative', top: '4px' }} /> Product</h3>
<h3 id="product">
<a href="/api/product#tag/product_schema">
<Icon
name="product"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Product
</a>
</h3>

Products represent services or products sold by the epilot organization.

<h3 id="price"><Icon name="price" size={28} style={{ position: 'relative', top: '4px' }} /> Price</h3>
<h3 id="price">
<a href="/api/product#tag/price_schema">
<Icon name="price" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Price
</a>
</h3>

Prices configure the pricing models for products.

<h3 id="tax"><Icon name="tax" size={28} style={{ position: 'relative', top: '4px' }} /> Tax</h3>
<h3 id="tax">
<a href="/api/product#tag/tax_schema">
<Icon name="tax" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Tax
</a>
</h3>

Taxes represent the tax rates applied to prices.

<h3 id="coupon"><Icon name="calculator" size={28} style={{ position: 'relative', top: '4px' }} /> Coupon</h3>
<h3 id="coupon">
<a href="/api/pricing#tag/coupon_schema">
<Icon
name="calculator"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Coupon
</a>
</h3>

Coupons represent discounts or promotions that can be applied to products.

## Contracts

<h3 id="contract"><Icon name="contract" size={28} style={{ position: 'relative', top: '4px' }} /> Contract</h3>
<h3 id="contract">
<a href="/api/billing#tag/contract_schema">
<Icon
name="contract"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Contract
</a>
</h3>

Contracts store details about service agreements, tariffs and other agreements between customers and the epilot organization.

<h3 id="billing_event"><Icon name="entity" size={28} style={{ position: 'relative', top: '4px' }} /> Billing Event</h3>
<h3 id="billing_event">
<a href="/api/billing#tag/billing_event_schema">
<Icon
name="entity"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Billing Event
</a>
</h3>

Billing events store records of financial transactions, including payments, invoices, and credit notes.

<h3 id="meter"><Icon name="meter" size={28} style={{ position: 'relative', top: '4px' }} /> Meter</h3>
<h3 id="meter">
<a href="/api/metering#tag/meter_schema">
<Icon name="meter" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Meter
</a>
</h3>

Meters store details about power, gas or water or other devices used to meter consumption.

<h3 id="meter_counter"><Icon name="meter" size={28} style={{ position: 'relative', top: '4px' }} /> Meter Counter</h3>
<h3 id="meter_counter">
<a href="/api/metering#tag/meter_counter_schema">
<Icon name="meter" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
Meter Counter
</a>
</h3>

Meter counters represent the counters used in meter devices, allowing separate tracking for different consumption types or purposes, such as peak and off-peak energy usage.

## Journeys

<h3 id="journey"><Icon name="journey" size={28} style={{ position: 'relative', top: '4px' }} /> Journey</h3>
<h3 id="journey">
<a href="/api/journey#tag/journey_schema">
<Icon
name="journey"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Journey
</a>
</h3>

Journeys contain the configuration of a customer journey, which is used to collect data from customers.

<h3 id="submission"><Icon name="submission" size={28} style={{ position: 'relative', top: '4px' }} /> Submission</h3>
<h3 id="submission">
<a href="/api/submission#tag/submission_schema">
<Icon
name="submission"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Submission
</a>
</h3>

Submissions store raw data collected from Journeys or other outside data sources into epilot.

## Messaging

<h3 id="message"><Icon name="message" size={28} style={{ position: 'relative', top: '4px' }} /> Message</h3>
<h3 id="message">
<a href="/api/message#tag/message_schema">
<Icon
name="message"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Message
</a>
</h3>

Messages are email communications sent and received through the epilot platform.

<h3 id="thread"><Icon name="entity" size={28} style={{ position: 'relative', top: '4px' }} /> Thread</h3>
<h3 id="thread">
<a href="/api/message#tag/thread_schema">
<Icon
name="entity"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Thread
</a>
</h3>

Threads represent a conversation that groups multiple email messages together.

<h3 id="email_template"><Icon name="entity" size={28} style={{ position: 'relative', top: '4px' }} /> Email Template</h3>
<h3 id="email_template">
<a href="/api/email-template#tag/email_template_schema">
<Icon
name="entity"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Email Template
</a>
</h3>

Email templates are used as templates containing variables for emails sent from epilot.

## System

<h3 id="file"><Icon name="file" size={28} style={{ position: 'relative', top: '4px' }} /> File</h3>
<h3 id="file">
<a href="/api/file#tag/file_schema">
<Icon name="file" size={28} style={{ position: 'relative', top: '4px' }} />{' '}
File
</a>
</h3>

Files store details about documents, images, templates and other files uploaded to the epilot platform.

<h3 id="comment"><Icon name="comment" size={28} style={{ position: 'relative', top: '4px' }} /> Comment</h3>
<h3 id="comment">
<a href="/api/discussion#tag/comment_schema">
<Icon
name="comment"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Comment
</a>
</h3>

Comments allow users to add notes and have discussions across the platform.

<h3 id="portal_user"><Icon name="portal" size={28} style={{ position: 'relative', top: '4px' }} /> Portal User</h3>
<h3 id="portal_user">
<a href="/api/customer-portal#tag/portal_user_schema">
<Icon
name="portal"
size={28}
style={{ position: 'relative', top: '4px' }}
/>{' '}
Portal User
</a>
</h3>

Portal users are users registered to use end customer portals or installer portals.
Loading