contentful 2.15.4 → 2.16.3

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