55< html xmlns ="http://www.w3.org/1999/xhtml ">
66 < head >
77 < meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
8- < title > contentful.client — Contentful 1.6 .0 documentation</ title >
8+ < title > contentful.client — Contentful 1.7 .0 documentation</ title >
99 < link rel ="stylesheet " href ="../../_static/alabaster.css " type ="text/css " />
1010 < link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
1111 < script type ="text/javascript ">
1212 var DOCUMENTATION_OPTIONS = {
1313 URL_ROOT : '../../' ,
14- VERSION : '1.6 .0' ,
14+ VERSION : '1.7 .0' ,
1515 COLLAPSE_INDEX : false ,
1616 FILE_SUFFIX : '.html' ,
1717 HAS_SOURCE : true ,
@@ -42,7 +42,8 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
4242< span > </ span > < span class ="kn "> import</ span > < span class ="nn "> requests</ span >
4343< span class ="kn "> import</ span > < span class ="nn "> platform</ span >
4444< span class ="kn "> from</ span > < span class ="nn "> re</ span > < span class ="k "> import</ span > < span class ="n "> sub</ span >
45- < span class ="kn "> from</ span > < span class ="nn "> .utils</ span > < span class ="k "> import</ span > < span class ="n "> ConfigurationException</ span > < span class ="p "> ,</ span > < span class ="n "> retry_request</ span > < span class ="p "> ,</ span > < span class ="n "> string_class</ span >
45+ < span class ="kn "> from</ span > < span class ="nn "> .utils</ span > < span class ="k "> import</ span > < span class ="n "> ConfigurationException</ span > < span class ="p "> ,</ span > < span class ="n "> NotSupportedException</ span >
46+ < span class ="kn "> from</ span > < span class ="nn "> .utils</ span > < span class ="k "> import</ span > < span class ="n "> retry_request</ span > < span class ="p "> ,</ span > < span class ="n "> string_class</ span >
4647< span class ="kn "> from</ span > < span class ="nn "> .errors</ span > < span class ="k "> import</ span > < span class ="n "> get_error</ span > < span class ="p "> ,</ span > < span class ="n "> RateLimitExceededError</ span > < span class ="p "> ,</ span > < span class ="n "> EntryNotFoundError</ span >
4748< span class ="kn "> from</ span > < span class ="nn "> .resource_builder</ span > < span class ="k "> import</ span > < span class ="n "> ResourceBuilder</ span >
4849< span class ="kn "> from</ span > < span class ="nn "> .content_type_cache</ span > < span class ="k "> import</ span > < span class ="n "> ContentTypeCache</ span >
@@ -73,6 +74,8 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
7374< span class ="sd "> :param api_version: (optional) Target version of the Contentful API.</ span >
7475< span class ="sd "> :param default_locale: (optional) Default Locale for your Space,</ span >
7576< span class ="sd "> defaults to 'en-US'.</ span >
77+ < span class ="sd "> :param environment: (optional) Default Environment for client, defaults</ span >
78+ < span class ="sd "> to 'master'.</ span >
7679< span class ="sd "> :param https: (optional) Boolean determining wether to use https</ span >
7780< span class ="sd "> or http, defaults to True.</ span >
7881< span class ="sd "> :param authorization_as_header: (optional) Boolean determining wether</ span >
@@ -120,6 +123,7 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
120123 < span class ="n "> api_url</ span > < span class ="o "> =</ span > < span class ="s1 "> 'cdn.contentful.com'</ span > < span class ="p "> ,</ span >
121124 < span class ="n "> api_version</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span >
122125 < span class ="n "> default_locale</ span > < span class ="o "> =</ span > < span class ="s1 "> 'en-US'</ span > < span class ="p "> ,</ span >
126+ < span class ="n "> environment</ span > < span class ="o "> =</ span > < span class ="s1 "> 'master'</ span > < span class ="p "> ,</ span >
123127 < span class ="n "> https</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
124128 < span class ="n "> authorization_as_header</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
125129 < span class ="n "> raw_mode</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
@@ -142,6 +146,7 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
142146 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> api_url</ span > < span class ="o "> =</ span > < span class ="n "> api_url</ span >
143147 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> api_version</ span > < span class ="o "> =</ span > < span class ="n "> api_version</ span >
144148 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> default_locale</ span > < span class ="o "> =</ span > < span class ="n "> default_locale</ span >
149+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment</ span > < span class ="o "> =</ span > < span class ="n "> environment</ span >
145150 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> https</ span > < span class ="o "> =</ span > < span class ="n "> https</ span >
146151 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> authorization_as_header</ span > < span class ="o "> =</ span > < span class ="n "> authorization_as_header</ span >
147152 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> raw_mode</ span > < span class ="o "> =</ span > < span class ="n "> raw_mode</ span >
@@ -197,7 +202,9 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
197202< span class ="sd "> """</ span >
198203
199204 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
200- < span class ="s1 "> '/content_types/</ span > < span class ="si "> {0}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> content_type_id</ span > < span class ="p "> ),</ span >
205+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment_url</ span > < span class ="p "> (</ span >
206+ < span class ="s1 "> '/content_types/</ span > < span class ="si "> {0}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> content_type_id</ span > < span class ="p "> )</ span >
207+ < span class ="p "> ),</ span >
201208 < span class ="n "> query</ span >
202209 < span class ="p "> )</ span > </ div >
203210
@@ -219,7 +226,7 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
219226< span class ="sd "> """</ span >
220227
221228 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
222- < span class ="s1 "> '/content_types'</ span > < span class ="p "> ,</ span >
229+ < span class ="bp " > self </ span > < span class =" o " > . </ span > < span class =" n " > environment_url </ span > < span class =" p " > ( </ span > < span class =" s1 "> '/content_types'</ span > < span class ="p "> ) ,</ span >
223230 < span class ="n "> query</ span >
224231 < span class ="p "> )</ span > </ div >
225232
@@ -245,7 +252,7 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
245252 < span class ="k "> try</ span > < span class ="p "> :</ span >
246253 < span class ="n "> query</ span > < span class ="o "> .</ span > < span class ="n "> update</ span > < span class ="p "> ({</ span > < span class ="s1 "> 'sys.id'</ span > < span class ="p "> :</ span > < span class ="n "> entry_id</ span > < span class ="p "> })</ span >
247254 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
248- < span class ="s1 "> '/entries'</ span > < span class ="p "> ,</ span >
255+ < span class ="bp " > self </ span > < span class =" o " > . </ span > < span class =" n " > environment_url </ span > < span class =" p " > ( </ span > < span class =" s1 "> '/entries'</ span > < span class ="p "> ) ,</ span >
249256 < span class ="n "> query</ span >
250257 < span class ="p "> )[</ span > < span class ="mi "> 0</ span > < span class ="p "> ]</ span >
251258 < span class ="k "> except</ span > < span class ="ne "> IndexError</ span > < span class ="p "> :</ span >
@@ -281,7 +288,7 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
281288 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _normalize_select</ span > < span class ="p "> (</ span > < span class ="n "> query</ span > < span class ="p "> )</ span >
282289
283290 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
284- < span class ="s1 "> '/entries'</ span > < span class ="p "> ,</ span >
291+ < span class ="bp " > self </ span > < span class =" o " > . </ span > < span class =" n " > environment_url </ span > < span class =" p " > ( </ span > < span class =" s1 "> '/entries'</ span > < span class ="p "> ) ,</ span >
285292 < span class ="n "> query</ span >
286293 < span class ="p "> )</ span > </ div >
287294
@@ -301,7 +308,9 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
301308< span class ="sd "> """</ span >
302309
303310 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
304- < span class ="s1 "> '/assets/</ span > < span class ="si "> {0}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> asset_id</ span > < span class ="p "> ),</ span >
311+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment_url</ span > < span class ="p "> (</ span >
312+ < span class ="s1 "> '/assets/</ span > < span class ="si "> {0}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> asset_id</ span > < span class ="p "> )</ span >
313+ < span class ="p "> ),</ span >
305314 < span class ="n "> query</ span >
306315 < span class ="p "> )</ span > </ div >
307316
@@ -327,7 +336,30 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
327336 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _normalize_select</ span > < span class ="p "> (</ span > < span class ="n "> query</ span > < span class ="p "> )</ span >
328337
329338 < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
330- < span class ="s1 "> '/assets'</ span > < span class ="p "> ,</ span >
339+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment_url</ span > < span class ="p "> (</ span > < span class ="s1 "> '/assets'</ span > < span class ="p "> ),</ span >
340+ < span class ="n "> query</ span >
341+ < span class ="p "> )</ span > </ div >
342+
343+ < div class ="viewcode-block " id ="Client.locales "> < a class ="viewcode-back " href ="../../contentful.html#contentful.client.Client.locales "> [docs]</ a > < span class ="k "> def</ span > < span class ="nf "> locales</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> query</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
344+ < span class ="sd "> """Fetches all Locales from the Environment (up to the set limit, can be modified in `query`).</ span >
345+
346+ < span class ="sd "> # TODO: fix url</ span >
347+ < span class ="sd "> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets/assets-collection/get-all-assets-of-a-space</ span >
348+
349+ < span class ="sd "> :param query: (optional) Dict with API options.</ span >
350+ < span class ="sd "> :return: List of :class:`Locale <contentful.locale.Locale>` objects.</ span >
351+ < span class ="sd "> :rtype: List of contentful.locale.Locale</ span >
352+
353+ < span class ="sd "> Usage:</ span >
354+ < span class ="sd "> >>> locales = client.locales()</ span >
355+ < span class ="sd "> [<Locale[English (United States)] code='en-US' default=True fallback_code=None optional=False>]</ span >
356+ < span class ="sd "> """</ span >
357+
358+ < span class ="k "> if</ span > < span class ="n "> query</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
359+ < span class ="n "> query</ span > < span class ="o "> =</ span > < span class ="p "> {}</ span >
360+
361+ < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _get</ span > < span class ="p "> (</ span >
362+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment_url</ span > < span class ="p "> (</ span > < span class ="s1 "> '/locales'</ span > < span class ="p "> ),</ span >
331363 < span class ="n "> query</ span >
332364 < span class ="p "> )</ span > </ div >
333365
@@ -345,6 +377,9 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
345377< span class ="sd "> <SyncPage next_sync_token='w5ZGw6JFwqZmVcKsE8Kow4grw45QdybC...'></ span >
346378< span class ="sd "> """</ span >
347379
380+ < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment</ span > < span class ="o "> !=</ span > < span class ="s1 "> 'master'</ span > < span class ="p "> :</ span >
381+ < span class ="k "> raise</ span > < span class ="n "> NotSupportedException</ span > < span class ="p "> (</ span > < span class ="s1 "> 'The sync endpoint is only available for the master environment.'</ span > < span class ="p "> )</ span >
382+
348383 < span class ="k "> if</ span > < span class ="n "> query</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
349384 < span class ="n "> query</ span > < span class ="o "> =</ span > < span class ="p "> {}</ span >
350385 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _normalize_sync</ span > < span class ="p "> (</ span > < span class ="n "> query</ span > < span class ="p "> )</ span >
@@ -354,6 +389,14 @@ <h1>Source code for contentful.client</h1><div class="highlight"><pre>
354389 < span class ="n "> query</ span >
355390 < span class ="p "> )</ span > </ div >
356391
392+ < div class ="viewcode-block " id ="Client.environment_url "> < a class ="viewcode-back " href ="../../contentful.html#contentful.client.Client.environment_url "> [docs]</ a > < span class ="k "> def</ span > < span class ="nf "> environment_url</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> url</ span > < span class ="p "> ):</ span >
393+ < span class ="sd "> """Formats the URL with the environment."""</ span >
394+
395+ < span class ="k "> return</ span > < span class ="s2 "> "/environments/</ span > < span class ="si "> {0}{1}</ span > < span class ="s2 "> "</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span >
396+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> environment</ span > < span class ="p "> ,</ span >
397+ < span class ="n "> url</ span >
398+ < span class ="p "> )</ span > </ div >
399+
357400 < span class ="k "> def</ span > < span class ="nf "> _normalize_select</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> query</ span > < span class ="p "> ):</ span >
358401 < span class ="sd "> """</ span >
359402< span class ="sd "> If the query contains the :select operator, we enforce :sys properties.</ span >
0 commit comments