alfresco 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +69 -0
  4. data/README.md +119 -0
  5. data/Rakefile +8 -0
  6. data/alfresco.gemspec +45 -0
  7. data/docs/ContentInfo.md +12 -0
  8. data/docs/Error.md +8 -0
  9. data/docs/ErrorError.md +13 -0
  10. data/docs/GenericBucket.md +13 -0
  11. data/docs/GenericBucketBucketInfo.md +11 -0
  12. data/docs/GenericFacetResponse.md +10 -0
  13. data/docs/GenericMetric.md +9 -0
  14. data/docs/Node.md +24 -0
  15. data/docs/Pagination.md +12 -0
  16. data/docs/PathElement.md +9 -0
  17. data/docs/PathInfo.md +10 -0
  18. data/docs/RequestDefaults.md +12 -0
  19. data/docs/RequestFacetField.md +18 -0
  20. data/docs/RequestFacetFields.md +8 -0
  21. data/docs/RequestFacetIntervals.md +9 -0
  22. data/docs/RequestFacetIntervalsIntervals.md +10 -0
  23. data/docs/RequestFacetQueries.md +7 -0
  24. data/docs/RequestFacetQueriesInner.md +9 -0
  25. data/docs/RequestFacetSet.md +12 -0
  26. data/docs/RequestFields.md +7 -0
  27. data/docs/RequestFilterQueries.md +7 -0
  28. data/docs/RequestFilterQueriesInner.md +9 -0
  29. data/docs/RequestHighlight.md +15 -0
  30. data/docs/RequestHighlightFields.md +13 -0
  31. data/docs/RequestInclude.md +7 -0
  32. data/docs/RequestLimits.md +9 -0
  33. data/docs/RequestLocalization.md +9 -0
  34. data/docs/RequestPagination.md +9 -0
  35. data/docs/RequestPivot.md +9 -0
  36. data/docs/RequestQuery.md +10 -0
  37. data/docs/RequestRange.md +16 -0
  38. data/docs/RequestScope.md +8 -0
  39. data/docs/RequestSortDefinition.md +7 -0
  40. data/docs/RequestSortDefinitionInner.md +10 -0
  41. data/docs/RequestSpellcheck.md +8 -0
  42. data/docs/RequestStats.md +23 -0
  43. data/docs/RequestTemplates.md +7 -0
  44. data/docs/RequestTemplatesInner.md +9 -0
  45. data/docs/ResponseConsistency.md +8 -0
  46. data/docs/ResultBuckets.md +9 -0
  47. data/docs/ResultBucketsBuckets.md +11 -0
  48. data/docs/ResultNode.md +29 -0
  49. data/docs/ResultSetContext.md +13 -0
  50. data/docs/ResultSetContextFacetQueries.md +10 -0
  51. data/docs/ResultSetContextSpellcheck.md +9 -0
  52. data/docs/ResultSetPaging.md +8 -0
  53. data/docs/ResultSetPagingList.md +10 -0
  54. data/docs/ResultSetRowEntry.md +8 -0
  55. data/docs/SearchApi.md +62 -0
  56. data/docs/SearchEntry.md +9 -0
  57. data/docs/SearchEntryHighlight.md +9 -0
  58. data/docs/SearchRequest.md +27 -0
  59. data/docs/UserInfo.md +9 -0
  60. data/git_push.sh +55 -0
  61. data/lib/alfresco.rb +92 -0
  62. data/lib/alfresco/api/search_api.rb +78 -0
  63. data/lib/alfresco/api_client.rb +389 -0
  64. data/lib/alfresco/api_error.rb +38 -0
  65. data/lib/alfresco/configuration.rb +209 -0
  66. data/lib/alfresco/models/content_info.rb +239 -0
  67. data/lib/alfresco/models/error.rb +188 -0
  68. data/lib/alfresco/models/error_error.rb +253 -0
  69. data/lib/alfresco/models/generic_bucket.rb +242 -0
  70. data/lib/alfresco/models/generic_bucket_bucket_info.rb +219 -0
  71. data/lib/alfresco/models/generic_facet_response.rb +211 -0
  72. data/lib/alfresco/models/generic_metric.rb +199 -0
  73. data/lib/alfresco/models/node.rb +403 -0
  74. data/lib/alfresco/models/pagination.rb +249 -0
  75. data/lib/alfresco/models/path_element.rb +197 -0
  76. data/lib/alfresco/models/path_info.rb +208 -0
  77. data/lib/alfresco/models/request_defaults.rb +283 -0
  78. data/lib/alfresco/models/request_facet_field.rb +333 -0
  79. data/lib/alfresco/models/request_facet_fields.rb +191 -0
  80. data/lib/alfresco/models/request_facet_intervals.rb +203 -0
  81. data/lib/alfresco/models/request_facet_intervals_intervals.rb +211 -0
  82. data/lib/alfresco/models/request_facet_queries.rb +179 -0
  83. data/lib/alfresco/models/request_facet_queries_inner.rb +199 -0
  84. data/lib/alfresco/models/request_facet_set.rb +233 -0
  85. data/lib/alfresco/models/request_fields.rb +179 -0
  86. data/lib/alfresco/models/request_filter_queries.rb +179 -0
  87. data/lib/alfresco/models/request_filter_queries_inner.rb +201 -0
  88. data/lib/alfresco/models/request_highlight.rb +261 -0
  89. data/lib/alfresco/models/request_highlight_fields.rb +234 -0
  90. data/lib/alfresco/models/request_include.rb +179 -0
  91. data/lib/alfresco/models/request_limits.rb +199 -0
  92. data/lib/alfresco/models/request_localization.rb +201 -0
  93. data/lib/alfresco/models/request_pagination.rb +231 -0
  94. data/lib/alfresco/models/request_pivot.rb +200 -0
  95. data/lib/alfresco/models/request_query.rb +249 -0
  96. data/lib/alfresco/models/request_range.rb +275 -0
  97. data/lib/alfresco/models/request_scope.rb +222 -0
  98. data/lib/alfresco/models/request_sort_definition.rb +179 -0
  99. data/lib/alfresco/models/request_sort_definition_inner.rb +246 -0
  100. data/lib/alfresco/models/request_spellcheck.rb +188 -0
  101. data/lib/alfresco/models/request_stats.rb +367 -0
  102. data/lib/alfresco/models/request_templates.rb +179 -0
  103. data/lib/alfresco/models/request_templates_inner.rb +199 -0
  104. data/lib/alfresco/models/response_consistency.rb +189 -0
  105. data/lib/alfresco/models/result_buckets.rb +201 -0
  106. data/lib/alfresco/models/result_buckets_buckets.rb +219 -0
  107. data/lib/alfresco/models/result_node.rb +448 -0
  108. data/lib/alfresco/models/result_set_context.rb +245 -0
  109. data/lib/alfresco/models/result_set_context_facet_queries.rb +207 -0
  110. data/lib/alfresco/models/result_set_context_spellcheck.rb +233 -0
  111. data/lib/alfresco/models/result_set_paging.rb +188 -0
  112. data/lib/alfresco/models/result_set_paging_list.rb +208 -0
  113. data/lib/alfresco/models/result_set_row_entry.rb +193 -0
  114. data/lib/alfresco/models/search_entry.rb +201 -0
  115. data/lib/alfresco/models/search_entry_highlight.rb +201 -0
  116. data/lib/alfresco/models/search_request.rb +373 -0
  117. data/lib/alfresco/models/user_info.rb +207 -0
  118. data/lib/alfresco/version.rb +15 -0
  119. data/spec/api/search_api_spec.rb +47 -0
  120. data/spec/api_client_spec.rb +226 -0
  121. data/spec/configuration_spec.rb +39 -0
  122. data/spec/models/content_info_spec.rb +66 -0
  123. data/spec/models/error_error_spec.rb +72 -0
  124. data/spec/models/error_spec.rb +42 -0
  125. data/spec/models/generic_bucket_bucket_info_spec.rb +60 -0
  126. data/spec/models/generic_bucket_spec.rb +72 -0
  127. data/spec/models/generic_facet_response_spec.rb +54 -0
  128. data/spec/models/generic_metric_spec.rb +48 -0
  129. data/spec/models/node_spec.rb +138 -0
  130. data/spec/models/pagination_spec.rb +66 -0
  131. data/spec/models/path_element_spec.rb +48 -0
  132. data/spec/models/path_info_spec.rb +54 -0
  133. data/spec/models/request_defaults_spec.rb +74 -0
  134. data/spec/models/request_facet_field_spec.rb +110 -0
  135. data/spec/models/request_facet_fields_spec.rb +42 -0
  136. data/spec/models/request_facet_intervals_intervals_spec.rb +54 -0
  137. data/spec/models/request_facet_intervals_spec.rb +48 -0
  138. data/spec/models/request_facet_queries_inner_spec.rb +48 -0
  139. data/spec/models/request_facet_queries_spec.rb +36 -0
  140. data/spec/models/request_facet_set_spec.rb +66 -0
  141. data/spec/models/request_fields_spec.rb +36 -0
  142. data/spec/models/request_filter_queries_inner_spec.rb +48 -0
  143. data/spec/models/request_filter_queries_spec.rb +36 -0
  144. data/spec/models/request_highlight_fields_spec.rb +72 -0
  145. data/spec/models/request_highlight_spec.rb +84 -0
  146. data/spec/models/request_include_spec.rb +36 -0
  147. data/spec/models/request_limits_spec.rb +48 -0
  148. data/spec/models/request_localization_spec.rb +48 -0
  149. data/spec/models/request_pagination_spec.rb +48 -0
  150. data/spec/models/request_pivot_spec.rb +48 -0
  151. data/spec/models/request_query_spec.rb +58 -0
  152. data/spec/models/request_range_spec.rb +90 -0
  153. data/spec/models/request_scope_spec.rb +46 -0
  154. data/spec/models/request_sort_definition_inner_spec.rb +58 -0
  155. data/spec/models/request_sort_definition_spec.rb +36 -0
  156. data/spec/models/request_spellcheck_spec.rb +42 -0
  157. data/spec/models/request_stats_spec.rb +132 -0
  158. data/spec/models/request_templates_inner_spec.rb +48 -0
  159. data/spec/models/request_templates_spec.rb +36 -0
  160. data/spec/models/response_consistency_spec.rb +42 -0
  161. data/spec/models/result_buckets_buckets_spec.rb +60 -0
  162. data/spec/models/result_buckets_spec.rb +48 -0
  163. data/spec/models/result_node_spec.rb +168 -0
  164. data/spec/models/result_set_context_facet_queries_spec.rb +54 -0
  165. data/spec/models/result_set_context_spec.rb +72 -0
  166. data/spec/models/result_set_context_spellcheck_spec.rb +52 -0
  167. data/spec/models/result_set_paging_list_spec.rb +54 -0
  168. data/spec/models/result_set_paging_spec.rb +42 -0
  169. data/spec/models/result_set_row_entry_spec.rb +42 -0
  170. data/spec/models/search_entry_highlight_spec.rb +48 -0
  171. data/spec/models/search_entry_spec.rb +48 -0
  172. data/spec/models/search_request_spec.rb +156 -0
  173. data/spec/models/user_info_spec.rb +48 -0
  174. data/spec/spec_helper.rb +111 -0
  175. metadata +455 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c378ea23a84429653dcb3f433662ccc63567fc49
4
+ data.tar.gz: 91bb37ff28c05ea19e593331cb353121fcaaf834
5
+ SHA512:
6
+ metadata.gz: d2d2416078b3448194c9826da890c47bda962ee9f19310a375b9a40936df392e952263d8fbb0172417ef991ceb820c8d398fe1877b93f8f026cf560ece0da77f
7
+ data.tar.gz: 4b8d9bd9005af3950e6eeabc93103bd1e6d08e6975ae6dd3d46e65eb60bcf4470bbcd18523df8595e71256911b3f99987ab2850636862cde1d9c52ff45a2a3a0
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,69 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ alfresco (1.0.0)
5
+ json (~> 2.1, >= 2.1.0)
6
+ typhoeus (~> 1.0, >= 1.0.1)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ ZenTest (4.11.1)
12
+ addressable (2.5.2)
13
+ public_suffix (>= 2.0.2, < 4.0)
14
+ autotest (4.4.6)
15
+ ZenTest (>= 4.4.1)
16
+ autotest-fsevent (0.2.13)
17
+ sys-uname
18
+ autotest-growl (0.2.16)
19
+ autotest-rails-pure (4.1.2)
20
+ crack (0.4.3)
21
+ safe_yaml (~> 1.0.0)
22
+ diff-lcs (1.3)
23
+ ethon (0.11.0)
24
+ ffi (>= 1.3.0)
25
+ ffi (1.9.18)
26
+ hashdiff (0.3.7)
27
+ json (2.1.0)
28
+ public_suffix (3.0.1)
29
+ rake (12.0.0)
30
+ rspec (3.7.0)
31
+ rspec-core (~> 3.7.0)
32
+ rspec-expectations (~> 3.7.0)
33
+ rspec-mocks (~> 3.7.0)
34
+ rspec-core (3.7.1)
35
+ rspec-support (~> 3.7.0)
36
+ rspec-expectations (3.7.0)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.7.0)
39
+ rspec-mocks (3.7.0)
40
+ diff-lcs (>= 1.2.0, < 2.0)
41
+ rspec-support (~> 3.7.0)
42
+ rspec-support (3.7.0)
43
+ safe_yaml (1.0.4)
44
+ sys-uname (1.0.3)
45
+ ffi (>= 1.0.0)
46
+ typhoeus (1.3.0)
47
+ ethon (>= 0.9.0)
48
+ vcr (3.0.3)
49
+ webmock (1.24.6)
50
+ addressable (>= 2.3.6)
51
+ crack (>= 0.3.2)
52
+ hashdiff
53
+
54
+ PLATFORMS
55
+ ruby
56
+
57
+ DEPENDENCIES
58
+ autotest (~> 4.4, >= 4.4.6)
59
+ autotest-fsevent (~> 0.2, >= 0.2.12)
60
+ autotest-growl (~> 0.2, >= 0.2.16)
61
+ autotest-rails-pure (~> 4.1, >= 4.1.2)
62
+ rake (~> 12.0.0)
63
+ rspec (~> 3.6, >= 3.6.0)
64
+ alfresco!
65
+ vcr (~> 3.0, >= 3.0.1)
66
+ webmock (~> 1.24, >= 1.24.3)
67
+
68
+ BUNDLED WITH
69
+ 1.16.0
data/README.md ADDED
@@ -0,0 +1,119 @@
1
+ # alfresco
2
+
3
+ Alfresco - the Ruby gem for the Alfresco Content Services REST API
4
+
5
+ **Search API** Provides access to the search features of Alfresco Content Services.
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 1
10
+ - Package version: 1.0.0
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ Add this to the Gemfile:
16
+
17
+ gem 'alfresco', '~> 1.0.0'
18
+
19
+ ## Getting Started
20
+
21
+ Please follow the [installation](#installation) procedure and then run the following code:
22
+ ```ruby
23
+ # Load the gem
24
+ require 'alfresco'
25
+
26
+ # Setup authorization
27
+ Alfresco.configure do |config|
28
+ # Configure HTTP basic authorization: basicAuth
29
+ config.host = 'YOUR HOST'
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = Alfresco::SearchApi.new
35
+
36
+ query_body = Alfresco::SearchRequest.new # SearchRequest | Generic query API
37
+
38
+
39
+ begin
40
+ #Searches Alfresco
41
+ result = api_instance.search(query_body)
42
+ p result
43
+ rescue Alfresco::ApiError => e
44
+ puts "Exception when calling SearchApi->search: #{e}"
45
+ end
46
+
47
+ ```
48
+
49
+ ## Documentation for API Endpoints
50
+
51
+ All URIs are relative to *https://localhost/alfresco/api/-default-/public/search/versions/1*
52
+
53
+ Class | Method | HTTP request | Description
54
+ ------------ | ------------- | ------------- | -------------
55
+ *Alfresco::SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Searches Alfresco
56
+
57
+
58
+ ## Documentation for Models
59
+
60
+ - [Alfresco::ContentInfo](docs/ContentInfo.md)
61
+ - [Alfresco::Error](docs/Error.md)
62
+ - [Alfresco::ErrorError](docs/ErrorError.md)
63
+ - [Alfresco::GenericBucket](docs/GenericBucket.md)
64
+ - [Alfresco::GenericBucketBucketInfo](docs/GenericBucketBucketInfo.md)
65
+ - [Alfresco::GenericFacetResponse](docs/GenericFacetResponse.md)
66
+ - [Alfresco::GenericMetric](docs/GenericMetric.md)
67
+ - [Alfresco::Node](docs/Node.md)
68
+ - [Alfresco::Pagination](docs/Pagination.md)
69
+ - [Alfresco::PathElement](docs/PathElement.md)
70
+ - [Alfresco::PathInfo](docs/PathInfo.md)
71
+ - [Alfresco::RequestDefaults](docs/RequestDefaults.md)
72
+ - [Alfresco::RequestFacetField](docs/RequestFacetField.md)
73
+ - [Alfresco::RequestFacetFields](docs/RequestFacetFields.md)
74
+ - [Alfresco::RequestFacetIntervals](docs/RequestFacetIntervals.md)
75
+ - [Alfresco::RequestFacetIntervalsIntervals](docs/RequestFacetIntervalsIntervals.md)
76
+ - [Alfresco::RequestFacetQueries](docs/RequestFacetQueries.md)
77
+ - [Alfresco::RequestFacetQueriesInner](docs/RequestFacetQueriesInner.md)
78
+ - [Alfresco::RequestFacetSet](docs/RequestFacetSet.md)
79
+ - [Alfresco::RequestFields](docs/RequestFields.md)
80
+ - [Alfresco::RequestFilterQueries](docs/RequestFilterQueries.md)
81
+ - [Alfresco::RequestFilterQueriesInner](docs/RequestFilterQueriesInner.md)
82
+ - [Alfresco::RequestHighlight](docs/RequestHighlight.md)
83
+ - [Alfresco::RequestHighlightFields](docs/RequestHighlightFields.md)
84
+ - [Alfresco::RequestInclude](docs/RequestInclude.md)
85
+ - [Alfresco::RequestLimits](docs/RequestLimits.md)
86
+ - [Alfresco::RequestLocalization](docs/RequestLocalization.md)
87
+ - [Alfresco::RequestPagination](docs/RequestPagination.md)
88
+ - [Alfresco::RequestPivot](docs/RequestPivot.md)
89
+ - [Alfresco::RequestQuery](docs/RequestQuery.md)
90
+ - [Alfresco::RequestRange](docs/RequestRange.md)
91
+ - [Alfresco::RequestScope](docs/RequestScope.md)
92
+ - [Alfresco::RequestSortDefinition](docs/RequestSortDefinition.md)
93
+ - [Alfresco::RequestSortDefinitionInner](docs/RequestSortDefinitionInner.md)
94
+ - [Alfresco::RequestSpellcheck](docs/RequestSpellcheck.md)
95
+ - [Alfresco::RequestStats](docs/RequestStats.md)
96
+ - [Alfresco::RequestTemplates](docs/RequestTemplates.md)
97
+ - [Alfresco::RequestTemplatesInner](docs/RequestTemplatesInner.md)
98
+ - [Alfresco::ResponseConsistency](docs/ResponseConsistency.md)
99
+ - [Alfresco::ResultBuckets](docs/ResultBuckets.md)
100
+ - [Alfresco::ResultBucketsBuckets](docs/ResultBucketsBuckets.md)
101
+ - [Alfresco::ResultNode](docs/ResultNode.md)
102
+ - [Alfresco::ResultSetContext](docs/ResultSetContext.md)
103
+ - [Alfresco::ResultSetContextFacetQueries](docs/ResultSetContextFacetQueries.md)
104
+ - [Alfresco::ResultSetContextSpellcheck](docs/ResultSetContextSpellcheck.md)
105
+ - [Alfresco::ResultSetPaging](docs/ResultSetPaging.md)
106
+ - [Alfresco::ResultSetPagingList](docs/ResultSetPagingList.md)
107
+ - [Alfresco::ResultSetRowEntry](docs/ResultSetRowEntry.md)
108
+ - [Alfresco::SearchEntry](docs/SearchEntry.md)
109
+ - [Alfresco::SearchEntryHighlight](docs/SearchEntryHighlight.md)
110
+ - [Alfresco::SearchRequest](docs/SearchRequest.md)
111
+ - [Alfresco::UserInfo](docs/UserInfo.md)
112
+
113
+
114
+ ## Documentation for Authorization
115
+
116
+
117
+ ### basicAuth
118
+
119
+ - **Type**: HTTP basic authentication
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
data/alfresco.gemspec ADDED
@@ -0,0 +1,45 @@
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ =begin
4
+ #Alfresco Content Services REST API
5
+
6
+ #**Search API** Provides access to the search features of Alfresco Content Services.
7
+
8
+ OpenAPI spec version: 1
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 2.2.3
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "alfresco/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "alfresco"
20
+ s.version = Alfresco::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Élisson Michael", "Swagger-Codegen"]
23
+ s.email = ["[email protected]"]
24
+ s.homepage = "https://github.com/rhuanbarreto/alfresco-ruby-client"
25
+ s.summary = "Alfresco Content Services REST API Ruby Gem"
26
+ s.description = "**Search API** Provides access to the search features of Alfresco Content Services. "
27
+ s.license = "Nonstandard"
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
35
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
36
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
37
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
38
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
+
41
+ s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
42
+ s.test_files = `find spec/*`.split("\n")
43
+ s.executables = []
44
+ s.require_paths = ["lib"]
45
+ end
data/docs/ContentInfo.md ADDED
@@ -0,0 +1,12 @@
1
+ # Alfresco::ContentInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **mime_type** | **String** | |
7
+ **mime_type_name** | **String** | |
8
+ **size_in_bytes** | **Integer** | |
9
+ **encoding** | **String** | | [optional]
10
+ **mime_type_group** | **String** | | [optional]
11
+
12
+
data/docs/Error.md ADDED
@@ -0,0 +1,8 @@
1
+ # Alfresco::Error
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**ErrorError**](ErrorError.md) | | [optional]
7
+
8
+
data/docs/ErrorError.md ADDED
@@ -0,0 +1,13 @@
1
+ # Alfresco::ErrorError
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error_key** | **String** | | [optional]
7
+ **status_code** | **Integer** | |
8
+ **brief_summary** | **String** | |
9
+ **stack_trace** | **String** | |
10
+ **description_url** | **String** | |
11
+ **log_id** | **String** | | [optional]
12
+
13
+
data/docs/GenericBucket.md ADDED
@@ -0,0 +1,13 @@
1
+ # Alfresco::GenericBucket
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **label** | **String** | The bucket label | [optional]
7
+ **filter_query** | **String** | The filter query you can use to apply this facet | [optional]
8
+ **display** | **Object** | An optional field for additional display information | [optional]
9
+ **metrics** | [**Array&lt;GenericMetric&gt;**](GenericMetric.md) | An array of buckets and values | [optional]
10
+ **facets** | **Array&lt;Object&gt;** | Additional list of nested facets | [optional]
11
+ **bucket_info** | [**GenericBucketBucketInfo**](GenericBucketBucketInfo.md) | | [optional]
12
+
13
+
data/docs/GenericBucketBucketInfo.md ADDED
@@ -0,0 +1,11 @@
1
+ # Alfresco::GenericBucketBucketInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **start** | **String** | The start of range | [optional]
7
+ **start_inclusive** | **BOOLEAN** | Includes values greater or equal to \&quot;start\&quot; | [optional]
8
+ **_end** | **String** | The end of range | [optional]
9
+ **end_inclusive** | **BOOLEAN** | Includes values less than or equal to \&quot;end\&quot; | [optional]
10
+
11
+
data/docs/GenericFacetResponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # Alfresco::GenericFacetResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | The facet type, eg. interval, range, pivot, stats | [optional]
7
+ **label** | **String** | The field name or its explicit label, if provided on the request | [optional]
8
+ **buckets** | [**Array&lt;GenericBucket&gt;**](GenericBucket.md) | An array of buckets and values | [optional]
9
+
10
+
data/docs/GenericMetric.md ADDED
@@ -0,0 +1,9 @@
1
+ # Alfresco::GenericMetric
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | The type of metric, e.g. count | [optional]
7
+ **value** | **Object** | The metric value, e.g. {\&quot;count\&quot;: 34} | [optional]
8
+
9
+
data/docs/Node.md ADDED
@@ -0,0 +1,24 @@
1
+ # Alfresco::Node
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | |
7
+ **name** | **String** | The name must not contain spaces or the following special characters: * \&quot; &lt; &gt; \\ / ? : and |. The character . must not be used at the end of the name. |
8
+ **node_type** | **String** | |
9
+ **is_folder** | **BOOLEAN** | |
10
+ **is_file** | **BOOLEAN** | |
11
+ **is_locked** | **BOOLEAN** | | [optional] [default to false]
12
+ **modified_at** | **DateTime** | |
13
+ **modified_by_user** | [**UserInfo**](UserInfo.md) | |
14
+ **created_at** | **DateTime** | |
15
+ **created_by_user** | [**UserInfo**](UserInfo.md) | |
16
+ **parent_id** | **String** | | [optional]
17
+ **is_link** | **BOOLEAN** | | [optional]
18
+ **content** | [**ContentInfo**](ContentInfo.md) | | [optional]
19
+ **aspect_names** | **Array&lt;String&gt;** | | [optional]
20
+ **properties** | **Object** | | [optional]
21
+ **allowable_operations** | **Array&lt;String&gt;** | | [optional]
22
+ **path** | [**PathInfo**](PathInfo.md) | | [optional]
23
+
24
+
data/docs/Pagination.md ADDED
@@ -0,0 +1,12 @@
1
+ # Alfresco::Pagination
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **count** | **Integer** | The number of objects in the entries array. |
7
+ **has_more_items** | **BOOLEAN** | A boolean value which is **true** if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the **skipCount** or the **maxItems** parameter will return more entities. |
8
+ **total_items** | **Integer** | An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present. | [optional]
9
+ **skip_count** | **Integer** | An integer describing how many entities exist in the collection before those included in this list. |
10
+ **max_items** | **Integer** | The value of the **maxItems** parameter used to generate this list, or if there was no **maxItems** parameter the default value is 100 |
11
+
12
+
data/docs/PathElement.md ADDED
@@ -0,0 +1,9 @@
1
+ # Alfresco::PathElement
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
+
9
+
data/docs/PathInfo.md ADDED
@@ -0,0 +1,10 @@
1
+ # Alfresco::PathInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **elements** | [**Array&lt;PathElement&gt;**](PathElement.md) | | [optional]
7
+ **name** | **String** | | [optional]
8
+ **is_complete** | **BOOLEAN** | | [optional]
9
+
10
+
data/docs/RequestDefaults.md ADDED
@@ -0,0 +1,12 @@
1
+ # Alfresco::RequestDefaults
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **text_attributes** | **Array&lt;String&gt;** | A list of query fields/properties used to expand TEXT: queries. The default is cm:content. You could include all content properties using d:content or list all individual content properties or types. As more terms are included the query size, complexity, memory impact and query time will increase. | [optional]
7
+ **default_fts_operator** | **String** | The default way to combine query parts when AND or OR is not explicitly stated - includes ! - + one two three (one two three) | [optional] [default to &quot;AND&quot;]
8
+ **default_fts_field_operator** | **String** | The default way to combine query parts in field query groups when AND or OR is not explicitly stated - includes ! - + FIELD:(one two three) | [optional] [default to &quot;AND&quot;]
9
+ **namespace** | **String** | The default name space to use if one is not provided | [optional] [default to &quot;cm&quot;]
10
+ **default_field_name** | **String** | | [optional] [default to &quot;TEXT&quot;]
11
+
12
+
data/docs/RequestFacetField.md ADDED
@@ -0,0 +1,18 @@
1
+ # Alfresco::RequestFacetField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field** | **String** | The facet field | [optional]
7
+ **label** | **String** | A label to include in place of the facet field | [optional]
8
+ **prefix** | **String** | Restricts the possible constraints to only indexed values with a specified prefix. | [optional]
9
+ **sort** | **String** | | [optional]
10
+ **method** | **String** | | [optional]
11
+ **missing** | **BOOLEAN** | When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints). | [optional] [default to false]
12
+ **limit** | **Integer** | | [optional]
13
+ **offset** | **Integer** | | [optional]
14
+ **mincount** | **Integer** | The minimum count required for a facet field to be included in the response. | [optional]
15
+ **facet_enum_cache_min_df** | **Integer** | | [optional]
16
+ **exclude_filters** | **Array&lt;String&gt;** | Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting. | [optional]
17
+
18
+
OSZAR »