Class: ConnectWise::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/batch_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchApi

Returns a new instance of BatchApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/batch_api.rb', line 8

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/batch_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#system_batch_post(request, opts = {}) ⇒ BatchResponse

Process Batch Requests

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



17
18
19
20
 
# File 'lib/connectwise-ruby-sdk/api/batch_api.rb', line 17

def system_batch_post(request, opts = {})
  data, _status_code, _headers = system_batch_post_with_http_info(request, opts)
  return data
end

#system_batch_post_with_http_info(request, opts = {}) ⇒ Array<(BatchResponse, Fixnum, Hash)>

Process Batch Requests

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BatchResponse, Fixnum, Hash)>) —

    BatchResponse data, response status code and response headers



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/connectwise-ruby-sdk/api/batch_api.rb', line 27

def system_batch_post_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BatchApi.system_batch_post ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling BatchApi.system_batch_post"
  end
  # resource path
  local_var_path = "/system/batch"

  # 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(request)
  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 => 'BatchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchApi#system_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end