contentful 2.1.1 → 2.1.2

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