xbim_comms 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0c7519850251ddd372ab6f339577eaeda6ec5f95bf01f5d633655502c349681
+  data.tar.gz: 6c761703794206cc33f17ac972791b39d680a0ed2a986a58ea7188f511f4b17b
+SHA512:
+  metadata.gz: 3141161f328b00404f6e4ea85419dee928b8ef6dec6636d32540eac3a8066a66bfd2b5ccd6161e8e4107e5d56c167094e355cb901a16c50728727ff934a75403
+  data.tar.gz: dd89e247184c504e6f9acab04c9f6b1b2949e3a3afd5c8533e8935282b8d4946eddf72414bd28eacb73aa570b49b3a484528c311cab388cdef16057a598d5466

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,210 @@
+# xbim_comms
+
+XbimComms - the Ruby gem for the Flex Comms API 2.0
+
+Communication centralised around construction data
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://xbim.net](https://xbim.net)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build xbim_comms.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./xbim_comms-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./xbim_comms-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'xbim_comms', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'xbim_comms', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'xbim_comms'
+
+# Setup authorization
+XbimComms.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = XbimComms::ContactsApi.new
+term = 'term_example' # String | 
+region = 'UK' # String | The data center region the data resides in
+opts = {
+  expand: 'expand_example', # String | 
+  filter: 'filter_example', # String | 
+  select: 'select_example', # String | 
+  orderby: 'orderby_example', # String | 
+  top: 56, # Integer | 
+  skip: 56, # Integer | 
+  count: true # Boolean | 
+}
+
+begin
+  #Get Contacts search
+  result = api_instance.contacts_search(term, region, opts)
+  p result
+rescue XbimComms::ApiError => e
+  puts "Exception when calling ContactsApi->contacts_search: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apis.xbim-dev.net*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*XbimComms::ContactsApi* | [**contacts_search**](docs/ContactsApi.md#contacts_search) | **GET** /{region}/comms/2.0/Contacts/Search(Term={term}) | Get Contacts search
+*XbimComms::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /{region}/comms/2.0/Contacts | Get Contacts 
+*XbimComms::ConversationsApi* | [**aggregate_data**](docs/ConversationsApi.md#aggregate_data) | **GET** /{region}/comms/2.0/Conversations/Aggregate() | Aggregates conversation data efficiently for reporting purposes
+*XbimComms::ConversationsApi* | [**clone_conversation**](docs/ConversationsApi.md#clone_conversation) | **GET** /{region}/comms/2.0/Conversations/{key}/Clone | Get Conversations clone conversation
+*XbimComms::ConversationsApi* | [**delete_conversation**](docs/ConversationsApi.md#delete_conversation) | **DELETE** /{region}/comms/2.0/Conversations/{key} | Delete Conversations conversation
+*XbimComms::ConversationsApi* | [**delete_file**](docs/ConversationsApi.md#delete_file) | **DELETE** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Files({fileId}) | Delete Conversations file
+*XbimComms::ConversationsApi* | [**delete_message**](docs/ConversationsApi.md#delete_message) | **DELETE** /{region}/comms/2.0/Conversations({conversationId})/Messages({id}) | Delete Conversations message
+*XbimComms::ConversationsApi* | [**delete_message_part**](docs/ConversationsApi.md#delete_message_part) | **DELETE** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Delete | Delete Conversations message part
+*XbimComms::ConversationsApi* | [**delete_participant**](docs/ConversationsApi.md#delete_participant) | **DELETE** /{region}/comms/2.0/Conversations({conversationId})/Participants({id}) | Delete Conversations participant
+*XbimComms::ConversationsApi* | [**get_conversations**](docs/ConversationsApi.md#get_conversations) | **GET** /{region}/comms/2.0/Conversations | Get Conversations 
+*XbimComms::ConversationsApi* | [**get_conversations_by_id**](docs/ConversationsApi.md#get_conversations_by_id) | **GET** /{region}/comms/2.0/Conversations/{key} | Get Conversations by id
+*XbimComms::ConversationsApi* | [**get_demo_conversation**](docs/ConversationsApi.md#get_demo_conversation) | **GET** /{region}/comms/2.0/Conversations/Demo | Get Conversations demo conversation
+*XbimComms::ConversationsApi* | [**get_file**](docs/ConversationsApi.md#get_file) | **GET** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Files({fileId}) | Get Conversations file
+*XbimComms::ConversationsApi* | [**get_files**](docs/ConversationsApi.md#get_files) | **GET** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Files | Get Conversations files
+*XbimComms::ConversationsApi* | [**get_message_by_id**](docs/ConversationsApi.md#get_message_by_id) | **GET** /{region}/comms/2.0/Conversations({conversationId})/Messages({id}) | Get Conversations message by id
+*XbimComms::ConversationsApi* | [**get_messages**](docs/ConversationsApi.md#get_messages) | **GET** /{region}/comms/2.0/Conversations({conversationId})/Messages | Get Conversations messages
+*XbimComms::ConversationsApi* | [**get_participiants**](docs/ConversationsApi.md#get_participiants) | **GET** /{region}/comms/2.0/Conversations({conversationId})/Participants | Get Conversations participiants
+*XbimComms::ConversationsApi* | [**import_bcf_file**](docs/ConversationsApi.md#import_bcf_file) | **POST** /{region}/comms/2.0/Conversations/ImportBcf | Imports a BCF File's Topics and Markup as one or more Flex conversations
+*XbimComms::ConversationsApi* | [**insert_message_part**](docs/ConversationsApi.md#insert_message_part) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Insert | Post Conversations insert message part
+*XbimComms::ConversationsApi* | [**mode_message_part**](docs/ConversationsApi.md#mode_message_part) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Move | Post Conversations mode message part
+*XbimComms::ConversationsApi* | [**patch_conversation**](docs/ConversationsApi.md#patch_conversation) | **PATCH** /{region}/comms/2.0/Conversations/{key} | Patch Conversations conversation
+*XbimComms::ConversationsApi* | [**patch_message**](docs/ConversationsApi.md#patch_message) | **PATCH** /{region}/comms/2.0/Conversations({conversationId})/Messages({id}) | Patch Conversations message
+*XbimComms::ConversationsApi* | [**patch_participant**](docs/ConversationsApi.md#patch_participant) | **PATCH** /{region}/comms/2.0/Conversations({conversationId})/Participants({id}) | Patch Conversations participant
+*XbimComms::ConversationsApi* | [**post_conversation**](docs/ConversationsApi.md#post_conversation) | **POST** /{region}/comms/2.0/Conversations | Post Conversations conversation
+*XbimComms::ConversationsApi* | [**post_file**](docs/ConversationsApi.md#post_file) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Files | Post Conversations file
+*XbimComms::ConversationsApi* | [**post_message**](docs/ConversationsApi.md#post_message) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages | Post Conversations message
+*XbimComms::ConversationsApi* | [**post_participant**](docs/ConversationsApi.md#post_participant) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Participants | Post Conversations participant
+*XbimComms::ConversationsApi* | [**put_message_part**](docs/ConversationsApi.md#put_message_part) | **PUT** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Set | Put Conversations message part
+*XbimComms::ConversationsApi* | [**put_participants**](docs/ConversationsApi.md#put_participants) | **PUT** /{region}/comms/2.0/Conversations({conversationId})/Participants | Put Conversations participants
+*XbimComms::ConversationsApi* | [**send_clone_conversation**](docs/ConversationsApi.md#send_clone_conversation) | **GET** /{region}/comms/2.0/Conversations/{key}/SendClone | Get Conversations send clone conversation
+*XbimComms::ConversationsApi* | [**send_message**](docs/ConversationsApi.md#send_message) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Send | Post Conversations send message
+*XbimComms::ConversationsApi* | [**set_message_state**](docs/ConversationsApi.md#set_message_state) | **PUT** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/SetState | Put Conversations set message state
+*XbimComms::ConversationsApi* | [**swap_message_parts**](docs/ConversationsApi.md#swap_message_parts) | **POST** /{region}/comms/2.0/Conversations({conversationId})/Messages({id})/Swap | Post Conversations swap message parts
+*XbimComms::FilesApi* | [**files_get_file**](docs/FilesApi.md#files_get_file) | **GET** /{region}/comms/2.0/Files/{hash}/{fileId} | Gets a File Blob from a Message
+*XbimComms::SnapshotsApi* | [**snapshots_get_snapshot**](docs/SnapshotsApi.md#snapshots_get_snapshot) | **GET** /{region}/comms/2.0/Snapshots/{hash}/{fileId} | Gets a File Blob from a Message
+
+
+## Documentation for Models
+
+ - [XbimComms::Aggregate](docs/Aggregate.md)
+ - [XbimComms::AggregateListValue](docs/AggregateListValue.md)
+ - [XbimComms::AnalyticalResult](docs/AnalyticalResult.md)
+ - [XbimComms::AnalyticalResultAllOf](docs/AnalyticalResultAllOf.md)
+ - [XbimComms::Animation](docs/Animation.md)
+ - [XbimComms::AnimationAllOf](docs/AnimationAllOf.md)
+ - [XbimComms::Bitmap](docs/Bitmap.md)
+ - [XbimComms::Blob](docs/Blob.md)
+ - [XbimComms::BooleanValue](docs/BooleanValue.md)
+ - [XbimComms::ClippingPlane](docs/ClippingPlane.md)
+ - [XbimComms::Coloring](docs/Coloring.md)
+ - [XbimComms::ColumnRequest](docs/ColumnRequest.md)
+ - [XbimComms::Component](docs/Component.md)
+ - [XbimComms::Components](docs/Components.md)
+ - [XbimComms::Contact](docs/Contact.md)
+ - [XbimComms::ContactList](docs/ContactList.md)
+ - [XbimComms::Conversation](docs/Conversation.md)
+ - [XbimComms::ConversationCreate](docs/ConversationCreate.md)
+ - [XbimComms::ConversationList](docs/ConversationList.md)
+ - [XbimComms::ConversationTenant](docs/ConversationTenant.md)
+ - [XbimComms::ConversationUpdate](docs/ConversationUpdate.md)
+ - [XbimComms::EntityKey](docs/EntityKey.md)
+ - [XbimComms::ExceptionMessage](docs/ExceptionMessage.md)
+ - [XbimComms::File](docs/File.md)
+ - [XbimComms::FileAllOf](docs/FileAllOf.md)
+ - [XbimComms::Int32Value](docs/Int32Value.md)
+ - [XbimComms::KeyFrame](docs/KeyFrame.md)
+ - [XbimComms::Line](docs/Line.md)
+ - [XbimComms::Message](docs/Message.md)
+ - [XbimComms::MessageContent](docs/MessageContent.md)
+ - [XbimComms::MessageCreate](docs/MessageCreate.md)
+ - [XbimComms::MessageList](docs/MessageList.md)
+ - [XbimComms::MessagePart](docs/MessagePart.md)
+ - [XbimComms::MessageUpdate](docs/MessageUpdate.md)
+ - [XbimComms::OrthogonalCamera](docs/OrthogonalCamera.md)
+ - [XbimComms::Participant](docs/Participant.md)
+ - [XbimComms::ParticipantWithRole](docs/ParticipantWithRole.md)
+ - [XbimComms::ParticipantWithRoleCreate](docs/ParticipantWithRoleCreate.md)
+ - [XbimComms::ParticipantWithRoleList](docs/ParticipantWithRoleList.md)
+ - [XbimComms::ParticipantWithRoleUpdate](docs/ParticipantWithRoleUpdate.md)
+ - [XbimComms::PerspectiveCamera](docs/PerspectiveCamera.md)
+ - [XbimComms::PieChart](docs/PieChart.md)
+ - [XbimComms::PieChartAllOf](docs/PieChartAllOf.md)
+ - [XbimComms::Point](docs/Point.md)
+ - [XbimComms::PreviewRow](docs/PreviewRow.md)
+ - [XbimComms::Schedule](docs/Schedule.md)
+ - [XbimComms::ScheduleAllOf](docs/ScheduleAllOf.md)
+ - [XbimComms::ScheduleColumn](docs/ScheduleColumn.md)
+ - [XbimComms::ScheduleRequest](docs/ScheduleRequest.md)
+ - [XbimComms::ScheduleRequestAllOf](docs/ScheduleRequestAllOf.md)
+ - [XbimComms::SectionBox](docs/SectionBox.md)
+ - [XbimComms::Sheet](docs/Sheet.md)
+ - [XbimComms::SheetAllOf](docs/SheetAllOf.md)
+ - [XbimComms::SheetPart](docs/SheetPart.md)
+ - [XbimComms::Snapshot](docs/Snapshot.md)
+ - [XbimComms::Text](docs/Text.md)
+ - [XbimComms::View](docs/View.md)
+ - [XbimComms::ViewAllOf](docs/ViewAllOf.md)
+ - [XbimComms::ViewSetupHints](docs/ViewSetupHints.md)
+ - [XbimComms::Viewpoint](docs/Viewpoint.md)
+ - [XbimComms::Visibility](docs/Visibility.md)
+
+
+## Documentation for Authorization
+
+
+### oauth2
+
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorization URL**: https://apis.xbim-dev.net/connect/authorize
+- **Scopes**: 
+  - comms.read: Reading from Comms API
+  - comms.write: Writing to Comms API
+  - api.admin: Super-user administrator
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/xbim_comms/api/contacts_api.rb

@@ -0,0 +1,206 @@
+=begin
+#Flex Comms API 2.0
+
+#Communication centralised around construction data
+
+The version of the OpenAPI document: 2.0
+Contact: info@xbim.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module XbimComms
+  class ContactsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Contacts search
+    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ContactList</b><br/><br/>
+    # @param term [String] 
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand 
+    # @option opts [String] :filter 
+    # @option opts [String] :select 
+    # @option opts [String] :orderby 
+    # @option opts [Integer] :top 
+    # @option opts [Integer] :skip 
+    # @option opts [Boolean] :count 
+    # @return [ContactList]
+    def contacts_search(term, region, opts = {})
+      data, _status_code, _headers = contacts_search_with_http_info(term, region, opts)
+      data
+    end
+
+    # Get Contacts search
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ContactList&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param term [String] 
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand 
+    # @option opts [String] :filter 
+    # @option opts [String] :select 
+    # @option opts [String] :orderby 
+    # @option opts [Integer] :top 
+    # @option opts [Integer] :skip 
+    # @option opts [Boolean] :count 
+    # @return [Array<(ContactList, Integer, Hash)>] ContactList data, response status code and response headers
+    def contacts_search_with_http_info(term, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContactsApi.contacts_search ...'
+      end
+      # verify the required parameter 'term' is set
+      if @api_client.config.client_side_validation && term.nil?
+        fail ArgumentError, "Missing the required parameter 'term' when calling ContactsApi.contacts_search"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ContactsApi.contacts_search"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/comms/2.0/Contacts/Search(Term={term})'.sub('{' + 'term' + '}', CGI.escape(term.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
+      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
+      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
+      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ContactList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContactsApi.contacts_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContactsApi#contacts_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Contacts 
+    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ContactList</b><br/><br/>
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand 
+    # @option opts [String] :filter 
+    # @option opts [String] :select 
+    # @option opts [String] :orderby 
+    # @option opts [Integer] :top 
+    # @option opts [Integer] :skip 
+    # @option opts [Boolean] :count 
+    # @return [ContactList]
+    def get_contacts(region, opts = {})
+      data, _status_code, _headers = get_contacts_with_http_info(region, opts)
+      data
+    end
+
+    # Get Contacts 
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ContactList&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand 
+    # @option opts [String] :filter 
+    # @option opts [String] :select 
+    # @option opts [String] :orderby 
+    # @option opts [Integer] :top 
+    # @option opts [Integer] :skip 
+    # @option opts [Boolean] :count 
+    # @return [Array<(ContactList, Integer, Hash)>] ContactList data, response status code and response headers
+    def get_contacts_with_http_info(region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContactsApi.get_contacts ...'
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ContactsApi.get_contacts"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/comms/2.0/Contacts'.sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
+      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
+      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
+      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ContactList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContactsApi.get_contacts",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContactsApi#get_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end