Class: PulpcoreClient::GroupsModelPermissionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/groups_model_permissions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsModelPermissionsApi

Returns a new instance of GroupsModelPermissionsApi.


19
20
21
# File 'lib/pulpcore_client/api/groups_model_permissions_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


17
18
19
# File 'lib/pulpcore_client/api/groups_model_permissions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(auth_auth_groups_permission_href, body, opts = {}) ⇒ PermissionResponse

Create a permission Add a model permission to a group.

Parameters:

  • auth_auth_groups_permission_href (String)
  • body (Object)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:


28
29
30
31
# File 'lib/pulpcore_client/api/groups_model_permissions_api.rb', line 28

def create(auth_auth_groups_permission_href, body, opts = {})
  data, _status_code, _headers = create_with_http_info(auth_auth_groups_permission_href, body, opts)
  data
end

#create_with_http_info(auth_auth_groups_permission_href, body, opts = {}) ⇒ Array<(PermissionResponse, Integer, Hash)>

Create a permission Add a model permission to a group.

Parameters:

  • auth_auth_groups_permission_href (String)
  • body (Object)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(PermissionResponse, Integer, Hash)>)

    PermissionResponse data, response status code and response headers


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
89
90
# File 'lib/pulpcore_client/api/groups_model_permissions_api.rb', line 39

def create_with_http_info(auth_auth_groups_permission_href, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsModelPermissionsApi.create ...'
  end
  # verify the required parameter 'auth_auth_groups_permission_href' is set
  if @api_client.config.client_side_validation && auth_auth_groups_permission_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_auth_groups_permission_href' when calling GroupsModelPermissionsApi.create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling GroupsModelPermissionsApi.create"
  end
  # resource path
  local_var_path = '{auth_auth_groups_permission_href}model_permissions/'.sub('{' + 'auth_auth_groups_permission_href' + '}', CGI.escape(auth_auth_groups_permission_href.to_s).gsub('%2F', '/'))

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

  # return_type
  return_type = opts[:return_type] || 'PermissionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#list(auth_group_href, opts = {}) ⇒ PaginatedPermissionResponseList

List permissions List group permissions.

Parameters:

  • auth_group_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

    Number of results to return per page.

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.

Returns:


102
103
104
105
# File 'lib/pulpcore_client/api/groups_model_permissions_api.rb', line 102

def list(auth_group_href, opts = {})
  data, _status_code, _headers = list_with_http_info(auth_group_href, opts)
  data
end

#list_with_http_info(auth_group_href, opts = {}) ⇒ Array<(PaginatedPermissionResponseList, Integer, Hash)>

List permissions List group permissions.

Parameters:

  • auth_group_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

    Number of results to return per page.

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.

Returns:


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/pulpcore_client/api/groups_model_permissions_api.rb', line 117

def list_with_http_info(auth_group_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsModelPermissionsApi.list ...'
  end
  # verify the required parameter 'auth_group_href' is set
  if @api_client.config.client_side_validation && auth_group_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_group_href' when calling GroupsModelPermissionsApi.list"
  end
  # resource path
  local_var_path = '{auth_group_href}model_permissions/'.sub('{' + 'auth_group_href' + '}', CGI.escape(auth_group_href.to_s).gsub('%2F', '/'))

  # 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[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'PaginatedPermissionResponseList' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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