Update real_time_scheduling description to include Dictionary format, while setting String format as deprecated

pycronofy/client.py

@@ -612,8 +612,13 @@ def real_time_scheduling(self, availability, oauth, event, target_calendars=(),
         :param list target_calendars: - An list of dics stating into which calendars
                                         to insert the created event
         :param dict :minimum_notice - A dict describing the minimum notice for a booking (Optional)
-        :param string :callback_url - A String representing the URL Cronofy will notify
+        (DEPRECATED) :param string :callback_url - A String representing the URL Cronofy will notify
                                       once a slot has been selected.
+        :param dict callback_url: - A dict containing redirect URLs for the end-user's journey
+            :completed_url         - A String representing the URL the end-user
+                                     will be redirected to after choosing a slot
+            :no_times_suitable_url - A String representing the URL the end-user
+                                     will be redirected if there is no available slots
         :param dict redirect_urls: - A dict containing redirect URLs for the end-user's journey
             :completed_url         - A String representing the URL the end-user
                                      will be redirected to after choosing a slot

pycronofy/tests/test_real_time_scheduling.py

@@ -120,6 +120,100 @@ def request_callback(request):
     assert result == REAL_TIME_SCHEDULING_RESPONSE
 
 
+@responses.activate
+def test_real_time_scheduling_when_callback_url_is_dictionary(client):
+    """Test Client.availability().
+
+    :param Client client: Client instance with test data.
+    """
+
+    def request_callback(request):
+        payload = json.loads(request.body)
+
+        availability = payload['availability']
+        assert availability['required_duration'] == {'minutes': 30}
+        assert availability['start_interval'] == {'minutes': 30}
+        assert availability['buffer']['before'] == {'minutes': 30}
+        assert availability['buffer']['after'] == {'minutes': 45}
+        assert availability['available_periods'] == [
+            {'start': '2017-01-03T09:00:00Z', 'end': '2017-01-03T18:00:00Z'},
+            {'start': '2017-01-04T09:00:00Z', 'end': '2017-01-04T18:00:00Z'}
+        ]
+        assert availability['participants'] == [
+            {
+                'required': 'all',
+                'members': [
+                    {'sub': 'acc_567236000909002'},
+                    {'sub': 'acc_678347111010113'}
+                ]
+            }
+        ]
+
+        assert payload['event'] == TEST_EVENT
+        assert payload['oauth'] == oauth
+        assert payload['minimum_notice'] == {'hours': 4}
+
+        assert payload['callback_url']['completed_url'] == 'http://www.example.com/callback'
+        assert payload['callback_url']['completed_url'] == 'http://www.example.com/callback'
+
+        assert payload['redirect_urls']['completed_url'] == 'http://www.example.com/completed'
+
+        assert request.headers['Authorization'] == "Bearer %s" % client.auth.client_secret
+
+        return (200, {}, json.dumps(REAL_TIME_SCHEDULING_RESPONSE))
+
+    responses.add_callback(
+        responses.POST,
+        url='%s/%s/real_time_scheduling' % (settings.API_BASE_URL, settings.API_VERSION),
+        callback=request_callback,
+        content_type='application/json',
+    )
+
+    periods = (
+        {'start': "2017-01-03T09:00:00Z", 'end': "2017-01-03T18:00:00Z"},
+        {'start': "2017-01-04T09:00:00Z", 'end': "2017-01-04T18:00:00Z"}
+    )
+    example_participants = ({
+        'members': [
+            "acc_567236000909002",
+            "acc_678347111010113",
+        ],
+    })
+
+    availability = {
+        'participants': example_participants,
+        'available_periods': periods,
+        'required_duration': 30,
+        'start_interval': 30,
+        'buffer': {
+            'before': 30,
+            'after': 45,
+        },
+    }
+
+    oauth = {
+        'scope': 'foo',
+        'redirect_uri': 'http://www.example.com',
+        'state': 'bar'
+    }
+
+    minimum_notice = {
+        'hours': 4
+    }
+
+    callback_url = {
+        'completed_url': 'http://www.example.com/callback',
+        'no_times_suitable_url': 'http://www.example.com/callback'
+    }
+
+    redirect_urls = {
+        'completed_url': 'http://www.example.com/completed'
+    }
+
+    result = client.real_time_scheduling(availability, oauth, TEST_EVENT, [], minimum_notice, callback_url=callback_url, redirect_urls=redirect_urls)
+    assert result == REAL_TIME_SCHEDULING_RESPONSE
+
+
 @responses.activate
 def test_get_real_time_scheduling_status_by_token(client):