add distance filter section

Author: PrenSJ2

pages/api.yml

@@ -16,6 +16,10 @@ info_sections:
     title: Creating/Updating Users
     id: creating-updating-users
     layout: /creating-updating-users/creating-updating-users.yml
+  -
+    title: Distance Filter on User Lists
+    id: distance-filter
+    layout: /distance-filter/distance-filter.yml
   -
     title: Custom Fields
     id: custom-fields

pages/contractors/contractor-object.yml

@@ -229,11 +229,11 @@ filters:
     type: string
     description: Filter by the Contractor's status.
   -
-    name: address
+    name: distance_address
     type: string
     description: Filter by the address.
   -
-    name: radius
+    name: distance_radius
     type: integer
     description: Filter by the radius of the address. This is used in conjunction with the `address` filter.
   -

pages/distance-filter/distance-filter-object.yml

@@ -0,0 +1,10 @@
+attributes:
+  -
+    name: distance
+    type: string
+    description: A URL-encoded string representing the starting location for the search. This must be specific (e.g., including city, postal code, and country) for accurate results. Ensure the address is properly encoded, where spaces are replaced with `%20`, commas with `%2C`, and other special characters are handled accordingly.
+  -
+    name: radius
+    type: integer
+    description: The radius in kilometers around the distance_address to filter users. Users outside this radius will not be included.
+

pages/distance-filter/distance-filter.md

@@ -0,0 +1,2 @@
+[Agents](#agents), [Clients](#clients), [Contractors](#contractors), [Recipients](#recipients) can be filtered based on their proximity 
+to a specific location using the distance_address and distance_radius parameters.

pages/distance-filter/distance-filter.py

@@ -0,0 +1,12 @@
+import pprint
+import requests
+
+headers = {'Authorization': 'token <API KEY>'}
+url = (
+    'https://secure.tutorcruncher.com/api/contractors/'
+    '?distance_address=The%20Food%20Exchange%2C%20New%20Covent%20Garden%20Market%2C%20Nine%20Elms%2C%20London%20SW8%205EL%2C%20ENGLAND'
+    '&distance_radius=1'
+)
+response = requests.get(url, headers=headers)
+pprint.pprint(response.json())
+

pages/distance-filter/distance-filter.yml

@@ -0,0 +1,6 @@
+sections:
+  -
+    description: /distance-filter/distance-filter.md
+    code: /distance-filter/distance-filter.py
+    attributes: /distance-filter/distance-filter-object.yml
+    code_type: POST