peal 0.1.0

data/lib/peal/api/notices_api.rb

@@ -0,0 +1,272 @@
+=begin
+#Peal API
+
+#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
+
+The version of the OpenAPI document: 0.0.1
+Contact: hello@peal.social
+Generated by: https://openapi-generator.tech
+Generator version: 7.27.0
+
+=end
+
+require 'cgi'
+
+module Peal
+  class NoticesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List notices
+    # Lists the user's notices, newest first, 20 a page unless `limit` (at most 100) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Each notice is data, for the client to write in the reader's language.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [String] :limit 
+    # @return [NoticePage]
+    def notices_list(opts = {})
+      data, _status_code, _headers = notices_list_with_http_info(opts)
+      data
+    end
+
+    # List notices
+    # Lists the user's notices, newest first, 20 a page unless `limit` (at most 100) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Each notice is data, for the client to write in the reader's language.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [String] :limit 
+    # @return [Array<(NoticePage, Integer, Hash)>] NoticePage data, response status code and response headers
+    def notices_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NoticesApi.notices_list ...'
+      end
+      pattern = Regexp.new(/^[+-]?(?:\d+(?:\.\d+)?|\.\d+)(?:[Ee][+-]?\d+)?$/)
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling NoticesApi.notices_list, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/me/notices'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'NoticePage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NoticesApi.notices_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: NoticesApi#notices_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark all notices read
+    # Marks every notice of the user read.
+    # @param [Hash] opts the optional parameters
+    # @return [UnreadNotices]
+    def notices_mark_all_read(opts = {})
+      data, _status_code, _headers = notices_mark_all_read_with_http_info(opts)
+      data
+    end
+
+    # Mark all notices read
+    # Marks every notice of the user read.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UnreadNotices, Integer, Hash)>] UnreadNotices data, response status code and response headers
+    def notices_mark_all_read_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NoticesApi.notices_mark_all_read ...'
+      end
+      # resource path
+      local_var_path = '/api/me/notices/read-all'
+
+      # 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] || 'UnreadNotices'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NoticesApi.notices_mark_all_read",
+        :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: NoticesApi#notices_mark_all_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark notices read
+    # Marks up to 100 of the user's notices read, and answers with how many stay unread. Ids that name none of the user's notices, and notices already read, are left as they are.
+    # @param mark_notices_read [MarkNoticesRead] 
+    # @param [Hash] opts the optional parameters
+    # @return [UnreadNotices]
+    def notices_mark_read(mark_notices_read, opts = {})
+      data, _status_code, _headers = notices_mark_read_with_http_info(mark_notices_read, opts)
+      data
+    end
+
+    # Mark notices read
+    # Marks up to 100 of the user&#39;s notices read, and answers with how many stay unread. Ids that name none of the user&#39;s notices, and notices already read, are left as they are.
+    # @param mark_notices_read [MarkNoticesRead] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UnreadNotices, Integer, Hash)>] UnreadNotices data, response status code and response headers
+    def notices_mark_read_with_http_info(mark_notices_read, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NoticesApi.notices_mark_read ...'
+      end
+      # verify the required parameter 'mark_notices_read' is set
+      if @api_client.config.client_side_validation && mark_notices_read.nil?
+        fail ArgumentError, "Missing the required parameter 'mark_notices_read' when calling NoticesApi.notices_mark_read"
+      end
+      # resource path
+      local_var_path = '/api/me/notices/read'
+
+      # 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'])
+      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(mark_notices_read)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UnreadNotices'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NoticesApi.notices_mark_read",
+        :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: NoticesApi#notices_mark_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Count unread notices
+    # Counts the user's unread notices.
+    # @param [Hash] opts the optional parameters
+    # @return [UnreadNotices]
+    def notices_unread(opts = {})
+      data, _status_code, _headers = notices_unread_with_http_info(opts)
+      data
+    end
+
+    # Count unread notices
+    # Counts the user&#39;s unread notices.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UnreadNotices, Integer, Hash)>] UnreadNotices data, response status code and response headers
+    def notices_unread_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NoticesApi.notices_unread ...'
+      end
+      # resource path
+      local_var_path = '/api/me/notices/unread'
+
+      # 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] || 'UnreadNotices'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NoticesApi.notices_unread",
+        :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: NoticesApi#notices_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/peal/api/notification_preferences_api.rb

@@ -0,0 +1,147 @@
+=begin
+#Peal API
+
+#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
+
+The version of the OpenAPI document: 0.0.1
+Contact: hello@peal.social
+Generated by: https://openapi-generator.tech
+Generator version: 7.27.0
+
+=end
+
+require 'cgi'
+
+module Peal
+  class NotificationPreferencesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get notification preferences
+    # Answers with which notices the user receives by email, and whether they hear about every post. Until they change it: failed and unconfirmed posts, and channels to reconnect, but not published posts, are emailed; and they hear only about the posts they wrote.
+    # @param [Hash] opts the optional parameters
+    # @return [NotificationPreferences]
+    def notification_preferences_get(opts = {})
+      data, _status_code, _headers = notification_preferences_get_with_http_info(opts)
+      data
+    end
+
+    # Get notification preferences
+    # Answers with which notices the user receives by email, and whether they hear about every post. Until they change it: failed and unconfirmed posts, and channels to reconnect, but not published posts, are emailed; and they hear only about the posts they wrote.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NotificationPreferences, Integer, Hash)>] NotificationPreferences data, response status code and response headers
+    def notification_preferences_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationPreferencesApi.notification_preferences_get ...'
+      end
+      # resource path
+      local_var_path = '/api/me/notification-preferences'
+
+      # 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] || 'NotificationPreferences'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NotificationPreferencesApi.notification_preferences_get",
+        :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: NotificationPreferencesApi#notification_preferences_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Change notification preferences
+    # Changes the preferences given, keeps the others, and answers with them all. Staff impersonating the user may not change them.
+    # @param notification_preferences_change [NotificationPreferencesChange] 
+    # @param [Hash] opts the optional parameters
+    # @return [NotificationPreferences]
+    def notification_preferences_update(notification_preferences_change, opts = {})
+      data, _status_code, _headers = notification_preferences_update_with_http_info(notification_preferences_change, opts)
+      data
+    end
+
+    # Change notification preferences
+    # Changes the preferences given, keeps the others, and answers with them all. Staff impersonating the user may not change them.
+    # @param notification_preferences_change [NotificationPreferencesChange] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NotificationPreferences, Integer, Hash)>] NotificationPreferences data, response status code and response headers
+    def notification_preferences_update_with_http_info(notification_preferences_change, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationPreferencesApi.notification_preferences_update ...'
+      end
+      # verify the required parameter 'notification_preferences_change' is set
+      if @api_client.config.client_side_validation && notification_preferences_change.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_preferences_change' when calling NotificationPreferencesApi.notification_preferences_update"
+      end
+      # resource path
+      local_var_path = '/api/me/notification-preferences'
+
+      # 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'])
+      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(notification_preferences_change)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NotificationPreferences'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"NotificationPreferencesApi.notification_preferences_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: NotificationPreferencesApi#notification_preferences_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end