alfresco 1.0.0

data/docs/SearchEntry.md

@@ -0,0 +1,9 @@
+# Alfresco::SearchEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Float** | The score for this row | [optional] 
+**highlight** | [**Array<SearchEntryHighlight>**](SearchEntryHighlight.md) | Highlight fragments if requested and available. A match can happen in any of the requested field.  | [optional] 
+
+

data/docs/SearchEntryHighlight.md

@@ -0,0 +1,9 @@
+# Alfresco::SearchEntryHighlight
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The field where a match occured (one of the fields defined on the request) | [optional] 
+**snippets** | **Array<String>** | Any number of snippets for the specified field highlighting the matching text | [optional] 
+
+

data/docs/SearchRequest.md

@@ -0,0 +1,27 @@
+# Alfresco::SearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | [**RequestQuery**](RequestQuery.md) |  | 
+**paging** | [**RequestPagination**](RequestPagination.md) |  | [optional] 
+**include** | [**RequestInclude**](RequestInclude.md) |  | [optional] 
+**include_request** | **BOOLEAN** | When true, include the original request in the response | [optional] [default to false]
+**fields** | [**RequestFields**](RequestFields.md) |  | [optional] 
+**sort** | [**RequestSortDefinition**](RequestSortDefinition.md) |  | [optional] 
+**templates** | [**RequestTemplates**](RequestTemplates.md) |  | [optional] 
+**defaults** | [**RequestDefaults**](RequestDefaults.md) |  | [optional] 
+**localization** | [**RequestLocalization**](RequestLocalization.md) |  | [optional] 
+**filter_queries** | [**RequestFilterQueries**](RequestFilterQueries.md) |  | [optional] 
+**facet_queries** | [**RequestFacetQueries**](RequestFacetQueries.md) |  | [optional] 
+**facet_fields** | [**RequestFacetFields**](RequestFacetFields.md) |  | [optional] 
+**facet_intervals** | [**RequestFacetIntervals**](RequestFacetIntervals.md) |  | [optional] 
+**pivots** | [**Array<RequestPivot>**](RequestPivot.md) |  | [optional] 
+**stats** | [**Array<RequestStats>**](RequestStats.md) |  | [optional] 
+**spellcheck** | [**RequestSpellcheck**](RequestSpellcheck.md) |  | [optional] 
+**scope** | [**RequestScope**](RequestScope.md) |  | [optional] 
+**limits** | [**RequestLimits**](RequestLimits.md) |  | [optional] 
+**highlight** | [**RequestHighlight**](RequestHighlight.md) |  | [optional] 
+**ranges** | [**Array<RequestRange>**](RequestRange.md) |  | [optional] 
+
+

data/docs/UserInfo.md

@@ -0,0 +1,9 @@
+# Alfresco::UserInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** |  | 
+**id** | **String** |  | 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/alfresco.rb

@@ -0,0 +1,92 @@
+=begin
+#Alfresco Content Services REST API
+
+#**Search API** Provides access to the search features of Alfresco Content Services. 
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+# Common files
+require 'alfresco/api_client'
+require 'alfresco/api_error'
+require 'alfresco/version'
+require 'alfresco/configuration'
+
+# Models
+require 'alfresco/models/content_info'
+require 'alfresco/models/error'
+require 'alfresco/models/error_error'
+require 'alfresco/models/generic_bucket'
+require 'alfresco/models/generic_bucket_bucket_info'
+require 'alfresco/models/generic_facet_response'
+require 'alfresco/models/generic_metric'
+require 'alfresco/models/node'
+require 'alfresco/models/pagination'
+require 'alfresco/models/path_element'
+require 'alfresco/models/path_info'
+require 'alfresco/models/request_defaults'
+require 'alfresco/models/request_facet_field'
+require 'alfresco/models/request_facet_fields'
+require 'alfresco/models/request_facet_intervals'
+require 'alfresco/models/request_facet_intervals_intervals'
+require 'alfresco/models/request_facet_queries'
+require 'alfresco/models/request_facet_queries_inner'
+require 'alfresco/models/request_facet_set'
+require 'alfresco/models/request_fields'
+require 'alfresco/models/request_filter_queries'
+require 'alfresco/models/request_filter_queries_inner'
+require 'alfresco/models/request_highlight'
+require 'alfresco/models/request_highlight_fields'
+require 'alfresco/models/request_include'
+require 'alfresco/models/request_limits'
+require 'alfresco/models/request_localization'
+require 'alfresco/models/request_pagination'
+require 'alfresco/models/request_pivot'
+require 'alfresco/models/request_query'
+require 'alfresco/models/request_range'
+require 'alfresco/models/request_scope'
+require 'alfresco/models/request_sort_definition'
+require 'alfresco/models/request_sort_definition_inner'
+require 'alfresco/models/request_spellcheck'
+require 'alfresco/models/request_stats'
+require 'alfresco/models/request_templates'
+require 'alfresco/models/request_templates_inner'
+require 'alfresco/models/response_consistency'
+require 'alfresco/models/result_buckets'
+require 'alfresco/models/result_buckets_buckets'
+require 'alfresco/models/result_node'
+require 'alfresco/models/result_set_context'
+require 'alfresco/models/result_set_context_facet_queries'
+require 'alfresco/models/result_set_context_spellcheck'
+require 'alfresco/models/result_set_paging'
+require 'alfresco/models/result_set_paging_list'
+require 'alfresco/models/result_set_row_entry'
+require 'alfresco/models/search_entry'
+require 'alfresco/models/search_entry_highlight'
+require 'alfresco/models/search_request'
+require 'alfresco/models/user_info'
+
+# APIs
+require 'alfresco/api/search_api'
+
+module Alfresco
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Alfresco.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/alfresco/api/search_api.rb

@@ -0,0 +1,78 @@
+=begin
+#Alfresco Content Services REST API
+
+#**Search API** Provides access to the search features of Alfresco Content Services. 
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require "uri"
+
+module Alfresco
+  class SearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Searches Alfresco
+    # **Note**: this endpoint is available in Alfresco 5.2 and newer versions. **You specify all the parameters in this API in a JSON body**, URL parameters are not supported. A basic query looks like this: ```JSON {   \"query\": {     \"query\": \"foo\"   } } ``` **Note:** These are the minimum possible query parameters. The default search language is **afts** ([Alfresco Full Text Search](http://docs.alfresco.com/5.1/concepts/rm-searchsyntax-intro.html)), but you can also specify **cmis**, and **lucene**. A basic CMIS query looks like this: ```JSON {   \"query\": {     \"query\": \"select * from cmis:folder\",     \"language\": \"cmis\"   } } ``` By default, **results are limited to the first 100.** Results can be restricted using \"paging\". For example: ```JSON \"paging\": {   \"maxItems\": \"50\",   \"skipCount\": \"28\" } ``` This example would ensure that results are **limited by Final Size**, skipping the first 28 results and returning the next 50. Alternatively, you can limit the results by using the **limits JSON body parameter**. For example, ```JSON \"limits\": {   \"permissionEvaluationTime\": 20000,   \"permissionEvaluationCount\": 2000 } ``` You can use the **include JSON body parameter** to return additional information. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"include\": [\"aspectNames\", \"properties\", \"isLink\"] ``` You can use the **fields JSON body parameter** to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"fields\": [\"id\", \"name\", \"search\"] ``` You can sort the results using the **sort JSON body parameter**, for example: ```JSON \"sort\": [{\"type\":\"FIELD\", \"field\":\"cm:description\", \"ascending\":\"true\"}] ``` **Note:** the **sort** parameter is not supported for CMIS queries. By default, search uses the **\"nodes\" location**, which is the **content store known as workspace://SpacesStore**. To change the scope to another location you can use the **locations JSON body parameter**. You can specify either **nodes** (the default), **versions** or **deleted-nodes**.  For example, ```JSON \"scope\": {     \"locations\": [\"deleted-nodes\"] } ``` You can specify templates using the **templates JSON body parameter**, for example: ```JSON \"templates\": [{\"name\": \"_PERSON\",\"template\": \"|%firstName OR |%lastName OR |%userName\"},               {\"name\": \"mytemplate\",\"template\": \"%cm:content\"}] ``` **Note: Spell checking only works on Search Services (Solr 6) if you have already enabled suggestions.** For **spell checking** you can use a query like this: ```JSON {   \"query\": {     \"query\": \"cm:title:alfrezco\"   },   \"spellcheck\": {\"query\": \"alfrezco\"} } ``` If you are already specifying \"userQuery\" then the following may be easier and produces the same result : ```JSON {   \"query\": {     \"query\": \"cm:title:alfrezco\",     \"userQuery\": \"alfrezco\"   },   \"spellcheck\": {} } ``` The spellcheck response includes a spellCheck context like this: ```JSON \"context\": {   \"spellCheck\": {     \"type\": \"searchInsteadFor\",     \"suggestions\": [\"alfresco\"]   } }, ``` To specify defaults, you  use a **defaults JSON body parameter**, for example: ```JSON \"defaults\": {   \"textAttributes\": [     \"cm:content\", \"cm:name\"   ],   \"defaultFTSOperator\": \"AND\",   \"defaultFTSFieldOperator\": \"OR\",   \"namespace\": \"cm\",   \"defaultFieldName\": \"PATH\" } ``` You can specify several filter queries using the **filterQueries JSON body parameter**, for example: ```JSON \"filterQueries\": [{\"query\": \"TYPE:'cm:folder'\"},{\"query\": \"cm:creator:mjackson\"}] ``` You can specify several facet queries using the **facetQueries JSON body parameter**, for example: ```JSON \"facetQueries\": [{\"query\": \"created:2016\",\"label\": \"CreatedThisYear\"}] ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": {   \"facetQueries\": [     {\"label\": \"CreatedThisYear\",\"count\": 3}   ] }, ``` A complete query for facetting via the content.size field looks this: ```JSON {   \"query\": {     \"query\": \"presentation\",     \"language\": \"afts\"   },     \"facetQueries\": [         {\"query\": \"content.size:[0 TO 10240]\", \"label\": \"xtra small\"},         {\"query\": \"content.size:[10240 TO 102400]\", \"label\": \"small\"},         {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\"},         {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\"},         {\"query\": \"content.size:[16777216 TO 134217728]\", \"label\": \"xtra large\"},         {\"query\": \"content.size:[134217728 TO MAX]\", \"label\": \"XX large\"}   ],     \"facetFields\": {\"facets\": [{\"field\": \"'content.size'\"}]} } ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": {   \"facetQueries\": [     { \"label\": \"small\",\"count\": 2 },     { \"label\": \"large\",\"count\": 0 },     { \"label\": \"xtra small\",\"count\": 5 },     { \"label\": \"xtra large\",\"count\": 56},     { \"label\": \"medium\",\"count\": 4 },     { \"label\": \"XX large\", \"count\": 1 }   ] }, ``` You can specify several facet fields using the **facetFields JSON body parameter**, for example: ```JSON \"facetFields\": {\"facets\": [{\"field\": \"creator\", \"mincount\": 1}, {\"field\": \"modifier\", \"mincount\": 1}]} ``` The response will contain a matching \"context\" section, the \"label\" will match the facet field. ```JSON \"context\": {    \"facetsFields\": [      {  \"label\": \"creator\",         \"buckets\": [           { \"label\": \"System\", \"count\": 75 },           { \"label\": \"mjackson\", \"count\": 5 }         ]},      {  \"label\": \"modifier\",         \"buckets\": [           { \"label\": \"System\", \"count\": 72 },           { \"label\": \"mjackson\", \"count\": 5 },           { \"label\": \"admin\", \"count\": 3 }         ]}    ] }, ``` Grouping facet queries that go together can be done by specifying the group label in the fact queries as follow: ```JSON     {         \"query\": {             \"query\": \"presentation\"         },         \"facetQueries\": [             {\"query\": \"content.size:[0 TO 102400]\", \"label\": \"small\", \"group\":\"foo\"},             {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\",\"group\":\"foo\"},             {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\",\"group\":\"foo\"}         ]     } ``` The above query returns the results a faceted field grouped under the label foo: ```JSON {     \"context\": {\"facetsFields\": [{         \"label\": \"foo\",         \"buckets\": [             {                 \"count\": 109,                 \"label\": \"small\",                 \"filterQuery\": \"content.size:[0 TO 102400]\"             },             {                 \"count\": 0,                 \"label\": \"large\",                 \"filterQuery\": \"content.size:[1048576 TO 16777216]\"             },             {                 \"count\": 0,                 \"label\": \"medium\",                 \"filterQuery\": \"content.size:[102400 TO 1048576]\"             }         ]     }] } ``` Range Faceting is supported by the **ranges JSON body parameter**, for example: ```JSON     {         \"query\": {             \"query\": \"presentation\"         },         \"ranges\": [         {             \"field\": \"content.size\",              \"start\": \"0\",              \"end\": \"100\",              \"gap\": \"20\",              \"hardend\": true         },         {             \"field\": \"created\",             \"start\": \"2015-09-29T10:45:15.729Z\",             \"end\": \"2016-09-29T10:45:15.729Z\",             \"gap\": \"+100DAY\"         }]     } ``` An example query for **search highlighting** could look like this: ```JSON {   \"query\": {     \"query\": \"description:workflow\",     \"userQuery\":\"workflow\"   },   \"highlight\": {     \"prefix\": \"¿\",     \"postfix\": \"?\",     \"mergeContiguous\": true,     \"fields\": [       {         \"field\": \"cm:title\"       },       {         \"field\": \"description\",         \"prefix\": \"(\",         \"postfix\": \")\"       }     ]   } } ``` The example above changes the highlighting prefix and postfix from the  default <em> for all fields to ¿? and just for the \"description\" field to ().  The hightlight information is added in each node entry response; here is  an example partial response: ``` \"entry\": {         \"createdAt\": \"2016-10-12T15:24:31.202+0000\",         \"isFolder\": true,         \"search\": {           \"score\": 1,           \"highlight\": [             {               \"field\": \"cm:title\",               \"snippets\": [                 \"Customized ¿Workflow? Process Definitions\"               ]             },             {               \"field\": \"description\",               \"snippets\": [                 \"Customized (Workflow) Process Definitions\"               ]             }           ]       }, ``` 
+    # @param query_body Generic query API 
+    # @param [Hash] opts the optional parameters
+    # @return [ResultSetPaging]
+    def search(query_body, opts = {})
+      data, _status_code, _headers = search_with_http_info(query_body, opts)
+      return data
+    end
+
+    # Searches Alfresco
+    # **Note**: this endpoint is available in Alfresco 5.2 and newer versions. **You specify all the parameters in this API in a JSON body**, URL parameters are not supported. A basic query looks like this: &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;foo\&quot;   } } &#x60;&#x60;&#x60; **Note:** These are the minimum possible query parameters. The default search language is **afts** ([Alfresco Full Text Search](http://docs.alfresco.com/5.1/concepts/rm-searchsyntax-intro.html)), but you can also specify **cmis**, and **lucene**. A basic CMIS query looks like this: &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;select * from cmis:folder\&quot;,     \&quot;language\&quot;: \&quot;cmis\&quot;   } } &#x60;&#x60;&#x60; By default, **results are limited to the first 100.** Results can be restricted using \&quot;paging\&quot;. For example: &#x60;&#x60;&#x60;JSON \&quot;paging\&quot;: {   \&quot;maxItems\&quot;: \&quot;50\&quot;,   \&quot;skipCount\&quot;: \&quot;28\&quot; } &#x60;&#x60;&#x60; This example would ensure that results are **limited by Final Size**, skipping the first 28 results and returning the next 50. Alternatively, you can limit the results by using the **limits JSON body parameter**. For example, &#x60;&#x60;&#x60;JSON \&quot;limits\&quot;: {   \&quot;permissionEvaluationTime\&quot;: 20000,   \&quot;permissionEvaluationCount\&quot;: 2000 } &#x60;&#x60;&#x60; You can use the **include JSON body parameter** to return additional information. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: &#x60;&#x60;&#x60;JSON \&quot;include\&quot;: [\&quot;aspectNames\&quot;, \&quot;properties\&quot;, \&quot;isLink\&quot;] &#x60;&#x60;&#x60; You can use the **fields JSON body parameter** to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: &#x60;&#x60;&#x60;JSON \&quot;fields\&quot;: [\&quot;id\&quot;, \&quot;name\&quot;, \&quot;search\&quot;] &#x60;&#x60;&#x60; You can sort the results using the **sort JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;sort\&quot;: [{\&quot;type\&quot;:\&quot;FIELD\&quot;, \&quot;field\&quot;:\&quot;cm:description\&quot;, \&quot;ascending\&quot;:\&quot;true\&quot;}] &#x60;&#x60;&#x60; **Note:** the **sort** parameter is not supported for CMIS queries. By default, search uses the **\&quot;nodes\&quot; location**, which is the **content store known as workspace://SpacesStore**. To change the scope to another location you can use the **locations JSON body parameter**. You can specify either **nodes** (the default), **versions** or **deleted-nodes**.  For example, &#x60;&#x60;&#x60;JSON \&quot;scope\&quot;: {     \&quot;locations\&quot;: [\&quot;deleted-nodes\&quot;] } &#x60;&#x60;&#x60; You can specify templates using the **templates JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;templates\&quot;: [{\&quot;name\&quot;: \&quot;_PERSON\&quot;,\&quot;template\&quot;: \&quot;|%firstName OR |%lastName OR |%userName\&quot;},               {\&quot;name\&quot;: \&quot;mytemplate\&quot;,\&quot;template\&quot;: \&quot;%cm:content\&quot;}] &#x60;&#x60;&#x60; **Note: Spell checking only works on Search Services (Solr 6) if you have already enabled suggestions.** For **spell checking** you can use a query like this: &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;cm:title:alfrezco\&quot;   },   \&quot;spellcheck\&quot;: {\&quot;query\&quot;: \&quot;alfrezco\&quot;} } &#x60;&#x60;&#x60; If you are already specifying \&quot;userQuery\&quot; then the following may be easier and produces the same result : &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;cm:title:alfrezco\&quot;,     \&quot;userQuery\&quot;: \&quot;alfrezco\&quot;   },   \&quot;spellcheck\&quot;: {} } &#x60;&#x60;&#x60; The spellcheck response includes a spellCheck context like this: &#x60;&#x60;&#x60;JSON \&quot;context\&quot;: {   \&quot;spellCheck\&quot;: {     \&quot;type\&quot;: \&quot;searchInsteadFor\&quot;,     \&quot;suggestions\&quot;: [\&quot;alfresco\&quot;]   } }, &#x60;&#x60;&#x60; To specify defaults, you  use a **defaults JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;defaults\&quot;: {   \&quot;textAttributes\&quot;: [     \&quot;cm:content\&quot;, \&quot;cm:name\&quot;   ],   \&quot;defaultFTSOperator\&quot;: \&quot;AND\&quot;,   \&quot;defaultFTSFieldOperator\&quot;: \&quot;OR\&quot;,   \&quot;namespace\&quot;: \&quot;cm\&quot;,   \&quot;defaultFieldName\&quot;: \&quot;PATH\&quot; } &#x60;&#x60;&#x60; You can specify several filter queries using the **filterQueries JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;filterQueries\&quot;: [{\&quot;query\&quot;: \&quot;TYPE:&#39;cm:folder&#39;\&quot;},{\&quot;query\&quot;: \&quot;cm:creator:mjackson\&quot;}] &#x60;&#x60;&#x60; You can specify several facet queries using the **facetQueries JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;facetQueries\&quot;: [{\&quot;query\&quot;: \&quot;created:2016\&quot;,\&quot;label\&quot;: \&quot;CreatedThisYear\&quot;}] &#x60;&#x60;&#x60; The response will contain a matching \&quot;context\&quot; section, the \&quot;label\&quot; will match the facet query. &#x60;&#x60;&#x60;JSON \&quot;context\&quot;: {   \&quot;facetQueries\&quot;: [     {\&quot;label\&quot;: \&quot;CreatedThisYear\&quot;,\&quot;count\&quot;: 3}   ] }, &#x60;&#x60;&#x60; A complete query for facetting via the content.size field looks this: &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;presentation\&quot;,     \&quot;language\&quot;: \&quot;afts\&quot;   },     \&quot;facetQueries\&quot;: [         {\&quot;query\&quot;: \&quot;content.size:[0 TO 10240]\&quot;, \&quot;label\&quot;: \&quot;xtra small\&quot;},         {\&quot;query\&quot;: \&quot;content.size:[10240 TO 102400]\&quot;, \&quot;label\&quot;: \&quot;small\&quot;},         {\&quot;query\&quot;: \&quot;content.size:[102400 TO 1048576]\&quot;, \&quot;label\&quot;: \&quot;medium\&quot;},         {\&quot;query\&quot;: \&quot;content.size:[1048576 TO 16777216]\&quot;, \&quot;label\&quot;: \&quot;large\&quot;},         {\&quot;query\&quot;: \&quot;content.size:[16777216 TO 134217728]\&quot;, \&quot;label\&quot;: \&quot;xtra large\&quot;},         {\&quot;query\&quot;: \&quot;content.size:[134217728 TO MAX]\&quot;, \&quot;label\&quot;: \&quot;XX large\&quot;}   ],     \&quot;facetFields\&quot;: {\&quot;facets\&quot;: [{\&quot;field\&quot;: \&quot;&#39;content.size&#39;\&quot;}]} } &#x60;&#x60;&#x60; The response will contain a matching \&quot;context\&quot; section, the \&quot;label\&quot; will match the facet query. &#x60;&#x60;&#x60;JSON \&quot;context\&quot;: {   \&quot;facetQueries\&quot;: [     { \&quot;label\&quot;: \&quot;small\&quot;,\&quot;count\&quot;: 2 },     { \&quot;label\&quot;: \&quot;large\&quot;,\&quot;count\&quot;: 0 },     { \&quot;label\&quot;: \&quot;xtra small\&quot;,\&quot;count\&quot;: 5 },     { \&quot;label\&quot;: \&quot;xtra large\&quot;,\&quot;count\&quot;: 56},     { \&quot;label\&quot;: \&quot;medium\&quot;,\&quot;count\&quot;: 4 },     { \&quot;label\&quot;: \&quot;XX large\&quot;, \&quot;count\&quot;: 1 }   ] }, &#x60;&#x60;&#x60; You can specify several facet fields using the **facetFields JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON \&quot;facetFields\&quot;: {\&quot;facets\&quot;: [{\&quot;field\&quot;: \&quot;creator\&quot;, \&quot;mincount\&quot;: 1}, {\&quot;field\&quot;: \&quot;modifier\&quot;, \&quot;mincount\&quot;: 1}]} &#x60;&#x60;&#x60; The response will contain a matching \&quot;context\&quot; section, the \&quot;label\&quot; will match the facet field. &#x60;&#x60;&#x60;JSON \&quot;context\&quot;: {    \&quot;facetsFields\&quot;: [      {  \&quot;label\&quot;: \&quot;creator\&quot;,         \&quot;buckets\&quot;: [           { \&quot;label\&quot;: \&quot;System\&quot;, \&quot;count\&quot;: 75 },           { \&quot;label\&quot;: \&quot;mjackson\&quot;, \&quot;count\&quot;: 5 }         ]},      {  \&quot;label\&quot;: \&quot;modifier\&quot;,         \&quot;buckets\&quot;: [           { \&quot;label\&quot;: \&quot;System\&quot;, \&quot;count\&quot;: 72 },           { \&quot;label\&quot;: \&quot;mjackson\&quot;, \&quot;count\&quot;: 5 },           { \&quot;label\&quot;: \&quot;admin\&quot;, \&quot;count\&quot;: 3 }         ]}    ] }, &#x60;&#x60;&#x60; Grouping facet queries that go together can be done by specifying the group label in the fact queries as follow: &#x60;&#x60;&#x60;JSON     {         \&quot;query\&quot;: {             \&quot;query\&quot;: \&quot;presentation\&quot;         },         \&quot;facetQueries\&quot;: [             {\&quot;query\&quot;: \&quot;content.size:[0 TO 102400]\&quot;, \&quot;label\&quot;: \&quot;small\&quot;, \&quot;group\&quot;:\&quot;foo\&quot;},             {\&quot;query\&quot;: \&quot;content.size:[102400 TO 1048576]\&quot;, \&quot;label\&quot;: \&quot;medium\&quot;,\&quot;group\&quot;:\&quot;foo\&quot;},             {\&quot;query\&quot;: \&quot;content.size:[1048576 TO 16777216]\&quot;, \&quot;label\&quot;: \&quot;large\&quot;,\&quot;group\&quot;:\&quot;foo\&quot;}         ]     } &#x60;&#x60;&#x60; The above query returns the results a faceted field grouped under the label foo: &#x60;&#x60;&#x60;JSON {     \&quot;context\&quot;: {\&quot;facetsFields\&quot;: [{         \&quot;label\&quot;: \&quot;foo\&quot;,         \&quot;buckets\&quot;: [             {                 \&quot;count\&quot;: 109,                 \&quot;label\&quot;: \&quot;small\&quot;,                 \&quot;filterQuery\&quot;: \&quot;content.size:[0 TO 102400]\&quot;             },             {                 \&quot;count\&quot;: 0,                 \&quot;label\&quot;: \&quot;large\&quot;,                 \&quot;filterQuery\&quot;: \&quot;content.size:[1048576 TO 16777216]\&quot;             },             {                 \&quot;count\&quot;: 0,                 \&quot;label\&quot;: \&quot;medium\&quot;,                 \&quot;filterQuery\&quot;: \&quot;content.size:[102400 TO 1048576]\&quot;             }         ]     }] } &#x60;&#x60;&#x60; Range Faceting is supported by the **ranges JSON body parameter**, for example: &#x60;&#x60;&#x60;JSON     {         \&quot;query\&quot;: {             \&quot;query\&quot;: \&quot;presentation\&quot;         },         \&quot;ranges\&quot;: [         {             \&quot;field\&quot;: \&quot;content.size\&quot;,              \&quot;start\&quot;: \&quot;0\&quot;,              \&quot;end\&quot;: \&quot;100\&quot;,              \&quot;gap\&quot;: \&quot;20\&quot;,              \&quot;hardend\&quot;: true         },         {             \&quot;field\&quot;: \&quot;created\&quot;,             \&quot;start\&quot;: \&quot;2015-09-29T10:45:15.729Z\&quot;,             \&quot;end\&quot;: \&quot;2016-09-29T10:45:15.729Z\&quot;,             \&quot;gap\&quot;: \&quot;+100DAY\&quot;         }]     } &#x60;&#x60;&#x60; An example query for **search highlighting** could look like this: &#x60;&#x60;&#x60;JSON {   \&quot;query\&quot;: {     \&quot;query\&quot;: \&quot;description:workflow\&quot;,     \&quot;userQuery\&quot;:\&quot;workflow\&quot;   },   \&quot;highlight\&quot;: {     \&quot;prefix\&quot;: \&quot;¿\&quot;,     \&quot;postfix\&quot;: \&quot;?\&quot;,     \&quot;mergeContiguous\&quot;: true,     \&quot;fields\&quot;: [       {         \&quot;field\&quot;: \&quot;cm:title\&quot;       },       {         \&quot;field\&quot;: \&quot;description\&quot;,         \&quot;prefix\&quot;: \&quot;(\&quot;,         \&quot;postfix\&quot;: \&quot;)\&quot;       }     ]   } } &#x60;&#x60;&#x60; The example above changes the highlighting prefix and postfix from the  default &lt;em&gt; for all fields to ¿? and just for the \&quot;description\&quot; field to ().  The hightlight information is added in each node entry response; here is  an example partial response: &#x60;&#x60;&#x60; \&quot;entry\&quot;: {         \&quot;createdAt\&quot;: \&quot;2016-10-12T15:24:31.202+0000\&quot;,         \&quot;isFolder\&quot;: true,         \&quot;search\&quot;: {           \&quot;score\&quot;: 1,           \&quot;highlight\&quot;: [             {               \&quot;field\&quot;: \&quot;cm:title\&quot;,               \&quot;snippets\&quot;: [                 \&quot;Customized ¿Workflow? Process Definitions\&quot;               ]             },             {               \&quot;field\&quot;: \&quot;description\&quot;,               \&quot;snippets\&quot;: [                 \&quot;Customized (Workflow) Process Definitions\&quot;               ]             }           ]       }, &#x60;&#x60;&#x60; 
+    # @param query_body Generic query API 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ResultSetPaging, Fixnum, Hash)>] ResultSetPaging data, response status code and response headers
+    def search_with_http_info(query_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi.search ..."
+      end
+      # verify the required parameter 'query_body' is set
+      if @api_client.config.client_side_validation && query_body.nil?
+        fail ArgumentError, "Missing the required parameter 'query_body' when calling SearchApi.search"
+      end
+      # resource path
+      local_var_path = "/search"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(query_body)
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ResultSetPaging')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/alfresco/api_client.rb

@@ -0,0 +1,389 @@
+=begin
+#Alfresco Content Services REST API
+
+#**Search API** Provides access to the search features of Alfresco Content Services. 
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+
+module Alfresco
+  class ApiClient
+    # The Configuration object holding settings to be used in the API client.
+    attr_accessor :config
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    def initialize(config = Configuration.default)
+      @config = config
+      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @default_headers = {
+        'Content-Type' => "application/json",
+        'User-Agent' => @user_agent
+      }
+    end
+
+    def self.default
+      @@default ||= ApiClient.new
+    end
+
+    # Call an API with given options.
+    #
+    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    #   the data deserialized from response body (could be nil), response status code and response headers.
+    def call_api(http_method, path, opts = {})
+      request = build_request(http_method, path, opts)
+      response = request.run
+
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      unless response.success?
+        if response.timed_out?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
+        end
+      end
+
+      if opts[:return_type]
+        data = deserialize(response, opts[:return_type])
+      else
+        data = nil
+      end
+      return data, response.code, response.headers
+    end
+
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @option opts [Object] :body HTTP body (JSON/XML)
+    # @return [Typhoeus::Request] A Typhoeus Request
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path)
+      http_method = http_method.to_sym.downcase
+
+      header_params = @default_headers.merge(opts[:header_params] || {})
+      query_params = opts[:query_params] || {}
+      form_params = opts[:form_params] || {}
+
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
+
+      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
+      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
+
+      req_opts = {
+        :method => http_method,
+        :headers => header_params,
+        :params => query_params,
+        :params_encoding => @config.params_encoding,
+        :timeout => @config.timeout,
+        :ssl_verifypeer => @config.verify_ssl,
+        :ssl_verifyhost => _verify_ssl_host,
+        :sslcert => @config.cert_file,
+        :sslkey => @config.key_file,
+        :verbose => @config.debugging
+      }
+
+      # set custom cert, if provided
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
+      if [:post, :patch, :put, :delete].include?(http_method)
+        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_opts.update :body => req_body
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
+      end
+
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      request
+    end
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+       (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [Response] response HTTP response
+    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    def deserialize(response, return_type)
+      body = response.body
+
+      # handle file downloading - return the File instance processed in request callbacks
+      # note that response body is empty when the file is written in chunks in request on_body callback
+      return @tempfile if return_type == 'File'
+
+      return nil if body.nil? || body.empty?
+
+      # return response body directly for String return type
+      return body if return_type == 'String'
+
+      # ensuring a default content type
+      content_type = response.headers['Content-Type'] || 'application/json'
+
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type data, return_type
+    end
+
+    # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
+    def convert_to_type(data, return_type)
+      return nil if data.nil?
+      case return_type
+      when 'String'
+        data.to_s
+      when 'Integer'
+        data.to_i
+      when 'Float'
+        data.to_f
+      when 'BOOLEAN'
+        data == true
+      when 'DateTime'
+        # parse date time (expecting ISO 8601 format)
+        DateTime.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object (usually a Hash), return directly
+        data
+      when /\AArray<(.+)>\z/
+        # e.g. Array<Pet>
+        sub_type = $1
+        data.map {|item| convert_to_type(item, sub_type) }
+      when /\AHash\<String, (.+)\>\z/
+        # e.g. Hash<String, Integer>
+        sub_type = $1
+        {}.tap do |hash|
+          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+        end
+      else
+        # models, e.g. Pet
+        Alfresco.const_get(return_type).new.tap do |model|
+          model.build_from_hash data
+        end
+      end
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
+    #
+    # @see Configuration#temp_folder_path
+    def download_file(request)
+      tempfile = nil
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition and content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile = tempfile
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      end
+    end
+
+    # Sanitize filename by removing path.
+    # e.g. ../../sun.gif becomes sun.gif
+    #
+    # @param [String] filename the filename to be sanitized
+    # @return [String] the sanitized filename
+    def sanitize_filename(filename)
+      filename.gsub(/.*[\/\\]/, '')
+    end
+
+    def build_request_url(path)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      URI.encode(@config.base_url + path)
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when File, Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Update hearder and query params based on authentication settings.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] query_params Query parameters
+    # @param [String] auth_names Authentication scheme name
+    def update_params_for_auth!(header_params, query_params, auth_names)
+      Array(auth_names).each do |auth_name|
+        auth_setting = @config.auth_settings[auth_name]
+        next unless auth_setting
+        case auth_setting[:in]
+        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        end
+      end
+    end
+
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+      @default_headers['User-Agent'] = @user_agent
+    end
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      return nil if accepts.nil? || accepts.empty?
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      return json_accept || accepts.join(',')
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      # use application/json by default
+      return 'application/json' if content_types.nil? || content_types.empty?
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      return json_content_type || content_types.first
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
+      if model.is_a?(Array)
+        local_body = model.map{|m| object_to_hash(m) }
+      else
+        local_body = object_to_hash(model)
+      end
+      local_body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+
+    # Build parameter value according to the given collection format.
+    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+    def build_collection_param(param, collection_format)
+      case collection_format
+      when :csv
+        param.join(',')
+      when :ssv
+        param.join(' ')
+      when :tsv
+        param.join("\t")
+      when :pipes
+        param.join('|')
+      when :multi
+        # return the array directly as typhoeus will handle it as expected
+        param
+      else
+        fail "unknown collection format: #{collection_format.inspect}"
+      end
+    end
+  end
+end