contentful 2.12.0 → 2.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +69 -1
  3. data/README.md +24 -13
  4. data/lib/contentful/array.rb +14 -6
  5. data/lib/contentful/array_like.rb +11 -2
  6. data/lib/contentful/asset.rb +10 -4
  7. data/lib/contentful/base_resource.rb +29 -6
  8. data/lib/contentful/client.rb +4 -3
  9. data/lib/contentful/coercions.rb +1 -4
  10. data/lib/contentful/entry.rb +9 -5
  11. data/lib/contentful/fields_resource.rb +7 -11
  12. data/lib/contentful/includes.rb +74 -0
  13. data/lib/contentful/request.rb +6 -1
  14. data/lib/contentful/resource_builder.rb +15 -12
  15. data/lib/contentful/support.rb +0 -35
  16. data/lib/contentful/version.rb +1 -1
  17. metadata +15 -370
  18. data/.gitignore +0 -7
  19. data/.rspec +0 -1
  20. data/.rubocop.yml +0 -28
  21. data/.rubocop_todo.yml +0 -35
  22. data/.travis.yml +0 -13
  23. data/.yardopts +0 -4
  24. data/Gemfile +0 -9
  25. data/Gemfile.lock +0 -152
  26. data/Guardfile +0 -24
  27. data/RELEASE.md +0 -8
  28. data/Rakefile +0 -33
  29. data/contentful.gemspec +0 -44
  30. data/coverage/.last_run.json +0 -5
  31. data/coverage/.resultset.json +0 -2419
  32. data/coverage/.resultset.json.lock +0 -0
  33. data/coverage/assets/0.10.2/application.css +0 -799
  34. data/coverage/assets/0.10.2/application.js +0 -1707
  35. data/coverage/assets/0.10.2/colorbox/border.png +0 -0
  36. data/coverage/assets/0.10.2/colorbox/controls.png +0 -0
  37. data/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
  38. data/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
  39. data/coverage/assets/0.10.2/favicon_green.png +0 -0
  40. data/coverage/assets/0.10.2/favicon_red.png +0 -0
  41. data/coverage/assets/0.10.2/favicon_yellow.png +0 -0
  42. data/coverage/assets/0.10.2/loading.gif +0 -0
  43. data/coverage/assets/0.10.2/magnify.png +0 -0
  44. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  45. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  46. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  47. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  48. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  49. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  50. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  51. data/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  52. data/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
  53. data/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
  54. data/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
  55. data/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
  56. data/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
  57. data/coverage/index.html +0 -15071
  58. data/doc/Contentful/AccessDenied.html +0 -159
  59. data/doc/Contentful/Array.html +0 -765
  60. data/doc/Contentful/ArrayCoercion.html +0 -242
  61. data/doc/Contentful/ArrayLike.html +0 -625
  62. data/doc/Contentful/Asset.html +0 -487
  63. data/doc/Contentful/BadGateway.html +0 -159
  64. data/doc/Contentful/BadRequest.html +0 -159
  65. data/doc/Contentful/BaseCoercion.html +0 -445
  66. data/doc/Contentful/BaseResource.html +0 -599
  67. data/doc/Contentful/BooleanCoercion.html +0 -242
  68. data/doc/Contentful/Client.html +0 -1740
  69. data/doc/Contentful/ContentType.html +0 -618
  70. data/doc/Contentful/ContentTypeCache.html +0 -428
  71. data/doc/Contentful/DateCoercion.html +0 -244
  72. data/doc/Contentful/DeletedAsset.html +0 -157
  73. data/doc/Contentful/DeletedEntry.html +0 -157
  74. data/doc/Contentful/EmptyFieldError.html +0 -217
  75. data/doc/Contentful/Entry.html +0 -334
  76. data/doc/Contentful/Error.html +0 -410
  77. data/doc/Contentful/Field.html +0 -936
  78. data/doc/Contentful/FieldsResource.html +0 -583
  79. data/doc/Contentful/File.html +0 -218
  80. data/doc/Contentful/FloatCoercion.html +0 -238
  81. data/doc/Contentful/IntegerCoercion.html +0 -238
  82. data/doc/Contentful/Link.html +0 -249
  83. data/doc/Contentful/LinkCoercion.html +0 -158
  84. data/doc/Contentful/Locale.html +0 -537
  85. data/doc/Contentful/Location.html +0 -383
  86. data/doc/Contentful/LocationCoercion.html +0 -238
  87. data/doc/Contentful/NotFound.html +0 -159
  88. data/doc/Contentful/ObjectCoercion.html +0 -238
  89. data/doc/Contentful/RateLimitExceeded.html +0 -346
  90. data/doc/Contentful/Request.html +0 -887
  91. data/doc/Contentful/ResourceBuilder.html +0 -978
  92. data/doc/Contentful/ResourceReferences.html +0 -254
  93. data/doc/Contentful/Response.html +0 -710
  94. data/doc/Contentful/RichTextCoercion.html +0 -238
  95. data/doc/Contentful/ServerError.html +0 -159
  96. data/doc/Contentful/ServiceUnavailable.html +0 -159
  97. data/doc/Contentful/Space.html +0 -393
  98. data/doc/Contentful/StringCoercion.html +0 -242
  99. data/doc/Contentful/StructuredTextCoercion.html +0 -238
  100. data/doc/Contentful/Support.html +0 -788
  101. data/doc/Contentful/SymbolCoercion.html +0 -169
  102. data/doc/Contentful/Sync.html +0 -653
  103. data/doc/Contentful/SyncPage.html +0 -807
  104. data/doc/Contentful/TextCoercion.html +0 -169
  105. data/doc/Contentful/Unauthorized.html +0 -159
  106. data/doc/Contentful/UnparsableJson.html +0 -159
  107. data/doc/Contentful/UnparsableResource.html +0 -135
  108. data/doc/Contentful.html +0 -157
  109. data/doc/_index.html +0 -563
  110. data/doc/class_list.html +0 -51
  111. data/doc/css/common.css +0 -1
  112. data/doc/css/full_list.css +0 -58
  113. data/doc/css/style.css +0 -496
  114. data/doc/file.CHANGELOG.html +0 -729
  115. data/doc/file.LICENSE.html +0 -70
  116. data/doc/file.README.html +0 -925
  117. data/doc/file_list.html +0 -66
  118. data/doc/frames.html +0 -17
  119. data/doc/index.html +0 -925
  120. data/doc/js/app.js +0 -292
  121. data/doc/js/full_list.js +0 -216
  122. data/doc/js/jquery.js +0 -4
  123. data/doc/method_list.html +0 -1171
  124. data/doc/top-level-namespace.html +0 -110
  125. data/examples/custom_classes.rb +0 -39
  126. data/examples/example_queries.rb +0 -26
  127. data/examples/raise_errors.rb +0 -20
  128. data/examples/raw_mode.rb +0 -14
  129. data/spec/array_spec.rb +0 -122
  130. data/spec/asset_spec.rb +0 -192
  131. data/spec/auto_includes_spec.rb +0 -12
  132. data/spec/client_class_spec.rb +0 -86
  133. data/spec/client_configuration_spec.rb +0 -377
  134. data/spec/content_type_spec.rb +0 -49
  135. data/spec/deleted_asset_spec.rb +0 -38
  136. data/spec/deleted_entry_spec.rb +0 -38
  137. data/spec/entry_spec.rb +0 -688
  138. data/spec/error_class_spec.rb +0 -327
  139. data/spec/error_requests_spec.rb +0 -87
  140. data/spec/field_spec.rb +0 -95
  141. data/spec/file_spec.rb +0 -33
  142. data/spec/fixtures/json_responses/400_details_errors_object.json +0 -14
  143. data/spec/fixtures/json_responses/400_details_errors_string.json +0 -12
  144. data/spec/fixtures/json_responses/400_details_string.json +0 -8
  145. data/spec/fixtures/json_responses/403_reasons.json +0 -13
  146. data/spec/fixtures/json_responses/404_details_string.json +0 -8
  147. data/spec/fixtures/json_responses/404_id.json +0 -11
  148. data/spec/fixtures/json_responses/404_sys_type.json +0 -12
  149. data/spec/fixtures/json_responses/404_type.json +0 -10
  150. data/spec/fixtures/json_responses/content_type.json +0 -83
  151. data/spec/fixtures/json_responses/default_400.json +0 -7
  152. data/spec/fixtures/json_responses/default_401.json +0 -7
  153. data/spec/fixtures/json_responses/default_403.json +0 -7
  154. data/spec/fixtures/json_responses/default_404.json +0 -7
  155. data/spec/fixtures/json_responses/default_429.json +0 -7
  156. data/spec/fixtures/json_responses/default_500.json +0 -7
  157. data/spec/fixtures/json_responses/default_502.json +0 -7
  158. data/spec/fixtures/json_responses/default_503.json +0 -7
  159. data/spec/fixtures/json_responses/includes.json +0 -111
  160. data/spec/fixtures/json_responses/link_array.json +0 -43
  161. data/spec/fixtures/json_responses/not_found.json +0 -13
  162. data/spec/fixtures/json_responses/nyancat.json +0 -48
  163. data/spec/fixtures/json_responses/other_error.json +0 -9
  164. data/spec/fixtures/json_responses/other_error_no_details.json +0 -8
  165. data/spec/fixtures/json_responses/other_error_no_message.json +0 -8
  166. data/spec/fixtures/json_responses/other_error_no_request_id.json +0 -8
  167. data/spec/fixtures/json_responses/other_error_nothing.json +0 -6
  168. data/spec/fixtures/json_responses/self_link.json +0 -82
  169. data/spec/fixtures/json_responses/unparsable.json +0 -13
  170. data/spec/fixtures/vcr_cassettes/array/marshal_custom_classes.yml +0 -159
  171. data/spec/fixtures/vcr_cassettes/array/nested_resources.yml +0 -159
  172. data/spec/fixtures/vcr_cassettes/array.yml +0 -288
  173. data/spec/fixtures/vcr_cassettes/arrayField.yml +0 -87
  174. data/spec/fixtures/vcr_cassettes/array_page_1.yml +0 -106
  175. data/spec/fixtures/vcr_cassettes/array_page_2.yml +0 -73
  176. data/spec/fixtures/vcr_cassettes/asset/select_empty_array.yml +0 -104
  177. data/spec/fixtures/vcr_cassettes/asset/select_no_sys.yml +0 -119
  178. data/spec/fixtures/vcr_cassettes/asset/select_one_field.yml +0 -97
  179. data/spec/fixtures/vcr_cassettes/asset/select_only_sys.yml +0 -88
  180. data/spec/fixtures/vcr_cassettes/asset.yml +0 -96
  181. data/spec/fixtures/vcr_cassettes/assets/issues_129.yml +0 -90
  182. data/spec/fixtures/vcr_cassettes/assets/issues_jekyll_46.yml +0 -115
  183. data/spec/fixtures/vcr_cassettes/bad_request.yml +0 -76
  184. data/spec/fixtures/vcr_cassettes/content_type.yml +0 -147
  185. data/spec/fixtures/vcr_cassettes/entries/empty_fields.yml +0 -246
  186. data/spec/fixtures/vcr_cassettes/entries/issue_117.yml +0 -201
  187. data/spec/fixtures/vcr_cassettes/entries/issue_125.yml +0 -198
  188. data/spec/fixtures/vcr_cassettes/entries/rich_text.yml +0 -1707
  189. data/spec/fixtures/vcr_cassettes/entries/rich_text_hydration_issue.yml +0 -460
  190. data/spec/fixtures/vcr_cassettes/entries/rich_text_nested_fields.yml +0 -653
  191. data/spec/fixtures/vcr_cassettes/entries/rich_text_unresolved_relationships.yml +0 -983
  192. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml +0 -159
  193. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml +0 -167
  194. data/spec/fixtures/vcr_cassettes/entries.yml +0 -561
  195. data/spec/fixtures/vcr_cassettes/entry/custom_resource.yml +0 -168
  196. data/spec/fixtures/vcr_cassettes/entry/include_resolution.yml +0 -101
  197. data/spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml +0 -81
  198. data/spec/fixtures/vcr_cassettes/entry/json_objects.yml +0 -88
  199. data/spec/fixtures/vcr_cassettes/entry/json_objects_client.yml +0 -86
  200. data/spec/fixtures/vcr_cassettes/entry/marshal_138.yml +0 -159
  201. data/spec/fixtures/vcr_cassettes/entry/marshal_unpublished.yml +0 -303
  202. data/spec/fixtures/vcr_cassettes/entry/marshall.yml +0 -293
  203. data/spec/fixtures/vcr_cassettes/entry/raw.yml +0 -201
  204. data/spec/fixtures/vcr_cassettes/entry/search_link_to_asset.yml +0 -81
  205. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry.yml +0 -81
  206. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry_with_custom_query.yml +0 -115
  207. data/spec/fixtures/vcr_cassettes/entry/select_empty_array.yml +0 -111
  208. data/spec/fixtures/vcr_cassettes/entry/select_no_sys.yml +0 -102
  209. data/spec/fixtures/vcr_cassettes/entry/select_one_field.yml +0 -76
  210. data/spec/fixtures/vcr_cassettes/entry/select_one_field_proper.yml +0 -114
  211. data/spec/fixtures/vcr_cassettes/entry/select_only_sys.yml +0 -111
  212. data/spec/fixtures/vcr_cassettes/entry.yml +0 -102
  213. data/spec/fixtures/vcr_cassettes/entry_cache.yml +0 -288
  214. data/spec/fixtures/vcr_cassettes/entry_locales.yml +0 -104
  215. data/spec/fixtures/vcr_cassettes/field.yml +0 -147
  216. data/spec/fixtures/vcr_cassettes/human.yml +0 -118
  217. data/spec/fixtures/vcr_cassettes/linkField.yml +0 -83
  218. data/spec/fixtures/vcr_cassettes/locale.yml +0 -83
  219. data/spec/fixtures/vcr_cassettes/locale_from_environment.yml +0 -121
  220. data/spec/fixtures/vcr_cassettes/location.yml +0 -193
  221. data/spec/fixtures/vcr_cassettes/multi_locale_array_reference.yml +0 -196
  222. data/spec/fixtures/vcr_cassettes/multi_locale_reference.yml +0 -214
  223. data/spec/fixtures/vcr_cassettes/not_found.yml +0 -76
  224. data/spec/fixtures/vcr_cassettes/nyancat.yml +0 -102
  225. data/spec/fixtures/vcr_cassettes/ratelimit.yml +0 -64
  226. data/spec/fixtures/vcr_cassettes/ratelimit_retry.yml +0 -294
  227. data/spec/fixtures/vcr_cassettes/reloaded_entry.yml +0 -102
  228. data/spec/fixtures/vcr_cassettes/space.yml +0 -83
  229. data/spec/fixtures/vcr_cassettes/sync_deleted_asset.yml +0 -174
  230. data/spec/fixtures/vcr_cassettes/sync_deleted_entry.yml +0 -89
  231. data/spec/fixtures/vcr_cassettes/sync_deletion.yml +0 -191
  232. data/spec/fixtures/vcr_cassettes/sync_environment.yml +0 -81
  233. data/spec/fixtures/vcr_cassettes/sync_page.yml +0 -637
  234. data/spec/fixtures/vcr_cassettes/sync_page_2.yml +0 -71
  235. data/spec/fixtures/vcr_cassettes/sync_page_short.yml +0 -106
  236. data/spec/fixtures/vcr_cassettes/unauthorized.yml +0 -64
  237. data/spec/fixtures/vcr_cassettes/unavailable.yml +0 -76
  238. data/spec/link_spec.rb +0 -50
  239. data/spec/locale_spec.rb +0 -37
  240. data/spec/location_spec.rb +0 -25
  241. data/spec/request_spec.rb +0 -57
  242. data/spec/resource_building_spec.rb +0 -31
  243. data/spec/response_spec.rb +0 -62
  244. data/spec/space_spec.rb +0 -31
  245. data/spec/spec_helper.rb +0 -14
  246. data/spec/support/client.rb +0 -6
  247. data/spec/support/json_responses.rb +0 -18
  248. data/spec/support/vcr.rb +0 -16
  249. data/spec/sync_page_spec.rb +0 -103
  250. data/spec/sync_spec.rb +0 -180
@@ -1,1740 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: Contentful::Client
8
-
9
- &mdash; Documentation by YARD 0.9.18
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "Contentful::Client";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (C)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span>
41
- &raquo;
42
- <span class="title">Client</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: Contentful::Client
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Contentful::Client</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/contentful/client.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>The client object is initialized with a space and a key and then used for
106
- querying resources from this space. See README for details</p>
107
-
108
-
109
- </div>
110
- </div>
111
- <div class="tags">
112
-
113
-
114
- </div>
115
-
116
- <h2>
117
- Constant Summary
118
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
119
- </h2>
120
-
121
- <dl class="constants">
122
-
123
- <dt id="DEFAULT_CONFIGURATION-constant" class="">DEFAULT_CONFIGURATION =
124
- <div class="docstring">
125
- <div class="discussion">
126
-
127
- <p>Default configuration for Contentful::Client</p>
128
-
129
-
130
- </div>
131
- </div>
132
- <div class="tags">
133
-
134
-
135
- </div>
136
- </dt>
137
- <dd><pre class="code"><span class='lbrace'>{</span>
138
- <span class='label'>secure:</span> <span class='kw'>true</span><span class='comma'>,</span>
139
- <span class='label'>raise_errors:</span> <span class='kw'>true</span><span class='comma'>,</span>
140
- <span class='label'>raise_for_empty_fields:</span> <span class='kw'>true</span><span class='comma'>,</span>
141
- <span class='label'>dynamic_entries:</span> <span class='symbol'>:manual</span><span class='comma'>,</span>
142
- <span class='label'>api_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cdn.contentful.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
143
- <span class='label'>api_version:</span> <span class='int'>1</span><span class='comma'>,</span>
144
- <span class='label'>environment:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>master</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
145
- <span class='label'>authentication_mechanism:</span> <span class='symbol'>:header</span><span class='comma'>,</span>
146
- <span class='label'>resource_builder:</span> <span class='const'><span class='object_link'><a href="ResourceBuilder.html" title="Contentful::ResourceBuilder (class)">ResourceBuilder</a></span></span><span class='comma'>,</span>
147
- <span class='label'>resource_mapping:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span>
148
- <span class='label'>entry_mapping:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span>
149
- <span class='label'>default_locale:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>en-US</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
150
- <span class='label'>raw_mode:</span> <span class='kw'>false</span><span class='comma'>,</span>
151
- <span class='label'>gzip_encoded:</span> <span class='kw'>true</span><span class='comma'>,</span>
152
- <span class='label'>logger:</span> <span class='kw'>false</span><span class='comma'>,</span>
153
- <span class='label'>log_level:</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>INFO</span><span class='comma'>,</span>
154
- <span class='label'>proxy_host:</span> <span class='kw'>nil</span><span class='comma'>,</span>
155
- <span class='label'>proxy_username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
156
- <span class='label'>proxy_password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
157
- <span class='label'>proxy_port:</span> <span class='kw'>nil</span><span class='comma'>,</span>
158
- <span class='label'>timeout_connect:</span> <span class='kw'>nil</span><span class='comma'>,</span>
159
- <span class='label'>timeout_read:</span> <span class='kw'>nil</span><span class='comma'>,</span>
160
- <span class='label'>timeout_write:</span> <span class='kw'>nil</span><span class='comma'>,</span>
161
- <span class='label'>max_rate_limit_retries:</span> <span class='int'>1</span><span class='comma'>,</span>
162
- <span class='label'>max_rate_limit_wait:</span> <span class='int'>60</span><span class='comma'>,</span>
163
- <span class='label'>max_include_resolution_depth:</span> <span class='int'>20</span><span class='comma'>,</span>
164
- <span class='label'>use_camel_case:</span> <span class='kw'>false</span><span class='comma'>,</span>
165
- <span class='label'>application_name:</span> <span class='kw'>nil</span><span class='comma'>,</span>
166
- <span class='label'>application_version:</span> <span class='kw'>nil</span><span class='comma'>,</span>
167
- <span class='label'>integration_name:</span> <span class='kw'>nil</span><span class='comma'>,</span>
168
- <span class='label'>integration_version:</span> <span class='kw'>nil</span>
169
- <span class='rbrace'>}</span></pre></dd>
170
-
171
- </dl>
172
-
173
-
174
-
175
-
176
-
177
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
178
- <ul class="summary">
179
-
180
- <li class="public ">
181
- <span class="summary_signature">
182
-
183
- <a href="#configuration-instance_method" title="#configuration (instance method)">#<strong>configuration</strong> &#x21d2; Object </a>
184
-
185
-
186
-
187
- </span>
188
-
189
-
190
-
191
-
192
- <span class="note title readonly">readonly</span>
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
- <span class="summary_desc"><div class='inline'>
203
- <p>Returns the value of attribute configuration.</p>
204
- </div></span>
205
-
206
- </li>
207
-
208
-
209
- <li class="public ">
210
- <span class="summary_signature">
211
-
212
- <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; Object </a>
213
-
214
-
215
-
216
- </span>
217
-
218
-
219
-
220
-
221
- <span class="note title readonly">readonly</span>
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
- <span class="summary_desc"><div class='inline'>
232
- <p>Returns the value of attribute logger.</p>
233
- </div></span>
234
-
235
- </li>
236
-
237
-
238
- <li class="public ">
239
- <span class="summary_signature">
240
-
241
- <a href="#proxy-instance_method" title="#proxy (instance method)">#<strong>proxy</strong> &#x21d2; Object </a>
242
-
243
-
244
-
245
- </span>
246
-
247
-
248
-
249
-
250
- <span class="note title readonly">readonly</span>
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
- <span class="summary_desc"><div class='inline'>
261
- <p>Returns the value of attribute proxy.</p>
262
- </div></span>
263
-
264
- </li>
265
-
266
-
267
- </ul>
268
-
269
-
270
-
271
-
272
-
273
- <h2>
274
- Instance Method Summary
275
- <small><a href="#" class="summary_toggle">collapse</a></small>
276
- </h2>
277
-
278
- <ul class="summary">
279
-
280
- <li class="public ">
281
- <span class="summary_signature">
282
-
283
- <a href="#asset-instance_method" title="#asset (instance method)">#<strong>asset</strong>(id, query = {}) &#x21d2; Contentful::Asset </a>
284
-
285
-
286
-
287
- </span>
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
- <span class="summary_desc"><div class='inline'>
298
- <p>Gets a specific asset.</p>
299
- </div></span>
300
-
301
- </li>
302
-
303
-
304
- <li class="public ">
305
- <span class="summary_signature">
306
-
307
- <a href="#assets-instance_method" title="#assets (instance method)">#<strong>assets</strong>(query = {}) &#x21d2; Contentful::Array&lt;Contentful::Asset&gt; </a>
308
-
309
-
310
-
311
- </span>
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
- <span class="summary_desc"><div class='inline'>
322
- <p>Gets a collection of assets.</p>
323
- </div></span>
324
-
325
- </li>
326
-
327
-
328
- <li class="public ">
329
- <span class="summary_signature">
330
-
331
- <a href="#content_type-instance_method" title="#content_type (instance method)">#<strong>content_type</strong>(id, query = {}) &#x21d2; Contentful::ContentType </a>
332
-
333
-
334
-
335
- </span>
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
- <span class="summary_desc"><div class='inline'>
346
- <p>Gets a specific content type.</p>
347
- </div></span>
348
-
349
- </li>
350
-
351
-
352
- <li class="public ">
353
- <span class="summary_signature">
354
-
355
- <a href="#content_types-instance_method" title="#content_types (instance method)">#<strong>content_types</strong>(query = {}) &#x21d2; Contentful::Array&lt;Contentful::ContentType&gt; </a>
356
-
357
-
358
-
359
- </span>
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
- <span class="summary_desc"><div class='inline'>
370
- <p>Gets a collection of content types.</p>
371
- </div></span>
372
-
373
- </li>
374
-
375
-
376
- <li class="public ">
377
- <span class="summary_signature">
378
-
379
- <a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong>(query = {}) &#x21d2; Contentful::Array&lt;Contentful::Entry&gt; </a>
380
-
381
-
382
-
383
- </span>
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
- <span class="summary_desc"><div class='inline'>
394
- <p>Gets a collection of entries.</p>
395
- </div></span>
396
-
397
- </li>
398
-
399
-
400
- <li class="public ">
401
- <span class="summary_signature">
402
-
403
- <a href="#entry-instance_method" title="#entry (instance method)">#<strong>entry</strong>(id, query = {}) &#x21d2; Contentful::Entry </a>
404
-
405
-
406
-
407
- </span>
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
- <span class="summary_desc"><div class='inline'>
418
- <p>Gets a specific entry.</p>
419
- </div></span>
420
-
421
- </li>
422
-
423
-
424
- <li class="public ">
425
- <span class="summary_signature">
426
-
427
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(given_configuration = {}) &#x21d2; Client </a>
428
-
429
-
430
-
431
- </span>
432
-
433
-
434
- <span class="note title constructor">constructor</span>
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
- <span class="summary_desc"><div class='inline'>
444
- <p>A new instance of Client.</p>
445
- </div></span>
446
-
447
- </li>
448
-
449
-
450
- <li class="public ">
451
- <span class="summary_signature">
452
-
453
- <a href="#locales-instance_method" title="#locales (instance method)">#<strong>locales</strong>(query = {}) &#x21d2; Contentful::Array&lt;Contentful::Locale&gt; </a>
454
-
455
-
456
-
457
- </span>
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
- <span class="summary_desc"><div class='inline'>
468
- <p>Gets a collection of locales for the current environment.</p>
469
- </div></span>
470
-
471
- </li>
472
-
473
-
474
- <li class="public ">
475
- <span class="summary_signature">
476
-
477
- <a href="#space-instance_method" title="#space (instance method)">#<strong>space</strong>(query = {}) &#x21d2; Contentful::Space </a>
478
-
479
-
480
-
481
- </span>
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
- <span class="summary_desc"><div class='inline'>
492
- <p>Gets the client&#39;s space.</p>
493
- </div></span>
494
-
495
- </li>
496
-
497
-
498
- <li class="public ">
499
- <span class="summary_signature">
500
-
501
- <a href="#sync-instance_method" title="#sync (instance method)">#<strong>sync</strong>(options = { initial: true }) &#x21d2; Contentful::Sync </a>
502
-
503
-
504
-
505
- </span>
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
- <span class="summary_desc"><div class='inline'>
516
- <p>Create a new synchronisation object.</p>
517
- </div></span>
518
-
519
- </li>
520
-
521
-
522
- </ul>
523
-
524
-
525
- <div id="constructor_details" class="method_details_list">
526
- <h2>Constructor Details</h2>
527
-
528
- <div class="method_details first">
529
- <h3 class="signature first" id="initialize-instance_method">
530
-
531
- #<strong>initialize</strong>(given_configuration = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Client (class)">Client</a></span></tt>
532
-
533
-
534
-
535
-
536
-
537
- </h3><div class="docstring">
538
- <div class="discussion">
539
-
540
- <p>Returns a new instance of Client</p>
541
-
542
-
543
- </div>
544
- </div>
545
- <div class="tags">
546
- <p class="tag_title">Parameters:</p>
547
- <ul class="param">
548
-
549
- <li>
550
-
551
- <span class='name'>given_configuration</span>
552
-
553
-
554
- <span class='type'>(<tt>Hash</tt>)</span>
555
-
556
-
557
- <em class="default">(defaults to: <tt>{}</tt>)</em>
558
-
559
-
560
- </li>
561
-
562
- </ul>
563
-
564
-
565
-
566
-
567
- <p class="tag_title">Options Hash (<tt>given_configuration</tt>):</p>
568
- <ul class="option">
569
-
570
- <li>
571
- <span class="name">:space</span>
572
- <span class="type">(<tt>String</tt>)</span>
573
- <span class="default">
574
-
575
- </span>
576
-
577
- &mdash; <div class='inline'>
578
- <p>Required</p>
579
- </div>
580
-
581
- </li>
582
-
583
- <li>
584
- <span class="name">:access_token</span>
585
- <span class="type">(<tt>String</tt>)</span>
586
- <span class="default">
587
-
588
- </span>
589
-
590
- &mdash; <div class='inline'>
591
- <p>Required</p>
592
- </div>
593
-
594
- </li>
595
-
596
- <li>
597
- <span class="name">:api_url</span>
598
- <span class="type">(<tt>String</tt>)</span>
599
- <span class="default">
600
-
601
- </span>
602
-
603
- &mdash; <div class='inline'>
604
- <p>Modifying this to &#39;preview.contentful.com&#39; gives you access to our
605
- Preview API</p>
606
- </div>
607
-
608
- </li>
609
-
610
- <li>
611
- <span class="name">:api_version</span>
612
- <span class="type">(<tt>String</tt>)</span>
613
- <span class="default">
614
-
615
- </span>
616
-
617
- </li>
618
-
619
- <li>
620
- <span class="name">:default_locale</span>
621
- <span class="type">(<tt>String</tt>)</span>
622
- <span class="default">
623
-
624
- </span>
625
-
626
- </li>
627
-
628
- <li>
629
- <span class="name">:proxy_host</span>
630
- <span class="type">(<tt>String</tt>)</span>
631
- <span class="default">
632
-
633
- </span>
634
-
635
- </li>
636
-
637
- <li>
638
- <span class="name">:proxy_username</span>
639
- <span class="type">(<tt>String</tt>)</span>
640
- <span class="default">
641
-
642
- </span>
643
-
644
- </li>
645
-
646
- <li>
647
- <span class="name">:proxy_password</span>
648
- <span class="type">(<tt>String</tt>)</span>
649
- <span class="default">
650
-
651
- </span>
652
-
653
- </li>
654
-
655
- <li>
656
- <span class="name">:proxy_port</span>
657
- <span class="type">(<tt>Number</tt>)</span>
658
- <span class="default">
659
-
660
- </span>
661
-
662
- </li>
663
-
664
- <li>
665
- <span class="name">:timeout_read</span>
666
- <span class="type">(<tt>Number</tt>)</span>
667
- <span class="default">
668
-
669
- </span>
670
-
671
- </li>
672
-
673
- <li>
674
- <span class="name">:timeout_write</span>
675
- <span class="type">(<tt>Number</tt>)</span>
676
- <span class="default">
677
-
678
- </span>
679
-
680
- </li>
681
-
682
- <li>
683
- <span class="name">:timeout_connect</span>
684
- <span class="type">(<tt>Number</tt>)</span>
685
- <span class="default">
686
-
687
- </span>
688
-
689
- </li>
690
-
691
- <li>
692
- <span class="name">:max_rate_limit_retries</span>
693
- <span class="type">(<tt>Number</tt>)</span>
694
- <span class="default">
695
-
696
- </span>
697
-
698
- </li>
699
-
700
- <li>
701
- <span class="name">:max_rate_limit_wait</span>
702
- <span class="type">(<tt>Number</tt>)</span>
703
- <span class="default">
704
-
705
- </span>
706
-
707
- </li>
708
-
709
- <li>
710
- <span class="name">:max_include_resolution_depth</span>
711
- <span class="type">(<tt>Number</tt>)</span>
712
- <span class="default">
713
-
714
- </span>
715
-
716
- </li>
717
-
718
- <li>
719
- <span class="name">:use_camel_case</span>
720
- <span class="type">(<tt>Boolean</tt>)</span>
721
- <span class="default">
722
-
723
- </span>
724
-
725
- </li>
726
-
727
- <li>
728
- <span class="name">:gzip_encoded</span>
729
- <span class="type">(<tt>Boolean</tt>)</span>
730
- <span class="default">
731
-
732
- </span>
733
-
734
- </li>
735
-
736
- <li>
737
- <span class="name">:raw_mode</span>
738
- <span class="type">(<tt>Boolean</tt>)</span>
739
- <span class="default">
740
-
741
- </span>
742
-
743
- </li>
744
-
745
- <li>
746
- <span class="name">:logger</span>
747
- <span class="type">(<tt>false</tt>, <tt>::Logger</tt>)</span>
748
- <span class="default">
749
-
750
- </span>
751
-
752
- </li>
753
-
754
- <li>
755
- <span class="name">:log_level</span>
756
- <span class="type">(<tt>::Logger::DEBUG</tt>, <tt>::Logger::INFO</tt>, <tt>::Logger::WARN</tt>, <tt>::Logger::ERROR</tt>)</span>
757
- <span class="default">
758
-
759
- </span>
760
-
761
- </li>
762
-
763
- <li>
764
- <span class="name">:raise_errors</span>
765
- <span class="type">(<tt>Boolean</tt>)</span>
766
- <span class="default">
767
-
768
- </span>
769
-
770
- </li>
771
-
772
- <li>
773
- <span class="name">:raise_for_empty_fields</span>
774
- <span class="type">(<tt>Boolean</tt>)</span>
775
- <span class="default">
776
-
777
- </span>
778
-
779
- </li>
780
-
781
- <li>
782
- <span class="name">:dynamic_entries</span>
783
- <span class="type">(<tt>::Array&lt;String&gt;</tt>)</span>
784
- <span class="default">
785
-
786
- </span>
787
-
788
- </li>
789
-
790
- <li>
791
- <span class="name">:resource_mapping</span>
792
- <span class="type">(<tt>::Hash&lt;String, Contentful::Resource&gt;</tt>)</span>
793
- <span class="default">
794
-
795
- </span>
796
-
797
- </li>
798
-
799
- <li>
800
- <span class="name">:entry_mapping</span>
801
- <span class="type">(<tt>::Hash&lt;String, Contentful::Resource&gt;</tt>)</span>
802
- <span class="default">
803
-
804
- </span>
805
-
806
- </li>
807
-
808
- <li>
809
- <span class="name">:application_name</span>
810
- <span class="type">(<tt>String</tt>)</span>
811
- <span class="default">
812
-
813
- </span>
814
-
815
- </li>
816
-
817
- <li>
818
- <span class="name">:application_version</span>
819
- <span class="type">(<tt>String</tt>)</span>
820
- <span class="default">
821
-
822
- </span>
823
-
824
- </li>
825
-
826
- <li>
827
- <span class="name">:integration_name</span>
828
- <span class="type">(<tt>String</tt>)</span>
829
- <span class="default">
830
-
831
- </span>
832
-
833
- </li>
834
-
835
- <li>
836
- <span class="name">:integration_version</span>
837
- <span class="type">(<tt>String</tt>)</span>
838
- <span class="default">
839
-
840
- </span>
841
-
842
- </li>
843
-
844
- </ul>
845
-
846
-
847
-
848
- <p class="tag_title">See Also:</p>
849
- <ul class="see">
850
-
851
- <li>https://github.com/contentful/contentful.rb#client-configuration-options</li>
852
-
853
- </ul>
854
-
855
- </div><table class="source_code">
856
- <tr>
857
- <td>
858
- <pre class="lines">
859
-
860
-
861
- 96
862
- 97
863
- 98
864
- 99
865
- 100
866
- 101
867
- 102
868
- 103</pre>
869
- </td>
870
- <td>
871
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 96</span>
872
-
873
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_given_configuration'>given_configuration</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
874
- <span class='ivar'>@configuration</span> <span class='op'>=</span> <span class='id identifier rubyid_default_configuration'>default_configuration</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_given_configuration'>given_configuration</span><span class='rparen'>)</span>
875
- <span class='id identifier rubyid_normalize_configuration!'>normalize_configuration!</span>
876
- <span class='id identifier rubyid_validate_configuration!'>validate_configuration!</span>
877
- <span class='id identifier rubyid_setup_logger'>setup_logger</span>
878
-
879
- <span class='id identifier rubyid_update_dynamic_entry_cache!'>update_dynamic_entry_cache!</span> <span class='kw'>if</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='lbracket'>[</span><span class='symbol'>:dynamic_entries</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='symbol'>:auto</span>
880
- <span class='kw'>end</span></pre>
881
- </td>
882
- </tr>
883
- </table>
884
- </div>
885
-
886
- </div>
887
-
888
- <div id="instance_attr_details" class="attr_details">
889
- <h2>Instance Attribute Details</h2>
890
-
891
-
892
- <span id=""></span>
893
- <div class="method_details first">
894
- <h3 class="signature first" id="configuration-instance_method">
895
-
896
- #<strong>configuration</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
897
-
898
-
899
-
900
-
901
-
902
- </h3><div class="docstring">
903
- <div class="discussion">
904
-
905
- <p>Returns the value of attribute configuration</p>
906
-
907
-
908
- </div>
909
- </div>
910
- <div class="tags">
911
-
912
-
913
- </div><table class="source_code">
914
- <tr>
915
- <td>
916
- <pre class="lines">
917
-
918
-
919
- 51
920
- 52
921
- 53</pre>
922
- </td>
923
- <td>
924
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 51</span>
925
-
926
- <span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
927
- <span class='ivar'>@configuration</span>
928
- <span class='kw'>end</span></pre>
929
- </td>
930
- </tr>
931
- </table>
932
- </div>
933
-
934
-
935
- <span id=""></span>
936
- <div class="method_details ">
937
- <h3 class="signature " id="logger-instance_method">
938
-
939
- #<strong>logger</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
940
-
941
-
942
-
943
-
944
-
945
- </h3><div class="docstring">
946
- <div class="discussion">
947
-
948
- <p>Returns the value of attribute logger</p>
949
-
950
-
951
- </div>
952
- </div>
953
- <div class="tags">
954
-
955
-
956
- </div><table class="source_code">
957
- <tr>
958
- <td>
959
- <pre class="lines">
960
-
961
-
962
- 51
963
- 52
964
- 53</pre>
965
- </td>
966
- <td>
967
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 51</span>
968
-
969
- <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
970
- <span class='ivar'>@logger</span>
971
- <span class='kw'>end</span></pre>
972
- </td>
973
- </tr>
974
- </table>
975
- </div>
976
-
977
-
978
- <span id=""></span>
979
- <div class="method_details ">
980
- <h3 class="signature " id="proxy-instance_method">
981
-
982
- #<strong>proxy</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
983
-
984
-
985
-
986
-
987
-
988
- </h3><div class="docstring">
989
- <div class="discussion">
990
-
991
- <p>Returns the value of attribute proxy</p>
992
-
993
-
994
- </div>
995
- </div>
996
- <div class="tags">
997
-
998
-
999
- </div><table class="source_code">
1000
- <tr>
1001
- <td>
1002
- <pre class="lines">
1003
-
1004
-
1005
- 51
1006
- 52
1007
- 53</pre>
1008
- </td>
1009
- <td>
1010
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 51</span>
1011
-
1012
- <span class='kw'>def</span> <span class='id identifier rubyid_proxy'>proxy</span>
1013
- <span class='ivar'>@proxy</span>
1014
- <span class='kw'>end</span></pre>
1015
- </td>
1016
- </tr>
1017
- </table>
1018
- </div>
1019
-
1020
- </div>
1021
-
1022
-
1023
- <div id="instance_method_details" class="method_details_list">
1024
- <h2>Instance Method Details</h2>
1025
-
1026
-
1027
- <div class="method_details first">
1028
- <h3 class="signature first" id="asset-instance_method">
1029
-
1030
- #<strong>asset</strong>(id, query = {}) &#x21d2; <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>
1031
-
1032
-
1033
-
1034
-
1035
-
1036
- </h3><div class="docstring">
1037
- <div class="discussion">
1038
-
1039
- <p>Gets a specific asset</p>
1040
-
1041
-
1042
- </div>
1043
- </div>
1044
- <div class="tags">
1045
- <p class="tag_title">Parameters:</p>
1046
- <ul class="param">
1047
-
1048
- <li>
1049
-
1050
- <span class='name'>id</span>
1051
-
1052
-
1053
- <span class='type'>(<tt>String</tt>)</span>
1054
-
1055
-
1056
-
1057
- </li>
1058
-
1059
- <li>
1060
-
1061
- <span class='name'>query</span>
1062
-
1063
-
1064
- <span class='type'>(<tt>Hash</tt>)</span>
1065
-
1066
-
1067
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1068
-
1069
-
1070
- </li>
1071
-
1072
- </ul>
1073
-
1074
- <p class="tag_title">Returns:</p>
1075
- <ul class="return">
1076
-
1077
- <li>
1078
-
1079
-
1080
- <span class='type'>(<tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span>
1081
-
1082
-
1083
-
1084
- </li>
1085
-
1086
- </ul>
1087
-
1088
- </div><table class="source_code">
1089
- <tr>
1090
- <td>
1091
- <pre class="lines">
1092
-
1093
-
1094
- 196
1095
- 197
1096
- 198</pre>
1097
- </td>
1098
- <td>
1099
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 196</span>
1100
-
1101
- <span class='kw'>def</span> <span class='id identifier rubyid_asset'>asset</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1102
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/assets</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1103
- <span class='kw'>end</span></pre>
1104
- </td>
1105
- </tr>
1106
- </table>
1107
- </div>
1108
-
1109
- <div class="method_details ">
1110
- <h3 class="signature " id="assets-instance_method">
1111
-
1112
- #<strong>assets</strong>(query = {}) &#x21d2; <tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span>&gt;</tt>
1113
-
1114
-
1115
-
1116
-
1117
-
1118
- </h3><div class="docstring">
1119
- <div class="discussion">
1120
-
1121
- <p>Gets a collection of assets</p>
1122
-
1123
-
1124
- </div>
1125
- </div>
1126
- <div class="tags">
1127
- <p class="tag_title">Parameters:</p>
1128
- <ul class="param">
1129
-
1130
- <li>
1131
-
1132
- <span class='name'>query</span>
1133
-
1134
-
1135
- <span class='type'>(<tt>Hash</tt>)</span>
1136
-
1137
-
1138
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1139
-
1140
-
1141
- </li>
1142
-
1143
- </ul>
1144
-
1145
- <p class="tag_title">Returns:</p>
1146
- <ul class="return">
1147
-
1148
- <li>
1149
-
1150
-
1151
- <span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span>&gt;</tt>)</span>
1152
-
1153
-
1154
-
1155
- </li>
1156
-
1157
- </ul>
1158
-
1159
- </div><table class="source_code">
1160
- <tr>
1161
- <td>
1162
- <pre class="lines">
1163
-
1164
-
1165
- 205
1166
- 206
1167
- 207
1168
- 208</pre>
1169
- </td>
1170
- <td>
1171
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 205</span>
1172
-
1173
- <span class='kw'>def</span> <span class='id identifier rubyid_assets'>assets</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1174
- <span class='id identifier rubyid_normalize_select!'>normalize_select!</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
1175
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/assets</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1176
- <span class='kw'>end</span></pre>
1177
- </td>
1178
- </tr>
1179
- </table>
1180
- </div>
1181
-
1182
- <div class="method_details ">
1183
- <h3 class="signature " id="content_type-instance_method">
1184
-
1185
- #<strong>content_type</strong>(id, query = {}) &#x21d2; <tt><span class='object_link'><a href="ContentType.html" title="Contentful::ContentType (class)">Contentful::ContentType</a></span></tt>
1186
-
1187
-
1188
-
1189
-
1190
-
1191
- </h3><div class="docstring">
1192
- <div class="discussion">
1193
-
1194
- <p>Gets a specific content type</p>
1195
-
1196
-
1197
- </div>
1198
- </div>
1199
- <div class="tags">
1200
- <p class="tag_title">Parameters:</p>
1201
- <ul class="param">
1202
-
1203
- <li>
1204
-
1205
- <span class='name'>id</span>
1206
-
1207
-
1208
- <span class='type'>(<tt>String</tt>)</span>
1209
-
1210
-
1211
-
1212
- </li>
1213
-
1214
- <li>
1215
-
1216
- <span class='name'>query</span>
1217
-
1218
-
1219
- <span class='type'>(<tt>Hash</tt>)</span>
1220
-
1221
-
1222
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1223
-
1224
-
1225
- </li>
1226
-
1227
- </ul>
1228
-
1229
- <p class="tag_title">Returns:</p>
1230
- <ul class="return">
1231
-
1232
- <li>
1233
-
1234
-
1235
- <span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Contentful::ContentType (class)">Contentful::ContentType</a></span></tt>)</span>
1236
-
1237
-
1238
-
1239
- </li>
1240
-
1241
- </ul>
1242
-
1243
- </div><table class="source_code">
1244
- <tr>
1245
- <td>
1246
- <pre class="lines">
1247
-
1248
-
1249
- 151
1250
- 152
1251
- 153</pre>
1252
- </td>
1253
- <td>
1254
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 151</span>
1255
-
1256
- <span class='kw'>def</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1257
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/content_types</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1258
- <span class='kw'>end</span></pre>
1259
- </td>
1260
- </tr>
1261
- </table>
1262
- </div>
1263
-
1264
- <div class="method_details ">
1265
- <h3 class="signature " id="content_types-instance_method">
1266
-
1267
- #<strong>content_types</strong>(query = {}) &#x21d2; <tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="ContentType.html" title="Contentful::ContentType (class)">Contentful::ContentType</a></span>&gt;</tt>
1268
-
1269
-
1270
-
1271
-
1272
-
1273
- </h3><div class="docstring">
1274
- <div class="discussion">
1275
-
1276
- <p>Gets a collection of content types</p>
1277
-
1278
-
1279
- </div>
1280
- </div>
1281
- <div class="tags">
1282
- <p class="tag_title">Parameters:</p>
1283
- <ul class="param">
1284
-
1285
- <li>
1286
-
1287
- <span class='name'>query</span>
1288
-
1289
-
1290
- <span class='type'>(<tt>Hash</tt>)</span>
1291
-
1292
-
1293
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1294
-
1295
-
1296
- </li>
1297
-
1298
- </ul>
1299
-
1300
- <p class="tag_title">Returns:</p>
1301
- <ul class="return">
1302
-
1303
- <li>
1304
-
1305
-
1306
- <span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="ContentType.html" title="Contentful::ContentType (class)">Contentful::ContentType</a></span>&gt;</tt>)</span>
1307
-
1308
-
1309
-
1310
- </li>
1311
-
1312
- </ul>
1313
-
1314
- </div><table class="source_code">
1315
- <tr>
1316
- <td>
1317
- <pre class="lines">
1318
-
1319
-
1320
- 160
1321
- 161
1322
- 162</pre>
1323
- </td>
1324
- <td>
1325
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 160</span>
1326
-
1327
- <span class='kw'>def</span> <span class='id identifier rubyid_content_types'>content_types</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1328
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/content_types</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1329
- <span class='kw'>end</span></pre>
1330
- </td>
1331
- </tr>
1332
- </table>
1333
- </div>
1334
-
1335
- <div class="method_details ">
1336
- <h3 class="signature " id="entries-instance_method">
1337
-
1338
- #<strong>entries</strong>(query = {}) &#x21d2; <tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span>&gt;</tt>
1339
-
1340
-
1341
-
1342
-
1343
-
1344
- </h3><div class="docstring">
1345
- <div class="discussion">
1346
-
1347
- <p>Gets a collection of entries</p>
1348
-
1349
-
1350
- </div>
1351
- </div>
1352
- <div class="tags">
1353
- <p class="tag_title">Parameters:</p>
1354
- <ul class="param">
1355
-
1356
- <li>
1357
-
1358
- <span class='name'>query</span>
1359
-
1360
-
1361
- <span class='type'>(<tt>Hash</tt>)</span>
1362
-
1363
-
1364
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1365
-
1366
-
1367
- </li>
1368
-
1369
- </ul>
1370
-
1371
- <p class="tag_title">Returns:</p>
1372
- <ul class="return">
1373
-
1374
- <li>
1375
-
1376
-
1377
- <span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span>&gt;</tt>)</span>
1378
-
1379
-
1380
-
1381
- </li>
1382
-
1383
- </ul>
1384
-
1385
- </div><table class="source_code">
1386
- <tr>
1387
- <td>
1388
- <pre class="lines">
1389
-
1390
-
1391
- 185
1392
- 186
1393
- 187
1394
- 188</pre>
1395
- </td>
1396
- <td>
1397
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 185</span>
1398
-
1399
- <span class='kw'>def</span> <span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1400
- <span class='id identifier rubyid_normalize_select!'>normalize_select!</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
1401
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/entries</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1402
- <span class='kw'>end</span></pre>
1403
- </td>
1404
- </tr>
1405
- </table>
1406
- </div>
1407
-
1408
- <div class="method_details ">
1409
- <h3 class="signature " id="entry-instance_method">
1410
-
1411
- #<strong>entry</strong>(id, query = {}) &#x21d2; <tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>
1412
-
1413
-
1414
-
1415
-
1416
-
1417
- </h3><div class="docstring">
1418
- <div class="discussion">
1419
-
1420
- <p>Gets a specific entry</p>
1421
-
1422
-
1423
- </div>
1424
- </div>
1425
- <div class="tags">
1426
- <p class="tag_title">Parameters:</p>
1427
- <ul class="param">
1428
-
1429
- <li>
1430
-
1431
- <span class='name'>id</span>
1432
-
1433
-
1434
- <span class='type'>(<tt>String</tt>)</span>
1435
-
1436
-
1437
-
1438
- </li>
1439
-
1440
- <li>
1441
-
1442
- <span class='name'>query</span>
1443
-
1444
-
1445
- <span class='type'>(<tt>Hash</tt>)</span>
1446
-
1447
-
1448
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1449
-
1450
-
1451
- </li>
1452
-
1453
- </ul>
1454
-
1455
- <p class="tag_title">Returns:</p>
1456
- <ul class="return">
1457
-
1458
- <li>
1459
-
1460
-
1461
- <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>)</span>
1462
-
1463
-
1464
-
1465
- </li>
1466
-
1467
- </ul>
1468
-
1469
- </div><table class="source_code">
1470
- <tr>
1471
- <td>
1472
- <pre class="lines">
1473
-
1474
-
1475
- 170
1476
- 171
1477
- 172
1478
- 173
1479
- 174
1480
- 175
1481
- 176
1482
- 177
1483
- 178</pre>
1484
- </td>
1485
- <td>
1486
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 170</span>
1487
-
1488
- <span class='kw'>def</span> <span class='id identifier rubyid_entry'>entry</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1489
- <span class='id identifier rubyid_normalize_select!'>normalize_select!</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
1490
- <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sys.id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
1491
- <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/entries</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1492
-
1493
- <span class='kw'>return</span> <span class='id identifier rubyid_entries'>entries</span> <span class='kw'>if</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='lbracket'>[</span><span class='symbol'>:raw_mode</span><span class='rbracket'>]</span>
1494
-
1495
- <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
1496
- <span class='kw'>end</span></pre>
1497
- </td>
1498
- </tr>
1499
- </table>
1500
- </div>
1501
-
1502
- <div class="method_details ">
1503
- <h3 class="signature " id="locales-instance_method">
1504
-
1505
- #<strong>locales</strong>(query = {}) &#x21d2; <tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Locale.html" title="Contentful::Locale (class)">Contentful::Locale</a></span>&gt;</tt>
1506
-
1507
-
1508
-
1509
-
1510
-
1511
- </h3><div class="docstring">
1512
- <div class="discussion">
1513
-
1514
- <p>Gets a collection of locales for the current environment</p>
1515
-
1516
-
1517
- </div>
1518
- </div>
1519
- <div class="tags">
1520
- <p class="tag_title">Parameters:</p>
1521
- <ul class="param">
1522
-
1523
- <li>
1524
-
1525
- <span class='name'>query</span>
1526
-
1527
-
1528
- <span class='type'>(<tt>Hash</tt>)</span>
1529
-
1530
-
1531
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1532
-
1533
-
1534
- </li>
1535
-
1536
- </ul>
1537
-
1538
- <p class="tag_title">Returns:</p>
1539
- <ul class="return">
1540
-
1541
- <li>
1542
-
1543
-
1544
- <span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Contentful::Array</a></span>&lt;<span class='object_link'><a href="Locale.html" title="Contentful::Locale (class)">Contentful::Locale</a></span>&gt;</tt>)</span>
1545
-
1546
-
1547
-
1548
- </li>
1549
-
1550
- </ul>
1551
-
1552
- </div><table class="source_code">
1553
- <tr>
1554
- <td>
1555
- <pre class="lines">
1556
-
1557
-
1558
- 215
1559
- 216
1560
- 217</pre>
1561
- </td>
1562
- <td>
1563
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 215</span>
1564
-
1565
- <span class='kw'>def</span> <span class='id identifier rubyid_locales'>locales</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1566
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_environment_url'>environment_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/locales</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1567
- <span class='kw'>end</span></pre>
1568
- </td>
1569
- </tr>
1570
- </table>
1571
- </div>
1572
-
1573
- <div class="method_details ">
1574
- <h3 class="signature " id="space-instance_method">
1575
-
1576
- #<strong>space</strong>(query = {}) &#x21d2; <tt><span class='object_link'><a href="Space.html" title="Contentful::Space (class)">Contentful::Space</a></span></tt>
1577
-
1578
-
1579
-
1580
-
1581
-
1582
- </h3><div class="docstring">
1583
- <div class="discussion">
1584
-
1585
- <p>Gets the client&#39;s space</p>
1586
-
1587
-
1588
- </div>
1589
- </div>
1590
- <div class="tags">
1591
- <p class="tag_title">Parameters:</p>
1592
- <ul class="param">
1593
-
1594
- <li>
1595
-
1596
- <span class='name'>query</span>
1597
-
1598
-
1599
- <span class='type'>(<tt>Hash</tt>)</span>
1600
-
1601
-
1602
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1603
-
1604
-
1605
- </li>
1606
-
1607
- </ul>
1608
-
1609
- <p class="tag_title">Returns:</p>
1610
- <ul class="return">
1611
-
1612
- <li>
1613
-
1614
-
1615
- <span class='type'>(<tt><span class='object_link'><a href="Space.html" title="Contentful::Space (class)">Contentful::Space</a></span></tt>)</span>
1616
-
1617
-
1618
-
1619
- </li>
1620
-
1621
- </ul>
1622
-
1623
- </div><table class="source_code">
1624
- <tr>
1625
- <td>
1626
- <pre class="lines">
1627
-
1628
-
1629
- 141
1630
- 142
1631
- 143</pre>
1632
- </td>
1633
- <td>
1634
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 141</span>
1635
-
1636
- <span class='kw'>def</span> <span class='id identifier rubyid_space'>space</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1637
- <span class='const'><span class='object_link'><a href="Request.html" title="Contentful::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Contentful::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Contentful::Request#get (method)">get</a></span></span>
1638
- <span class='kw'>end</span></pre>
1639
- </td>
1640
- </tr>
1641
- </table>
1642
- </div>
1643
-
1644
- <div class="method_details ">
1645
- <h3 class="signature " id="sync-instance_method">
1646
-
1647
- #<strong>sync</strong>(options = { initial: true }) &#x21d2; <tt><span class='object_link'><a href="Sync.html" title="Contentful::Sync (class)">Contentful::Sync</a></span></tt>
1648
-
1649
-
1650
-
1651
-
1652
-
1653
- </h3><div class="docstring">
1654
- <div class="discussion">
1655
-
1656
- <div class="note notetag">
1657
- <strong>Note:</strong>
1658
- <div class='inline'>
1659
- <p>You will need to call #each_page or #first_page on it</p>
1660
- </div>
1661
- </div>
1662
-
1663
-
1664
- <p>Create a new synchronisation object</p>
1665
-
1666
-
1667
- </div>
1668
- </div>
1669
- <div class="tags">
1670
- <p class="tag_title">Parameters:</p>
1671
- <ul class="param">
1672
-
1673
- <li>
1674
-
1675
- <span class='name'>options</span>
1676
-
1677
-
1678
- <span class='type'>(<tt>Hash</tt>, <tt>String</tt>)</span>
1679
-
1680
-
1681
- <em class="default">(defaults to: <tt>{ initial: true }</tt>)</em>
1682
-
1683
-
1684
- &mdash;
1685
- <div class='inline'>
1686
- <p>Options or Sync URL</p>
1687
- </div>
1688
-
1689
- </li>
1690
-
1691
- </ul>
1692
-
1693
- <p class="tag_title">Returns:</p>
1694
- <ul class="return">
1695
-
1696
- <li>
1697
-
1698
-
1699
- <span class='type'>(<tt><span class='object_link'><a href="Sync.html" title="Contentful::Sync (class)">Contentful::Sync</a></span></tt>)</span>
1700
-
1701
-
1702
-
1703
- </li>
1704
-
1705
- </ul>
1706
-
1707
- </div><table class="source_code">
1708
- <tr>
1709
- <td>
1710
- <pre class="lines">
1711
-
1712
-
1713
- 417
1714
- 418
1715
- 419</pre>
1716
- </td>
1717
- <td>
1718
- <pre class="code"><span class="info file"># File 'lib/contentful/client.rb', line 417</span>
1719
-
1720
- <span class='kw'>def</span> <span class='id identifier rubyid_sync'>sync</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>initial:</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
1721
- <span class='const'><span class='object_link'><a href="Sync.html" title="Contentful::Sync (class)">Sync</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Sync.html#initialize-instance_method" title="Contentful::Sync#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1722
- <span class='kw'>end</span></pre>
1723
- </td>
1724
- </tr>
1725
- </table>
1726
- </div>
1727
-
1728
- </div>
1729
-
1730
- </div>
1731
-
1732
- <div id="footer">
1733
- Generated on Tue Apr 9 10:49:56 2019 by
1734
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1735
- 0.9.18 (ruby-2.5.3).
1736
- </div>
1737
-
1738
- </div>
1739
- </body>
1740
- </html>