Class: ClerkHttpClient::OrganizationMembershipsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/api/organization_memberships_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationMembershipsApi

Returns a new instance of OrganizationMembershipsApi.



19
20
21
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#all(opts = {}) ⇒ OrganizationMemberships

Get a list of all organization memberships within an instance. Retrieves all organization user memberships for the given instance.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. (default to 10)

  • :offset (Float) —

    Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. (default to 0)

  • :order_by (String) —

    Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.

Returns:



177
178
179
180
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 177

def all(opts = {})
  data, _status_code, _headers = all_with_http_info(opts)
  data
end

#all_by_organization(organization_id, opts = {}) ⇒ OrganizationMemberships

Get a list of all members of an organization Retrieves all user memberships for the given organization

Parameters:

  • organization_id (String) —

    The organization ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. (default to 10)

  • :offset (Float) —

    Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. (default to 0)

  • :order_by (String) —

    Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order."

Returns:



258
259
260
261
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 258

def all_by_organization(organization_id, opts = {})
  data, _status_code, _headers = all_by_organization_with_http_info(organization_id, opts)
  data
end

#all_by_organization_with_http_info(organization_id, opts = {}) ⇒ Array<(OrganizationMemberships, Integer, Hash)>

Get a list of all members of an organization Retrieves all user memberships for the given organization GET

Parameters:

  • organization_id (String) —

    The organization ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

  • :order_by (String) —

    Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.&quot;

Returns:

  • (Array<(OrganizationMemberships, Integer, Hash)>) —

    OrganizationMemberships data, response status code and response headers



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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 272

def all_by_organization_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.list_organization_memberships ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationMembershipsApi.list_organization_memberships"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationMembershipsApi.list_organization_memberships, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationMembershipsApi.list_organization_memberships, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OrganizationMembershipsApi.list_organization_memberships, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/organizations/{organization_id}/memberships'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMemberships'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.list_organization_memberships",
    :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: OrganizationMembershipsApi#list_organization_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#all_with_http_info(opts = {}) ⇒ Array<(OrganizationMemberships, Integer, Hash)>

Get a list of all organization memberships within an instance. Retrieves all organization user memberships for the given instance. GET

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

  • :order_by (String) —

    Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.

Returns:

  • (Array<(OrganizationMemberships, Integer, Hash)>) —

    OrganizationMemberships data, response status code and response headers



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
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
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 190

def all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.instance_get_organization_memberships ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationMembershipsApi.instance_get_organization_memberships, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationMembershipsApi.instance_get_organization_memberships, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OrganizationMembershipsApi.instance_get_organization_memberships, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/organization_memberships'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMemberships'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.instance_get_organization_memberships",
    :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: OrganizationMembershipsApi#instance_get_organization_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(organization_id, create_organization_membership_request, opts = {}) ⇒ OrganizationMembership

Create a new organization membership Adds a user as a member to the given organization. Only users in the same instance as the organization can be added as members. This organization will be the user’s [active organization] (clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don’t explicitly set a different organization as active before then.

Parameters:

  • organization_id (String) —

    The ID of the organization where the new membership will be created

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 29

def create(organization_id, create_organization_membership_request, opts = {})
  data, _status_code, _headers = create_with_http_info(organization_id, create_organization_membership_request, opts)
  data
end

#create_with_http_info(organization_id, create_organization_membership_request, opts = {}) ⇒ Array<(OrganizationMembership, Integer, Hash)>

Create a new organization membership Adds a user as a member to the given organization. Only users in the same instance as the organization can be added as members. This organization will be the user&#39;s [active organization] (clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don&#39;t explicitly set a different organization as active before then. POST

Parameters:

  • organization_id (String) —

    The ID of the organization where the new membership will be created

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

    the optional parameters

Returns:

  • (Array<(OrganizationMembership, Integer, Hash)>) —

    OrganizationMembership data, response status code and response headers



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 41

def create_with_http_info(organization_id, create_organization_membership_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.create_organization_membership ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationMembershipsApi.create_organization_membership"
  end
  # verify the required parameter 'create_organization_membership_request' is set
  if @api_client.config.client_side_validation && create_organization_membership_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_organization_membership_request' when calling OrganizationMembershipsApi.create_organization_membership"
  end
  # resource path
  local_var_path = '/organizations/{organization_id}/memberships'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_organization_membership_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMembership'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.create_organization_membership",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationMembershipsApi#create_organization_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(organization_id, user_id, opts = {}) ⇒ OrganizationMembership

Remove a member from an organization Removes the given membership from the organization

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 105

def delete(organization_id, user_id, opts = {})
  data, _status_code, _headers = delete_with_http_info(organization_id, user_id, opts)
  data
end

#delete_with_http_info(organization_id, user_id, opts = {}) ⇒ Array<(OrganizationMembership, Integer, Hash)>

Remove a member from an organization Removes the given membership from the organization DELETE

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:

  • (Array<(OrganizationMembership, Integer, Hash)>) —

    OrganizationMembership data, response status code and response headers



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 117

def delete_with_http_info(organization_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.delete_organization_membership ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationMembershipsApi.delete_organization_membership"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationMembershipsApi.delete_organization_membership"
  end
  # resource path
  local_var_path = '/organizations/{organization_id}/memberships/{user_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMembership'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.delete_organization_membership",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationMembershipsApi#delete_organization_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(organization_id, user_id, update_organization_membership_request, opts = {}) ⇒ OrganizationMembership

Update an organization membership Updates the properties of an existing organization membership

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 343

def update(organization_id, user_id, update_organization_membership_request, opts = {})
  data, _status_code, _headers = update_with_http_info(organization_id, user_id, update_organization_membership_request, opts)
  data
end

#update_metadata(organization_id, user_id, update_organization_membership_metadata_request, opts = {}) ⇒ OrganizationMembership

Merge and update organization membership metadata Update an organization membership’s metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to ‘null`.

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:



425
426
427
428
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 425

def update_metadata(organization_id, user_id, update_organization_membership_metadata_request, opts = {})
  data, _status_code, _headers = update_metadata_with_http_info(organization_id, user_id, update_organization_membership_metadata_request, opts)
  data
end

#update_metadata_with_http_info(organization_id, user_id, update_organization_membership_metadata_request, opts = {}) ⇒ Array<(OrganizationMembership, Integer, Hash)>

Merge and update organization membership metadata Update an organization membership&#39;s metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to &#x60;null&#x60;. PATCH

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:

  • (Array<(OrganizationMembership, Integer, Hash)>) —

    OrganizationMembership data, response status code and response headers



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 438

def update_metadata_with_http_info(organization_id, user_id, update_organization_membership_metadata_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.update_organization_membership_metadata ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationMembershipsApi.update_organization_membership_metadata"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationMembershipsApi.update_organization_membership_metadata"
  end
  # verify the required parameter 'update_organization_membership_metadata_request' is set
  if @api_client.config.client_side_validation && update_organization_membership_metadata_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_membership_metadata_request' when calling OrganizationMembershipsApi.update_organization_membership_metadata"
  end
  # resource path
  local_var_path = '/organizations/{organization_id}/memberships/{user_id}/metadata'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_organization_membership_metadata_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMembership'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.update_organization_membership_metadata",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationMembershipsApi#update_organization_membership_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(organization_id, user_id, update_organization_membership_request, opts = {}) ⇒ Array<(OrganizationMembership, Integer, Hash)>

Update an organization membership Updates the properties of an existing organization membership PATCH

Parameters:

  • organization_id (String) —

    The ID of the organization the membership belongs to

  • user_id (String) —

    The ID of the user that this membership belongs to

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

    the optional parameters

Returns:

  • (Array<(OrganizationMembership, Integer, Hash)>) —

    OrganizationMembership data, response status code and response headers



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/clerk-http-client/api/organization_memberships_api.rb', line 356

def update_with_http_info(organization_id, user_id, update_organization_membership_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.update_organization_membership ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationMembershipsApi.update_organization_membership"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationMembershipsApi.update_organization_membership"
  end
  # verify the required parameter 'update_organization_membership_request' is set
  if @api_client.config.client_side_validation && update_organization_membership_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_organization_membership_request' when calling OrganizationMembershipsApi.update_organization_membership"
  end
  # resource path
  local_var_path = '/organizations/{organization_id}/memberships/{user_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_organization_membership_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationMembership'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OrganizationMembershipsApi.update_organization_membership",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationMembershipsApi#update_organization_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end