Merge pull request #205 from tutorcruncher/update_api_docs_apt_filter

Update api docs appointment filter

Author: HenryTraill

pages/agents/agents.yml

@@ -17,7 +17,7 @@ sections:
     title: List all Agents
     id: list-all-agents
     description: /agents/list-all-agents.md
-    filters: /agents/agent-object.yml
+    filters: /agents/agent-object-v2.yml
     code: /agents/list-all-agents.py
     code_type: GET
     code_url: /api/agents/

pages/appointments/appointment-object.yml

@@ -173,6 +173,14 @@ filters:
     name: recipient
     type: integer
     description: Filter by the Appointment's linked Student (id).
+  -
+    name: client
+    type: integer
+    description: Filter by the Appointment's linked Client (id).
+  -
+    name: status
+    type: string
+    description: Filter by the Appointment's status (string).
   -
     name: location
     type: integer

pages/clients/clients.yml

@@ -17,7 +17,7 @@ sections:
     title: List all Clients
     id: list-all-clients
     description: /clients/list-all-clients.md
-    filters: /clients/client-object.yml
+    filters: /clients/client-object-v2.yml
     code: /clients/list-all-clients.py
     code_type: GET
     code_url: /api/clients/

pages/contractors/contractors.yml

@@ -17,7 +17,7 @@ sections:
     title: List all Contractors
     id: list-all-contractors
     description: /contractors/list-all-contractors.md
-    filters: /contractors/contractor-object.yml
+    filters: /contractors/contractor-object-v2.yml
     code: /contractors/list-all-contractors.py
     code_type: GET
     code_url: /api/contractors/

pages/proforma-invoices/proforma-invoice-object.yml

@@ -102,3 +102,19 @@ attributes:
     name: still_to_pay
     type: decimal
     description: Amount of the Proforma Invoice that still needs to be payed.
+  -
+    name: description
+    type: string
+    description: Description for the Proforma Invoice item (required for creation).
+  -
+    name: send_pfi
+    type: boolean
+    description: |
+      (Deprecated - use raise_behaviour instead) Send the PFI as well as creating it. Default is false.
+  -
+    name: raise_behaviour
+    type: string
+    description: |
+      Raise behavior when creating a Proforma Invoice. Choices are `dont-raise` (default), `raise`, or `raise-and-send`. 
+      If `dont-raise` is used, the PFI will be created but not sent. If `raise` is used, the PFI will be created and staged. 
+      If `raise-and-send` is used, the PFI will be created, staged, and sent to the client.

pages/recipients/recipients.yml

@@ -17,7 +17,7 @@ sections:
     title: List all Recipients
     id: list-all-recipients
     description: /recipients/list-all-recipients.md
-    filters: /recipients/recipient-object.yml
+    filters: /recipients/recipient-object-v2.yml
     code: /recipients/list-all-recipients.py
     code_type: GET
     code_url: /api/recipients/