Update docs for Roles V2 (#188)

* Update all docs to match v2 & add versioning

* Add delete docs

* get actions

* update labels to v2

* Doc extras

* Actions

* Remove PUT & PATCH

* dans comments

Author: HenryTraill

data/actions.json

@@ -931,6 +931,13 @@
     "help_text": "When an Administrator updates the Terms and Conditions.",
     "subject_types": []
   },
+  {
+    "key": "CONFIRMED_AGENCY_EMAIL",
+    "value": "CONFIRMED_AGENCY_EMAIL",
+    "msg": "Confirmed Company Email",
+    "help_text": "When a Company confirms their email address.",
+    "subject_types": []
+  },
   {
     "key": "CREATED_AGENCY",
     "value": "CREATED_AGENCY",

pages/adhoccharges/ad-hoc-charge-object.json

@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",

pages/adhoccharges/ad-hoc-charge-object.yml

@@ -87,10 +87,6 @@ attributes:
         name: branch_tax_setup
         type: string
         description: Tax setup for the Branch when invoicing.
-      -
-        name: charge_via_branch
-        type: boolean
-        description: Force Invoices associated with this Tutor to be charged via branch.
       -
         name: contractor_tax_setup
         type: string

pages/adhoccharges/create-an-ad-hoc-charge.json

@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",

pages/adhoccharges/get-an-ad-hoc-charge.json

@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",

pages/adhoccharges/update-an-ad-hoc-charge.json

@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",

pages/agents/agent-object.json renamed to pages/agents/agent-object-v1.json

@@ -0,0 +1,4 @@
+### Agent Object (Version 1 - Will be deprecated 3rd July 2025)
+
+Agent objects, Affiliates in TutorCruncher, includes basic user information including fields that are only linked to the Agent Role. 
+It includes details about affiliated Clients, `clients`, and their `commission_rate`.

pages/agents/agent-object-v1.md

@@ -130,23 +130,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Agent's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Agent's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Agent's email address.
   -
@@ -164,4 +164,4 @@ filters:
   -
     name: labels
     type: integer
-    description: Filter by the Agent's labels.
+    description: Filter by the Agent's labels (id).

pages/agents/agent-object.yml renamed to pages/agents/agent-object-v1.yml

@@ -0,0 +1,24 @@
+{
+  "id": 65,
+  "title": null,
+  "first_name": "Billy",
+  "last_name": "Holiday",
+  "email": "[email protected]",
+  "mobile": "07123 456 789",
+  "phone": "0208 123 4567",
+  "street": "8 Albert Road",
+  "state": null,
+  "town": "London",
+  "country": "United Kingdom (GB)",
+  "postcode": "E80 1FA",
+  "latitude": "51.5373258999999990",
+  "longitude": "-0.1496343000000000",
+  "date_created": "2020-02-18T16:13:04.193340Z",
+  "timezone": "Europe/London"
+  "commission_rate": null,
+  "clients": [],
+  "last_updated": "2020-03-16T12:23:39.056867Z",
+  "calendar_colour": "Brown",
+  "labels": [],
+  "extra_attrs": []
+}