Skip to content

Commit e42c1a7

Browse files
committed
Update commissions variable schema, add fields to commission variable schema
1 parent b29fbb9 commit e42c1a7

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,20 @@ Session Example:
191191
{
192192
id: 'unique-commission-id', // Unique identifier for the commission
193193
user: 'userId', // Commission creator's unique userId. Should match the userId variable, otherwise the commission will only be accessible in admin/dev views
194-
amount: 1000, // Commission amount, or null if not applicable
195-
currency: 'USD', // Currency code for the commission amount
196-
date: '2023-10-01', // Date of the commission
197-
status: 'pending', // Status of the commission ('completed', 'in-progress', 'on-hold', 'cancelled')
194+
amount: 1000, // Commission amount as a number, or null if not applicable. Defaults to null
195+
currency: 'USD', // Currency code for the commission amount as a string. Defaults to 'USD'
196+
date: '2023-10-01', // Date of the commission in any valid date/datetime format. Defaults to null
197+
status: 'in-progress', // Status of the commission ('completed', 'in-progress', 'on-hold', 'cancelled')
198+
fields: { // Custom fields associated with the commission
199+
'id': 'value' // Key-value pairs for custom fields
200+
},
198201
tasks: [ // Array of tasks associated with the commission
199202
{
200-
done: false, // Task completion status
201-
content: '' // Task description
203+
done: false, // Task completion status. Defaults to false
204+
content: '' // Task description. Defaults to ''
202205
}
203206
],
204-
tasksLocked: false // Whether tasks are locked from being edited by user
207+
locked: false // Whether commission is locked from being edited by user. Defaults to false
205208
}
206209
]
207210
```

0 commit comments

Comments
 (0)