Skip to content

Commit 8367de8

Browse files
perrito666bketelsen
authored andcommitted
Add detailed description for types
Following brian's PR on docs I added a similar section besides the one describing in detail.
1 parent 25cccaa commit 8367de8

File tree

1 file changed

+83
-6
lines changed

1 file changed

+83
-6
lines changed

def/README.ticketing.md renamed to docs/ticketing.md

+83-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,83 @@
1-
# Ticketing The Agony and the Ecstasy of Event planning.
1+
# Definitions
22

3-
### Capacity and stock
3+
## Event Slot
4+
5+
An slot in an event for an activity such as general track attendance, workshop, etc.
6+
7+
### Attributes
8+
9+
* Name
10+
* Description
11+
* Cost (in amount of dollars)
12+
* Capacity (in amount of humans)
13+
* Start Date
14+
* End Date
15+
* Purchseable From
16+
* Purchaseable Until
17+
* Available to public (displayed on the ticket buying page)
18+
19+
* Depends on (another slot)
20+
21+
## Slot Claim
22+
23+
A slot claim is a claim from an attendee to a place in an activity.
24+
25+
### Attributes
26+
27+
* Event Slot (the aforementioned Event Slots)
28+
* Ticket ID
29+
* Redeemed
30+
31+
## Attendee
32+
33+
An attendee is a person attending an event.
34+
35+
### Attributes
36+
37+
* Email
38+
* CoC Accepted
39+
* Claims (a list of the slot claims for this attendee)
40+
41+
## Claim Payment
42+
43+
A Claim payment represents payment for one or more Slot Claims
44+
45+
### Attributes
46+
47+
* Claims Payed (which slot claims are payed by this payment)
48+
* Payment (various payments to cover total are accepted)
49+
* Invoice
50+
51+
## Payment Method Money
52+
53+
A Payment Method Money item is a payment in credit card.
54+
55+
### Attributes
56+
57+
* Payment Reference (to our payment processor)
58+
* Amount
59+
60+
## Payment Method Discount
61+
62+
A Payment Method Discount item is a discount issued by the orgaization to an attendee for a claim
63+
64+
### Attributes
65+
66+
* Description
67+
* Amount
68+
69+
## Payment Method Credit Note
70+
71+
A Payment Method Credit Note item is a note of credit issued by the orgaization to an attendee for a claim
72+
73+
### Attributes
74+
75+
* Description
76+
* Amount
77+
78+
# Usage
79+
80+
## Capacity and stock
481

582
The entry point for thi model are `EventSlot` items, one of these specifies Slot of Event time for which we ask an admitance ticket, these can overlap, for instance **General Admitance** Will be required to enter the general meeting area of one Event and it is a precondition to be able to obtain a **Free Workshop Ticket** which grants participation to a worhkshop that happens in the same time frame as the general event for which we granted admittance.
683

@@ -12,7 +89,7 @@ The entry point for thi model are `EventSlot` items, one of these specifies Slot
1289
* 100 Regular Tickets, Cost 4U$D, Sold from March to August, available to public and valid to redeem from 1st to last day of the conference
1390
* 50 Sponsor Tickets, Cost 0U$D, Sold from January to August, not available to public and valid to redeem from 1st to last day of the conference
1491

15-
### Actors
92+
## Actors
1693

1794
Our main actor is the `Attendee` which is a human being (or entity? entity rep?) that will buy and optionally use these Slot tickets (they could buy and transfer or just be a sponsor representative and transfer the tickets to their employees assisting the `Event`)
1895

@@ -29,7 +106,7 @@ Redeeming a ticket requires 3 piece of Information:
29106
* Said attendee having accepted a Code of Conduct.
30107
* The ticket (or tickets) claimed by the attendee.
31108

32-
### The vile metal
109+
## The vile metal
33110

34111
Events cost money and so we need to charge admittance to them.
35112

@@ -48,7 +125,7 @@ Currently we have the following `FinancialInstrument`:
48125
* Credit (`PaymentMethodCreditNote`) this is, in few words, a debt from the attendee to the event. Typically this is used when invoicing needs to happen before the payment i processed (like with large corporation sponsors).
49126
* Discount (`PaymentMethodConferenceDiscount`) the event organizer can discount the price of an item by giving someone scholarships or benefits or whatever kind of discount in a `SlotClaim`
50127

51-
#### Balances
128+
### Balances
52129

53130
A couple of simplifications were added as sample operations to our use of money.
54131

@@ -59,7 +136,7 @@ A couple of simplifications were added as sample operations to our use of money.
59136

60137
A `ClaimPayment` is `Fulfulled` when `DebtBalanced` and `PaymentBalanced` of `ClaimPayment.Total()` are true.
61138

62-
#### Invoices
139+
### Invoices
63140

64141
Invoces will be generated by... something, which we do not know, if it has an API and returns references, all the best.
65142

0 commit comments

Comments
 (0)