Class: SmplkitGeneratedClient::App::GroupMembershipsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupMembershipsApi

Returns a new instance of GroupMembershipsApi.



19
20
21
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_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/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_group_membership(group_membership_request, opts = {}) ⇒ GroupMembershipResponse

Create Group Membership Add a user to a group. The body references the user (UUID) and the group (key) in the resource attributes. Returns ‘409` if this user is already a member of this group, or `422` if either the user is not a member of the account or the group does not exist.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 27

def create_group_membership(group_membership_request, opts = {})
  data, _status_code, _headers = create_group_membership_with_http_info(group_membership_request, opts)
  data
end

#create_group_membership_with_http_info(group_membership_request, opts = {}) ⇒ Array<(GroupMembershipResponse, Integer, Hash)>

Create Group Membership Add a user to a group. The body references the user (UUID) and the group (key) in the resource attributes. Returns &#x60;409&#x60; if this user is already a member of this group, or &#x60;422&#x60; if either the user is not a member of the account or the group does not exist.

Parameters:

Returns:

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

    GroupMembershipResponse data, response status code and response headers



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 37

def create_group_membership_with_http_info(group_membership_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.create_group_membership ...'
  end
  # verify the required parameter 'group_membership_request' is set
  if @api_client.config.client_side_validation && group_membership_request.nil?
    fail ArgumentError, "Missing the required parameter 'group_membership_request' when calling GroupMembershipsApi.create_group_membership"
  end
  # resource path
  local_var_path = '/api/v1/group_memberships'

  # 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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(group_membership_request)

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

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

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

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

Delete Group Membership Remove a user from a group. Returns ‘409` when the membership is the user’s ‘default` membership — every user must remain in the `default` group per ADR-055 §4.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 95

def delete_group_membership(id, opts = {})
  delete_group_membership_with_http_info(id, opts)
  nil
end

#delete_group_membership_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Group Membership Remove a user from a group. Returns &#x60;409&#x60; when the membership is the user&#39;s &#x60;default&#x60; membership — every user must remain in the &#x60;default&#x60; group per ADR-055 §4.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 105

def delete_group_membership_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.delete_group_membership ...'
  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 GroupMembershipsApi.delete_group_membership"
  end
  # resource path
  local_var_path = '/api/v1/group_memberships/{id}'.sub('{id}', CGI.escape(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/vnd.api+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]

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

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

#get_group_membership(id, opts = {}) ⇒ GroupMembershipResponse

Get Group Membership Return a single membership by id.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 158

def get_group_membership(id, opts = {})
  data, _status_code, _headers = get_group_membership_with_http_info(id, opts)
  data
end

#get_group_membership_with_http_info(id, opts = {}) ⇒ Array<(GroupMembershipResponse, Integer, Hash)>

Get Group Membership Return a single membership by id.

Parameters:

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

    the optional parameters

Returns:

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

    GroupMembershipResponse data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 168

def get_group_membership_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.get_group_membership ...'
  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 GroupMembershipsApi.get_group_membership"
  end
  # resource path
  local_var_path = '/api/v1/group_memberships/{id}'.sub('{id}', CGI.escape(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/vnd.api+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] || 'GroupMembershipResponse'

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

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

#list_group_memberships(opts = {}) ⇒ GroupMembershipListResponse

List Group Memberships List group memberships in the authenticated account. Pass ‘filter` (a group key) to list members of a single group, or `filter` (a UUID) to list a single user’s memberships. The two filters may be combined to look up a specific (user, group) pair.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_group (String) —

    Group key to narrow the result to memberships in that group.

  • :filter_user (String) —

    User UUID to narrow the result to memberships for that user.

  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to ‘created_at’)

  • :page_number (Integer) —

    1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)

  • :page_size (Integer) —

    Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)

  • :meta_total (Boolean) —

    When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)

Returns:



226
227
228
229
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 226

def list_group_memberships(opts = {})
  data, _status_code, _headers = list_group_memberships_with_http_info(opts)
  data
end

#list_group_memberships_with_http_info(opts = {}) ⇒ Array<(GroupMembershipListResponse, Integer, Hash)>

List Group Memberships List group memberships in the authenticated account. Pass &#x60;filter&#x60; (a group key) to list members of a single group, or &#x60;filter&#x60; (a UUID) to list a single user&#39;s memberships. The two filters may be combined to look up a specific (user, group) pair.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_group (String) —

    Group key to narrow the result to memberships in that group.

  • :filter_user (String) —

    User UUID to narrow the result to memberships for that user.

  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to ‘created_at’)

  • :page_number (Integer) —

    1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)

  • :page_size (Integer) —

    Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)

  • :meta_total (Boolean) —

    When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)

Returns:

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

    GroupMembershipListResponse data, response status code and response headers



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb', line 241

def list_group_memberships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.list_group_memberships ...'
  end
  allowable_values = ["created_at", "-created_at", "updated_at", "-updated_at"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/group_memberships'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[group]'] = opts[:'filter_group'] if !opts[:'filter_group'].nil?
  query_params[:'filter[user]'] = opts[:'filter_user'] if !opts[:'filter_user'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'GroupMembershipListResponse'

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

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