notifo-io 1.0.1.2 → 1.2.0

data/lib/notifo/api/notifications_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.26
+Swagger Codegen version: 3.0.36
 =end
 
 module Notifo
@@ -20,8 +20,8 @@ module Notifo
     # @param body The request object.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def notifications_confirm(body, opts = {})
-      notifications_confirm_with_http_info(body, opts)
+    def notifications_confirm_me(body, opts = {})
+      notifications_confirm_me_with_http_info(body, opts)
       nil
     end
 
@@ -29,13 +29,13 @@ module Notifo
     # @param body The request object.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def notifications_confirm_with_http_info(body, opts = {})
+    def notifications_confirm_me_with_http_info(body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_confirm ...'
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_confirm_me ...'
       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 NotificationsApi.notifications_confirm"
+        fail ArgumentError, "Missing the required parameter 'body' when calling NotificationsApi.notifications_confirm_me"
       end
       # resource path
       local_var_path = '/api/me/notifications/handled'
@@ -68,30 +68,165 @@ module Notifo
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationsApi#notifications_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: NotificationsApi#notifications_confirm_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
-    # Query archhived user notifications of the current user.
+    # Query notifications.
+    # @param app_id The app where the user belongs to.
     # @param [Hash] opts the optional parameters
-    # @return [ListResponseDtoOfNotificationDto]
-    def notifications_get_archive(opts = {})
-      data, _status_code, _headers = notifications_get_archive_with_http_info(opts)
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
+    # @option opts [String] :query The optional query to search for items.
+    # @option opts [Integer] :take The number of items to return.
+    # @option opts [Integer] :skip The number of items to skip.
+    # @return [ListResponseDtoOfUserNotificationDetailsDto]
+    def notifications_get_all_notifications(app_id, opts = {})
+      data, _status_code, _headers = notifications_get_all_notifications_with_http_info(app_id, opts)
       data
     end
 
-    # Query archhived user notifications of the current user.
+    # Query notifications.
+    # @param app_id The app where the user belongs to.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ListResponseDtoOfNotificationDto, Integer, Hash)>] ListResponseDtoOfNotificationDto data, response status code and response headers
-    def notifications_get_archive_with_http_info(opts = {})
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
+    # @option opts [String] :query The optional query to search for items.
+    # @option opts [Integer] :take The number of items to return.
+    # @option opts [Integer] :skip The number of items to skip.
+    # @return [Array<(ListResponseDtoOfUserNotificationDetailsDto, Integer, Hash)>] ListResponseDtoOfUserNotificationDetailsDto data, response status code and response headers
+    def notifications_get_all_notifications_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_archive ...'
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_all_notifications ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling NotificationsApi.notifications_get_all_notifications"
+      end
+      # resource path
+      local_var_path = '/api/apps/{appId}/notifications'.sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
+      query_params[:'Channel'] = opts[:'channel'] if !opts[:'channel'].nil?
+      query_params[:'CorrelationId'] = opts[:'correlation_id'] if !opts[:'correlation_id'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
+      query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].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 = opts[:return_type] || 'ListResponseDtoOfUserNotificationDetailsDto' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#notifications_get_all_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Query archived user notifications of the current user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :channel The tracking channel.
+    # @return [ListResponseDtoOfUserNotificationDto]
+    def notifications_get_my_archive(opts = {})
+      data, _status_code, _headers = notifications_get_my_archive_with_http_info(opts)
+      data
+    end
+
+    # Query archived user notifications of the current user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :channel The tracking channel.
+    # @return [Array<(ListResponseDtoOfUserNotificationDto, Integer, Hash)>] ListResponseDtoOfUserNotificationDto data, response status code and response headers
+    def notifications_get_my_archive_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_my_archive ...'
       end
       # resource path
       local_var_path = '/api/me/notifications/archive'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].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 = opts[:return_type] || 'ListResponseDtoOfUserNotificationDto' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#notifications_get_my_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Query user notifications of the current user for a specific device.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :device_identifier The device identifier (aka mobile push token).
+    # @option opts [DateTime] :after The max age of the notifications.
+    # @option opts [BOOLEAN] :include_unseen True to also include unseen notifications.
+    # @option opts [Integer] :take The number of notifications to query.
+    # @return [ListResponseDtoOfUserNotificationDto]
+    def notifications_get_my_device_notifications(opts = {})
+      data, _status_code, _headers = notifications_get_my_device_notifications_with_http_info(opts)
+      data
+    end
+
+    # Query user notifications of the current user for a specific device.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :device_identifier The device identifier (aka mobile push token).
+    # @option opts [DateTime] :after The max age of the notifications.
+    # @option opts [BOOLEAN] :include_unseen True to also include unseen notifications.
+    # @option opts [Integer] :take The number of notifications to query.
+    # @return [Array<(ListResponseDtoOfUserNotificationDto, Integer, Hash)>] ListResponseDtoOfUserNotificationDto data, response status code and response headers
+    def notifications_get_my_device_notifications_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_my_device_notifications ...'
+      end
+      # resource path
+      local_var_path = '/api/me/notifications/device'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'DeviceIdentifier'] = opts[:'device_identifier'] if !opts[:'device_identifier'].nil?
+      query_params[:'After'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'IncludeUnseen'] = opts[:'include_unseen'] if !opts[:'include_unseen'].nil?
+      query_params[:'Take'] = opts[:'take'] if !opts[:'take'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -104,7 +239,7 @@ module Notifo
       # http body (model)
       post_body = opts[:body] 
 
-      return_type = opts[:return_type] || 'ListResponseDtoOfNotificationDto' 
+      return_type = opts[:return_type] || 'ListResponseDtoOfUserNotificationDto' 
 
       auth_names = opts[:auth_names] || []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
@@ -116,36 +251,123 @@ module Notifo
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationsApi#notifications_get_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: NotificationsApi#notifications_get_my_device_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
     # Query user notifications of the current user.
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
     # @option opts [String] :query The optional query to search for items.
     # @option opts [Integer] :take The number of items to return.
     # @option opts [Integer] :skip The number of items to skip.
-    # @return [ListResponseDtoOfNotificationDto]
-    def notifications_get_notifications(opts = {})
-      data, _status_code, _headers = notifications_get_notifications_with_http_info(opts)
+    # @return [ListResponseDtoOfUserNotificationDto]
+    def notifications_get_my_notifications(opts = {})
+      data, _status_code, _headers = notifications_get_my_notifications_with_http_info(opts)
       data
     end
 
     # Query user notifications of the current user.
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
     # @option opts [String] :query The optional query to search for items.
     # @option opts [Integer] :take The number of items to return.
     # @option opts [Integer] :skip The number of items to skip.
-    # @return [Array<(ListResponseDtoOfNotificationDto, Integer, Hash)>] ListResponseDtoOfNotificationDto data, response status code and response headers
-    def notifications_get_notifications_with_http_info(opts = {})
+    # @return [Array<(ListResponseDtoOfUserNotificationDto, Integer, Hash)>] ListResponseDtoOfUserNotificationDto data, response status code and response headers
+    def notifications_get_my_notifications_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_notifications ...'
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_my_notifications ...'
       end
       # resource path
       local_var_path = '/api/me/notifications'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
+      query_params[:'Channel'] = opts[:'channel'] if !opts[:'channel'].nil?
+      query_params[:'CorrelationId'] = opts[:'correlation_id'] if !opts[:'correlation_id'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
+      query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].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 = opts[:return_type] || 'ListResponseDtoOfUserNotificationDto' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#notifications_get_my_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Query user notifications.
+    # @param app_id The app where the user belongs to.
+    # @param id The user id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
+    # @option opts [String] :query The optional query to search for items.
+    # @option opts [Integer] :take The number of items to return.
+    # @option opts [Integer] :skip The number of items to skip.
+    # @return [ListResponseDtoOfUserNotificationDetailsDto]
+    def notifications_get_notifications(app_id, id, opts = {})
+      data, _status_code, _headers = notifications_get_notifications_with_http_info(app_id, id, opts)
+      data
+    end
+
+    # Query user notifications.
+    # @param app_id The app where the user belongs to.
+    # @param id The user id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :channels The active channels.
+    # @option opts [String] :channel The source channel.
+    # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
+    # @option opts [String] :query The optional query to search for items.
+    # @option opts [Integer] :take The number of items to return.
+    # @option opts [Integer] :skip The number of items to skip.
+    # @return [Array<(ListResponseDtoOfUserNotificationDetailsDto, Integer, Hash)>] ListResponseDtoOfUserNotificationDetailsDto data, response status code and response headers
+    def notifications_get_notifications_with_http_info(app_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_notifications ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling NotificationsApi.notifications_get_notifications"
+      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 NotificationsApi.notifications_get_notifications"
+      end
+      # resource path
+      local_var_path = '/api/apps/{appId}/users/{id}/notifications'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
+      query_params[:'Channel'] = opts[:'channel'] if !opts[:'channel'].nil?
+      query_params[:'CorrelationId'] = opts[:'correlation_id'] if !opts[:'correlation_id'].nil?
       query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
       query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
       query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
@@ -161,7 +383,7 @@ module Notifo
       # http body (model)
       post_body = opts[:body] 
 
-      return_type = opts[:return_type] || 'ListResponseDtoOfNotificationDto' 
+      return_type = opts[:return_type] || 'ListResponseDtoOfUserNotificationDetailsDto' 
 
       auth_names = opts[:auth_names] || []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,

data/lib/notifo/api/{authorization_api.rb → ping_api.rb}

@@ -6,31 +6,35 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.26
+Swagger Codegen version: 3.0.36
 =end
 
 module Notifo
-  class AuthorizationApi
+  class PingApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get some info about the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def authorization_authorize(opts = {})
-      authorization_authorize_with_http_info(opts)
-      nil
+    # @return [InfoDto]
+    def ping_get_info(opts = {})
+      data, _status_code, _headers = ping_get_info_with_http_info(opts)
+      data
     end
 
+    # Get some info about the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def authorization_authorize_with_http_info(opts = {})
+    # @return [Array<(InfoDto, Integer, Hash)>] InfoDto data, response status code and response headers
+    def ping_get_info_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthorizationApi.authorization_authorize ...'
+        @api_client.config.logger.debug 'Calling API: PingApi.ping_get_info ...'
       end
       # resource path
-      local_var_path = '/connect/authorize'
+      local_var_path = '/api/info'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -46,7 +50,7 @@ module Notifo
       # http body (model)
       post_body = opts[:body] 
 
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'InfoDto' 
 
       auth_names = opts[:auth_names] || []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
@@ -58,25 +62,29 @@ module Notifo
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AuthorizationApi#authorization_authorize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PingApi#ping_get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+    # Get ping status of the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def authorization_exchange(opts = {})
-      authorization_exchange_with_http_info(opts)
+    def ping_get_old_ping(opts = {})
+      ping_get_old_ping_with_http_info(opts)
       nil
     end
 
+    # Get ping status of the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def authorization_exchange_with_http_info(opts = {})
+    def ping_get_old_ping_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthorizationApi.authorization_exchange ...'
+        @api_client.config.logger.debug 'Calling API: PingApi.ping_get_old_ping ...'
       end
       # resource path
-      local_var_path = '/connect/token'
+      local_var_path = '/ping'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -95,7 +103,7 @@ module Notifo
       return_type = opts[:return_type] 
 
       auth_names = opts[:auth_names] || []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -104,25 +112,29 @@ module Notifo
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AuthorizationApi#authorization_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PingApi#ping_get_old_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+    # Get ping status of the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def authorization_logout(opts = {})
-      authorization_logout_with_http_info(opts)
+    def ping_get_ping(opts = {})
+      ping_get_ping_with_http_info(opts)
       nil
     end
 
+    # Get ping status of the API.
+    # Can be used to test, if the Squidex API is alive and responding.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def authorization_logout_with_http_info(opts = {})
+    def ping_get_ping_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthorizationApi.authorization_logout ...'
+        @api_client.config.logger.debug 'Calling API: PingApi.ping_get_ping ...'
       end
       # resource path
-      local_var_path = '/connect/logout'
+      local_var_path = '/api/ping'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -150,7 +162,7 @@ module Notifo
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AuthorizationApi#authorization_logout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PingApi#ping_get_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end