Class: ConnectWise::ScheduleDetailsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScheduleDetailsApi

Returns a new instance of ScheduleDetailsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_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/schedule_details_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#schedule_entries_id_details_count_get(id, opts = {}) ⇒ Count

Get Schedule Detail Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def schedule_entries_id_details_count_get(id, opts = {})
  data, _status_code, _headers = schedule_entries_id_details_count_get_with_http_info(id, opts)
  return data
end

#schedule_entries_id_details_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Schedule Detail Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

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

    Count data, response status code and response headers



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
66
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_api.rb', line 29

def schedule_entries_id_details_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScheduleDetailsApi.schedule_entries_id_details_count_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScheduleDetailsApi.schedule_entries_id_details_count_get"
  end
  # resource path
  local_var_path = "/schedule/entries/{id}/details/count".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleDetailsApi#schedule_entries_id_details_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#schedule_entries_id_details_detail_id_get(id, detail_id, opts = {}) ⇒ ScheduleDetail

Get Schedule Detail By Id

Parameters:

  • id
  • detail_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



74
75
76
77
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_api.rb', line 74

def schedule_entries_id_details_detail_id_get(id, detail_id, opts = {})
  data, _status_code, _headers = schedule_entries_id_details_detail_id_get_with_http_info(id, detail_id, opts)
  return data
end

#schedule_entries_id_details_detail_id_get_with_http_info(id, detail_id, opts = {}) ⇒ Array<(ScheduleDetail, Fixnum, Hash)>

Get Schedule Detail By Id

Parameters:

  • id
  • detail_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ScheduleDetail data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_api.rb', line 85

def schedule_entries_id_details_detail_id_get_with_http_info(id, detail_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScheduleDetailsApi.schedule_entries_id_details_detail_id_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScheduleDetailsApi.schedule_entries_id_details_detail_id_get"
  end
  # verify the required parameter 'detail_id' is set
  if @api_client.config.client_side_validation && detail_id.nil?
    fail ArgumentError, "Missing the required parameter 'detail_id' when calling ScheduleDetailsApi.schedule_entries_id_details_detail_id_get"
  end
  # resource path
  local_var_path = "/schedule/entries/{id}/details/{detailId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'detailId' + '}', detail_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduleDetail')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleDetailsApi#schedule_entries_id_details_detail_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#schedule_entries_id_details_get(id, opts = {}) ⇒ Array<ScheduleDetail>

Get Schedule Detail

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



138
139
140
141
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_api.rb', line 138

def schedule_entries_id_details_get(id, opts = {})
  data, _status_code, _headers = schedule_entries_id_details_get_with_http_info(id, opts)
  return data
end

#schedule_entries_id_details_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ScheduleDetail>, Fixnum, Hash)>

Get Schedule Detail

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

    Array<ScheduleDetail> data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/connectwise-ruby-sdk/api/schedule_details_api.rb', line 154

def schedule_entries_id_details_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScheduleDetailsApi.schedule_entries_id_details_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScheduleDetailsApi.schedule_entries_id_details_get"
  end
  # resource path
  local_var_path = "/schedule/entries/{id}/details".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ScheduleDetail>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduleDetailsApi#schedule_entries_id_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end