permit-sdk 0.0.1

data/lib/openapi_client/api/role_assignments_api.rb

@@ -0,0 +1,278 @@
+=begin
+#Permit.io API
+
+# Authorization as a service 
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class RoleAssignmentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Assign Role
+    # Assigns a role to a user within a tenant.  The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
+    # @param role_assignment_create [RoleAssignmentCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [RoleAssignmentRead]
+    def assign_role(proj_id, env_id, role_assignment_create, opts = {})
+      data, _status_code, _headers = assign_role_with_http_info(proj_id, env_id, role_assignment_create, opts)
+      data
+    end
+
+    # Assign Role
+    # Assigns a role to a user within a tenant.  The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
+    # @param role_assignment_create [RoleAssignmentCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RoleAssignmentRead, Integer, Hash)>] RoleAssignmentRead data, response status code and response headers
+    def assign_role_with_http_info(proj_id, env_id, role_assignment_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RoleAssignmentsApi.assign_role ...'
+      end
+      # verify the required parameter 'proj_id' is set
+      if @api_client.config.client_side_validation && proj_id.nil?
+        fail ArgumentError, "Missing the required parameter 'proj_id' when calling RoleAssignmentsApi.assign_role"
+      end
+      # verify the required parameter 'env_id' is set
+      if @api_client.config.client_side_validation && env_id.nil?
+        fail ArgumentError, "Missing the required parameter 'env_id' when calling RoleAssignmentsApi.assign_role"
+      end
+      # verify the required parameter 'role_assignment_create' is set
+      if @api_client.config.client_side_validation && role_assignment_create.nil?
+        fail ArgumentError, "Missing the required parameter 'role_assignment_create' when calling RoleAssignmentsApi.assign_role"
+      end
+      # resource path
+      local_var_path = '/v2/facts/{proj_id}/{env_id}/role_assignments'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_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'])
+      # 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(role_assignment_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RoleAssignmentRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"RoleAssignmentsApi.assign_role",
+        :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: RoleAssignmentsApi#assign_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Role Assignments
+    # Lists the role assignments defined within an environment.  - If the `user` filter is present, will only return the role assignments of that user. - If the `tenant` filter is present, will only return the role assignments in that tenant. - If the `role` filter is present, will only return role assignments that are granting that role.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \&quot;slug\&quot;).
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \&quot;slug\&quot;).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user optional user filter, will only return role assignments granted to this user.
+    # @option opts [String] :role optional role filter, will only return role assignments granting this role.
+    # @option opts [String] :tenant optional tenant filter, will only return role assignments granted in that tenant.
+    # @option opts [Integer] :page Page number of the results to fetch, starting at 1. (default to 1)
+    # @option opts [Integer] :per_page The number of results per page (max 100). (default to 30)
+    # @return [Array<RoleAssignmentRead>]
+    def list_role_assignments(proj_id, env_id, opts = {})
+      data, _status_code, _headers = list_role_assignments_with_http_info(proj_id, env_id, opts)
+      data
+    end
+
+    # List Role Assignments
+    # Lists the role assignments defined within an environment.  - If the &#x60;user&#x60; filter is present, will only return the role assignments of that user. - If the &#x60;tenant&#x60; filter is present, will only return the role assignments in that tenant. - If the &#x60;role&#x60; filter is present, will only return role assignments that are granting that role.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \&quot;slug\&quot;).
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \&quot;slug\&quot;).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user optional user filter, will only return role assignments granted to this user.
+    # @option opts [String] :role optional role filter, will only return role assignments granting this role.
+    # @option opts [String] :tenant optional tenant filter, will only return role assignments granted in that tenant.
+    # @option opts [Integer] :page Page number of the results to fetch, starting at 1. (default to 1)
+    # @option opts [Integer] :per_page The number of results per page (max 100). (default to 30)
+    # @return [Array<(Array<RoleAssignmentRead>, Integer, Hash)>] Array<RoleAssignmentRead> data, response status code and response headers
+    def list_role_assignments_with_http_info(proj_id, env_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RoleAssignmentsApi.list_role_assignments ...'
+      end
+      # verify the required parameter 'proj_id' is set
+      if @api_client.config.client_side_validation && proj_id.nil?
+        fail ArgumentError, "Missing the required parameter 'proj_id' when calling RoleAssignmentsApi.list_role_assignments"
+      end
+      # verify the required parameter 'env_id' is set
+      if @api_client.config.client_side_validation && env_id.nil?
+        fail ArgumentError, "Missing the required parameter 'env_id' when calling RoleAssignmentsApi.list_role_assignments"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling RoleAssignmentsApi.list_role_assignments, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RoleAssignmentsApi.list_role_assignments, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RoleAssignmentsApi.list_role_assignments, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/facts/{proj_id}/{env_id}/role_assignments'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'user'] = opts[:'user'] if !opts[:'user'].nil?
+      query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
+      query_params[:'tenant'] = opts[:'tenant'] if !opts[:'tenant'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<RoleAssignmentRead>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"RoleAssignmentsApi.list_role_assignments",
+        :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: RoleAssignmentsApi#list_role_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unassign Role
+    # Unassigns a user role within a tenant.  The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.  If the role is not actually assigned, will return 404.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \&quot;slug\&quot;).
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \&quot;slug\&quot;).
+    # @param role_assignment_remove [RoleAssignmentRemove] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def unassign_role(proj_id, env_id, role_assignment_remove, opts = {})
+      unassign_role_with_http_info(proj_id, env_id, role_assignment_remove, opts)
+      nil
+    end
+
+    # Unassign Role
+    # Unassigns a user role within a tenant.  The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.  If the role is not actually assigned, will return 404.
+    # @param proj_id [String] Either the unique id of the project, or the URL-friendly key of the project (i.e: the \&quot;slug\&quot;).
+    # @param env_id [String] Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \&quot;slug\&quot;).
+    # @param role_assignment_remove [RoleAssignmentRemove] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def unassign_role_with_http_info(proj_id, env_id, role_assignment_remove, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RoleAssignmentsApi.unassign_role ...'
+      end
+      # verify the required parameter 'proj_id' is set
+      if @api_client.config.client_side_validation && proj_id.nil?
+        fail ArgumentError, "Missing the required parameter 'proj_id' when calling RoleAssignmentsApi.unassign_role"
+      end
+      # verify the required parameter 'env_id' is set
+      if @api_client.config.client_side_validation && env_id.nil?
+        fail ArgumentError, "Missing the required parameter 'env_id' when calling RoleAssignmentsApi.unassign_role"
+      end
+      # verify the required parameter 'role_assignment_remove' is set
+      if @api_client.config.client_side_validation && role_assignment_remove.nil?
+        fail ArgumentError, "Missing the required parameter 'role_assignment_remove' when calling RoleAssignmentsApi.unassign_role"
+      end
+      # resource path
+      local_var_path = '/v2/facts/{proj_id}/{env_id}/role_assignments'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_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'])
+      # 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(role_assignment_remove)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"RoleAssignmentsApi.unassign_role",
+        :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: RoleAssignmentsApi#unassign_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end