weblate 0.1.0

data/lib/weblate/api/roles_api.rb

@@ -0,0 +1,429 @@
+=begin
+#Weblate's REST API
+
+# The API is accessible on the ``/api/`` URL and it is based on [Django REST framework](https://www.django-rest-framework.org/).  The OpenAPI specification is available as feature preview, feedback welcome!     
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module Weblate
+  class RolesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Roles API.
+    # @param role [Role] 
+    # @param [Hash] opts the optional parameters
+    # @return [Role]
+    def roles_create(role, opts = {})
+      data, _status_code, _headers = roles_create_with_http_info(role, opts)
+      data
+    end
+
+    # Roles API.
+    # @param role [Role] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers
+    def roles_create_with_http_info(role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_create ...'
+      end
+      # verify the required parameter 'role' is set
+      if @api_client.config.client_side_validation && role.nil?
+        fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.roles_create"
+      end
+      # resource path
+      local_var_path = '/roles/'
+
+      # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      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)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Role'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_create",
+        :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: RolesApi#roles_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def roles_destroy(id, opts = {})
+      roles_destroy_with_http_info(id, opts)
+      nil
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def roles_destroy_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_destroy ...'
+      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 RolesApi.roles_destroy"
+      end
+      pattern = Regexp.new(/^[^\/]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling RolesApi.roles_destroy, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/roles/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # 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] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_destroy",
+        :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: RolesApi#roles_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roles API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @return [PaginatedRoleList]
+    def roles_list(opts = {})
+      data, _status_code, _headers = roles_list_with_http_info(opts)
+      data
+    end
+
+    # Roles API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @return [Array<(PaginatedRoleList, Integer, Hash)>] PaginatedRoleList data, response status code and response headers
+    def roles_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_list ...'
+      end
+      # resource path
+      local_var_path = '/roles/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'PaginatedRoleList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_list",
+        :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: RolesApi#roles_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PatchedRole] :patched_role 
+    # @return [Role]
+    def roles_partial_update(id, opts = {})
+      data, _status_code, _headers = roles_partial_update_with_http_info(id, opts)
+      data
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PatchedRole] :patched_role 
+    # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers
+    def roles_partial_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_partial_update ...'
+      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 RolesApi.roles_partial_update"
+      end
+      pattern = Regexp.new(/^[^\/]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling RolesApi.roles_partial_update, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/roles/{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/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      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(opts[:'patched_role'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Role'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_partial_update",
+        :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: RolesApi#roles_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Role]
+    def roles_retrieve(id, opts = {})
+      data, _status_code, _headers = roles_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers
+    def roles_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_retrieve ...'
+      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 RolesApi.roles_retrieve"
+      end
+      pattern = Regexp.new(/^[^\/]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling RolesApi.roles_retrieve, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/roles/{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/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] || 'Role'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_retrieve",
+        :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: RolesApi#roles_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param role [Role] 
+    # @param [Hash] opts the optional parameters
+    # @return [Role]
+    def roles_update(id, role, opts = {})
+      data, _status_code, _headers = roles_update_with_http_info(id, role, opts)
+      data
+    end
+
+    # Roles API.
+    # @param id [String] 
+    # @param role [Role] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers
+    def roles_update_with_http_info(id, role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RolesApi.roles_update ...'
+      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 RolesApi.roles_update"
+      end
+      pattern = Regexp.new(/^[^\/]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling RolesApi.roles_update, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'role' is set
+      if @api_client.config.client_side_validation && role.nil?
+        fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.roles_update"
+      end
+      # resource path
+      local_var_path = '/roles/{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/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      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)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Role'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"RolesApi.roles_update",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RolesApi#roles_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end