Class: ConnectWise::BoardExcludedMembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardExcludedMembersApi

Returns a new instance of BoardExcludedMembersApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Get Excluded Members 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/board_excluded_members_api.rb', line 18

def service_boards_id_excluded_members_count_get(id, opts = {})
  data, _status_code, _headers = service_boards_id_excluded_members_count_get_with_http_info(id, opts)
  return data
end

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

Get Excluded Members 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/board_excluded_members_api.rb', line 29

def service_boards_id_excluded_members_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardExcludedMembersApi.service_boards_id_excluded_members_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 BoardExcludedMembersApi.service_boards_id_excluded_members_count_get"
  end
  # resource path
  local_var_path = "/service/boards/{id}/excludedMembers/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: BoardExcludedMembersApi#service_boards_id_excluded_members_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_excluded_members_excluded_member_id_delete(id, excluded_member_id, opts = {}) ⇒ nil

Delete Excluded Member By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def service_boards_id_excluded_members_excluded_member_id_delete(id, excluded_member_id, opts = {})
  service_boards_id_excluded_members_excluded_member_id_delete_with_http_info(id, excluded_member_id, opts)
  return nil
end

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

Delete Excluded Member By Id

Parameters:

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

    the optional parameters

Returns:

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

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

def service_boards_id_excluded_members_excluded_member_id_delete_with_http_info(id, excluded_member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_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 BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_id_delete"
  end
  # verify the required parameter 'excluded_member_id' is set
  if @api_client.config.client_side_validation && excluded_member_id.nil?
    fail ArgumentError, "Missing the required parameter 'excluded_member_id' when calling BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_id_delete"
  end
  # resource path
  local_var_path = "/service/boards/{id}/excludedMembers/{excludedMemberId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'excludedMemberId' + '}', excluded_member_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: BoardExcludedMembersApi#service_boards_id_excluded_members_excluded_member_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_excluded_members_excluded_member_id_get(id, excluded_member_id, opts = {}) ⇒ BoardExcludedMember

Get Excluded Member By Id

Parameters:

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

    the optional parameters

Returns:



130
131
132
133
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 130

def service_boards_id_excluded_members_excluded_member_id_get(id, excluded_member_id, opts = {})
  data, _status_code, _headers = service_boards_id_excluded_members_excluded_member_id_get_with_http_info(id, excluded_member_id, opts)
  return data
end

#service_boards_id_excluded_members_excluded_member_id_get_with_http_info(id, excluded_member_id, opts = {}) ⇒ Array<(BoardExcludedMember, Fixnum, Hash)>

Get Excluded Member By Id

Parameters:

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

    the optional parameters

Returns:

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

    BoardExcludedMember data, response status code and response headers



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
173
174
175
176
177
178
179
180
181
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 141

def service_boards_id_excluded_members_excluded_member_id_get_with_http_info(id, excluded_member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_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 BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_id_get"
  end
  # verify the required parameter 'excluded_member_id' is set
  if @api_client.config.client_side_validation && excluded_member_id.nil?
    fail ArgumentError, "Missing the required parameter 'excluded_member_id' when calling BoardExcludedMembersApi.service_boards_id_excluded_members_excluded_member_id_get"
  end
  # resource path
  local_var_path = "/service/boards/{id}/excludedMembers/{excludedMemberId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'excludedMemberId' + '}', excluded_member_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 => 'BoardExcludedMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardExcludedMembersApi#service_boards_id_excluded_members_excluded_member_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_excluded_members_get(id, opts = {}) ⇒ Array<BoardExcludedMember>

Get Excluded Members

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:



194
195
196
197
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 194

def service_boards_id_excluded_members_get(id, opts = {})
  data, _status_code, _headers = service_boards_id_excluded_members_get_with_http_info(id, opts)
  return data
end

#service_boards_id_excluded_members_get_with_http_info(id, opts = {}) ⇒ Array<(Array<BoardExcludedMember>, Fixnum, Hash)>

Get Excluded Members

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

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 210

def service_boards_id_excluded_members_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardExcludedMembersApi.service_boards_id_excluded_members_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 BoardExcludedMembersApi.service_boards_id_excluded_members_get"
  end
  # resource path
  local_var_path = "/service/boards/{id}/excludedMembers".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<BoardExcludedMember>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardExcludedMembersApi#service_boards_id_excluded_members_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_excluded_members_post(id, board_excluded_member, opts = {}) ⇒ BoardExcludedMember

Create Excluded Member

Parameters:

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

    the optional parameters

Returns:



260
261
262
263
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 260

def service_boards_id_excluded_members_post(id, board_excluded_member, opts = {})
  data, _status_code, _headers = service_boards_id_excluded_members_post_with_http_info(id, board_excluded_member, opts)
  return data
end

#service_boards_id_excluded_members_post_with_http_info(id, board_excluded_member, opts = {}) ⇒ Array<(BoardExcludedMember, Fixnum, Hash)>

Create Excluded Member

Parameters:

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

    the optional parameters

Returns:

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

    BoardExcludedMember data, response status code and response headers



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/connectwise-ruby-sdk/api/board_excluded_members_api.rb', line 271

def service_boards_id_excluded_members_post_with_http_info(id, board_excluded_member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardExcludedMembersApi.service_boards_id_excluded_members_post ..."
  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 BoardExcludedMembersApi.service_boards_id_excluded_members_post"
  end
  # verify the required parameter 'board_excluded_member' is set
  if @api_client.config.client_side_validation && board_excluded_member.nil?
    fail ArgumentError, "Missing the required parameter 'board_excluded_member' when calling BoardExcludedMembersApi.service_boards_id_excluded_members_post"
  end
  # resource path
  local_var_path = "/service/boards/{id}/excludedMembers".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'])
  # 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(board_excluded_member)
  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 => 'BoardExcludedMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardExcludedMembersApi#service_boards_id_excluded_members_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end