Class: ConnectWise::TimePeriodSetupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TimePeriodSetupsApi

Returns a new instance of TimePeriodSetupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#time_time_period_setups_count_get(opts = {}) ⇒ Count

Get Time Period Setups Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def time_time_period_setups_count_get(opts = {})
  data, _status_code, _headers = time_time_period_setups_count_get_with_http_info(opts)
  return data
end

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

Get Time Period Setups Count

Parameters:

  • 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



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

def time_time_period_setups_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_count_get ..."
  end
  # resource path
  local_var_path = "/time/timePeriodSetups/count"

  # 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: TimePeriodSetupsApi#time_time_period_setups_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#time_time_period_setups_default_get(opts = {}) ⇒ TimePeriodSetupDefaults

Get Time Period Setups Default

Parameters:

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

    the optional parameters

Returns:



66
67
68
69
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 66

def time_time_period_setups_default_get(opts = {})
  data, _status_code, _headers = time_time_period_setups_default_get_with_http_info(opts)
  return data
end

#time_time_period_setups_default_get_with_http_info(opts = {}) ⇒ Array<(TimePeriodSetupDefaults, Fixnum, Hash)>

Get Time Period Setups Default

Parameters:

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

    the optional parameters

Returns:

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

    TimePeriodSetupDefaults data, response status code and response headers



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 75

def time_time_period_setups_default_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_default_get ..."
  end
  # resource path
  local_var_path = "/time/timePeriodSetups/default"

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

#time_time_period_setups_get(opts = {}) ⇒ Array<TimePeriodSetup>

Get Time Period Setups

Parameters:

  • 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:



119
120
121
122
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 119

def time_time_period_setups_get(opts = {})
  data, _status_code, _headers = time_time_period_setups_get_with_http_info(opts)
  return data
end

#time_time_period_setups_get_with_http_info(opts = {}) ⇒ Array<(Array<TimePeriodSetup>, Fixnum, Hash)>

Get Time Period Setups

Parameters:

  • 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<TimePeriodSetup>, Fixnum, Hash)>) —

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 134

def time_time_period_setups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_get ..."
  end
  # resource path
  local_var_path = "/time/timePeriodSetups"

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

#time_time_period_setups_id_delete(id, opts = {}) ⇒ nil

Delete Time Period Setup By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


179
180
181
182
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 179

def time_time_period_setups_id_delete(id, opts = {})
  time_time_period_setups_id_delete_with_http_info(id, opts)
  return nil
end

#time_time_period_setups_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Time Period Setup By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 189

def time_time_period_setups_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_id_delete ..."
  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 TimePeriodSetupsApi.time_time_period_setups_id_delete"
  end
  # resource path
  local_var_path = "/time/timePeriodSetups/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#time_time_period_setups_id_get(id, opts = {}) ⇒ TimePeriodSetup

Get Time Period Setup By Id

Parameters:

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

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 229

def time_time_period_setups_id_get(id, opts = {})
  data, _status_code, _headers = time_time_period_setups_id_get_with_http_info(id, opts)
  return data
end

#time_time_period_setups_id_get_with_http_info(id, opts = {}) ⇒ Array<(TimePeriodSetup, Fixnum, Hash)>

Get Time Period Setup By Id

Parameters:

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

    the optional parameters

Returns:

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

    TimePeriodSetup data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 239

def time_time_period_setups_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_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 TimePeriodSetupsApi.time_time_period_setups_id_get"
  end
  # resource path
  local_var_path = "/time/timePeriodSetups/{id}".sub('{' + 'id' + '}', 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 => 'TimePeriodSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimePeriodSetupsApi#time_time_period_setups_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#time_time_period_setups_post(time_period_setup, opts = {}) ⇒ TimePeriodSetup

Create Time Period Setup

Parameters:

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 282

def time_time_period_setups_post(time_period_setup, opts = {})
  data, _status_code, _headers = time_time_period_setups_post_with_http_info(time_period_setup, opts)
  return data
end

#time_time_period_setups_post_with_http_info(time_period_setup, opts = {}) ⇒ Array<(TimePeriodSetup, Fixnum, Hash)>

Create Time Period Setup

Parameters:

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

    the optional parameters

Returns:

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

    TimePeriodSetup data, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/connectwise-ruby-sdk/api/time_period_setups_api.rb', line 292

def time_time_period_setups_post_with_http_info(time_period_setup, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimePeriodSetupsApi.time_time_period_setups_post ..."
  end
  # verify the required parameter 'time_period_setup' is set
  if @api_client.config.client_side_validation && time_period_setup.nil?
    fail ArgumentError, "Missing the required parameter 'time_period_setup' when calling TimePeriodSetupsApi.time_time_period_setups_post"
  end
  # resource path
  local_var_path = "/time/timePeriodSetups"

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