gopad 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80f16670e8c67cf59de788ae0691f29dcc4e28ff63013e699cefa4e1a630f4b
-  data.tar.gz: 87cafb319781a1b95262f7dfc4a24e112d1ed7ccc8601827e6c43df4bc8ea434
+  metadata.gz: 30aa56a30ab22031aebf59af84cdd44ecfa07f009d43982c6bc6912ed1ee6195
+  data.tar.gz: 6fbfe49975e4c16db87eaf229b69a214ac7511e23c03298bd10ab0651f2e91c3
 SHA512:
-  metadata.gz: f230a243c0c5f616087986b26f9360af251c4d69dfe108931164529d3b360c5f2885fd0202743ecf5f7305b5e807b26de31308e2c3a5973131acd5d63024e100
-  data.tar.gz: 0317432cce69eb629f8c50eec0a4edf5aad047e8962f6396c5febb1dc57c37762688dd2f8fc7a6732ffafa55e8dfb4c725d123bceed275baf1b91342308cbb6e
+  metadata.gz: e37d3351bc9a316042bbffa5015452f2e4f67293fcac313bde94d743e927e92298cc3a23eedab936e71c78fee67d61cd7f8f53421d25bfcc56dcc3e1a2dc4d4a
+  data.tar.gz: 49940313af540de64974b727a524cd1be65a747860774b0cd21f13adadec52a9cef1222149ea96a3f43ce2f636df7d6944a083e2a5bde0a4128e6f1a46f5a020

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.1.0](https://github.com/gopad/gopad-ruby/compare/v1.0.0...v1.1.0) (2024-06-02)
+
+
+### Features
+
+* automated openapi client update ([b2cb046](https://github.com/gopad/gopad-ruby/commit/b2cb0466fc28014eb95610fedcf35031bd3207c3))
+* upgrade deps to latest version ([e8e6173](https://github.com/gopad/gopad-ruby/commit/e8e61735b57014c6031dcf8fea4f8c7020c8164a))
+
+
+### Bugfixes
+
+* apply new versions to lockfile ([83c50e9](https://github.com/gopad/gopad-ruby/commit/83c50e9a98b5289564dae19710d8ffbad8bd168b))
+* **deps:** update dependency rubocop to v1.64.1 ([14876a6](https://github.com/gopad/gopad-ruby/commit/14876a6b59a80d3b403e73d1b9c490425a92b240))
+* **deps:** update dependency ruby to v3.3.2 ([90c6338](https://github.com/gopad/gopad-ruby/commit/90c6338ae17985b70faea69de9bc7a3dae231db9))
+
 ## 1.0.0 (2024-05-28)
 
 

data/README.md

@@ -6,7 +6,7 @@ This repository provides a client SDK for Ruby. This SDK is automatically
 generated by the [OpenAPI Generator][generator] project:
 
 -   API version: 1.0.0-alpha1
--   Package version: 1.0.0
+-   Package version: 1.1.0
 -   Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://gopad.eu](https://gopad.eu)
@@ -21,7 +21,7 @@ the built gem:
 
 ```console
 gem build gopad.gemspec
-gem install ./gopad-1.0.0.gem
+gem install ./gopad-1.1.0.gem
 ```
 
 ### Install from Rubygems
@@ -30,7 +30,7 @@ If you want to use a a properly released version hosted Rubygems you just need
 to add the following line to your Gemfile:
 
 ```ruby
-gem 'gopad', '~> 1.0.0'
+gem 'gopad', '~> 1.1.0'
 ```
 
 ### Install from Git

data/lib/gopad/api/auth_api.rb

@@ -150,5 +150,182 @@ module Gopad
       end
       [data, status_code, headers]
     end
+
+    # Authenticate an user by credentials
+    # @param auth_login [AuthLogin] The credentials to authenticate
+    # @param [Hash] opts the optional parameters
+    # @return [AuthToken]
+    def login_auth(auth_login, opts = {})
+      data, _status_code, _headers = login_auth_with_http_info(auth_login, opts)
+      data
+    end
+
+    # Authenticate an user by credentials
+    # @param auth_login [AuthLogin] The credentials to authenticate
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthToken, Integer, Hash)>] AuthToken data, response status code and response headers
+    def login_auth_with_http_info(auth_login, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.login_auth ...'
+      end
+      # verify the required parameter 'auth_login' is set
+      if @api_client.config.client_side_validation && auth_login.nil?
+        raise ArgumentError, "Missing the required parameter 'auth_login' when calling AuthApi.login_auth"
+      end
+
+      # resource path
+      local_var_path = '/auth/login'
+
+      # 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'])
+      unless 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(auth_login)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        operation: :'AuthApi.login_auth',
+        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: AuthApi#login_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Refresh an auth token before it expires
+    # @param [Hash] opts the optional parameters
+    # @return [AuthToken]
+    def refresh_auth(opts = {})
+      data, _status_code, _headers = refresh_auth_with_http_info(opts)
+      data
+    end
+
+    # Refresh an auth token before it expires
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthToken, Integer, Hash)>] AuthToken data, response status code and response headers
+    def refresh_auth_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.refresh_auth ...'
+      end
+      # resource path
+      local_var_path = '/auth/refresh'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+
+      new_options = opts.merge(
+        operation: :'AuthApi.refresh_auth',
+        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: AuthApi#refresh_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Verify validity for an authentication token
+    # @param [Hash] opts the optional parameters
+    # @return [AuthVerify]
+    def verify_auth(opts = {})
+      data, _status_code, _headers = verify_auth_with_http_info(opts)
+      data
+    end
+
+    # Verify validity for an authentication token
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthVerify, Integer, Hash)>] AuthVerify data, response status code and response headers
+    def verify_auth_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.verify_auth ...'
+      end
+      # resource path
+      local_var_path = '/auth/verify'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthVerify'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+
+      new_options = opts.merge(
+        operation: :'AuthApi.verify_auth',
+        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: AuthApi#verify_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
   end
 end

data/lib/gopad/api/profile_api.rb

@@ -0,0 +1,198 @@
+# Gopad OpenAPI
+#
+# API definition for Gopad, Etherpad for markdown with go
+#
+# The version of the OpenAPI document: 1.0.0-alpha1
+# Contact: gopad@webhippie.de
+# Generated by: https://openapi-generator.tech
+# Generator version: 7.6.0
+#
+
+require 'cgi'
+
+module Gopad
+  class ProfileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Fetch profile details of the personal account
+    # @param [Hash] opts the optional parameters
+    # @return [Profile]
+    def show_profile(opts = {})
+      data, _status_code, _headers = show_profile_with_http_info(opts)
+      data
+    end
+
+    # Fetch profile details of the personal account
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Profile, Integer, Hash)>] Profile data, response status code and response headers
+    def show_profile_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.show_profile ...'
+      end
+      # resource path
+      local_var_path = '/profile/self'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Profile'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+
+      new_options = opts.merge(
+        operation: :'ProfileApi.show_profile',
+        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: ProfileApi#show_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Retrieve an unlimited auth token
+    # @param [Hash] opts the optional parameters
+    # @return [AuthToken]
+    def token_profile(opts = {})
+      data, _status_code, _headers = token_profile_with_http_info(opts)
+      data
+    end
+
+    # Retrieve an unlimited auth token
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthToken, Integer, Hash)>] AuthToken data, response status code and response headers
+    def token_profile_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.token_profile ...'
+      end
+      # resource path
+      local_var_path = '/profile/token'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+
+      new_options = opts.merge(
+        operation: :'ProfileApi.token_profile',
+        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: ProfileApi#token_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Update your own profile information
+    # @param profile [Profile] The profile data to update
+    # @param [Hash] opts the optional parameters
+    # @return [Profile]
+    def update_profile(profile, opts = {})
+      data, _status_code, _headers = update_profile_with_http_info(profile, opts)
+      data
+    end
+
+    # Update your own profile information
+    # @param profile [Profile] The profile data to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Profile, Integer, Hash)>] Profile data, response status code and response headers
+    def update_profile_with_http_info(profile, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.update_profile ...'
+      end
+      # verify the required parameter 'profile' is set
+      if @api_client.config.client_side_validation && profile.nil?
+        raise ArgumentError, "Missing the required parameter 'profile' when calling ProfileApi.update_profile"
+      end
+
+      # resource path
+      local_var_path = '/profile/self'
+
+      # 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'])
+      unless 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(profile)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Profile'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        operation: :'ProfileApi.update_profile',
+        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: ProfileApi#update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+  end
+end

data/lib/gopad/api/team_api.rb

@@ -72,7 +72,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.attach_team_to_user',
@@ -139,7 +139,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Team'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.create_team',
@@ -201,7 +201,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.delete_team',
@@ -274,7 +274,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.delete_team_from_user',
@@ -297,10 +297,10 @@ module Gopad
     # @param team_id [String] A team identifier or slug
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'username')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [TeamUsers]
     def list_team_users(team_id, opts = {})
       data, _status_code, _headers = list_team_users_with_http_info(team_id, opts)
@@ -311,10 +311,10 @@ module Gopad
     # @param team_id [String] A team identifier or slug
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'username')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [Array<(TeamUsers, Integer, Hash)>] TeamUsers data, response status code and response headers
     def list_team_users_with_http_info(team_id, opts = {})
       if @api_client.config.debugging
@@ -361,7 +361,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'TeamUsers'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.list_team_users',
@@ -383,10 +383,10 @@ module Gopad
     # Fetch all available teams
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'name')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [Teams]
     def list_teams(opts = {})
       data, _status_code, _headers = list_teams_with_http_info(opts)
@@ -396,10 +396,10 @@ module Gopad
     # Fetch all available teams
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'name')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [Array<(Teams, Integer, Hash)>] Teams data, response status code and response headers
     def list_teams_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -441,7 +441,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Teams'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.list_teams',
@@ -514,7 +514,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.permit_team_user',
@@ -576,7 +576,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Team'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.show_team',
@@ -649,7 +649,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Team'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'TeamApi.update_team',