sunshine-conversations-client 16.0.1 → 17.0.0

data/lib/sunshine-conversations-client/api/users_api.rb

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'cgi'
@@ -54,23 +54,27 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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[:body] || @api_client.object_to_http_body(user_create_body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_body)
 
       # return_type
-      return_type = opts[:return_type] || 'UserResponse' 
+      return_type = opts[:debug_return_type] || 'UserResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.create_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -124,21 +128,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Object' 
+      return_type = opts[:debug_return_type] || 'Object'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.delete_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -192,21 +197,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'UserResponse' 
+      return_type = opts[:debug_return_type] || 'UserResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.delete_user_personal_information",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -260,21 +266,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'UserResponse' 
+      return_type = opts[:debug_return_type] || 'UserResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.get_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -330,23 +337,27 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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[:body] || @api_client.object_to_http_body(opts[:'sync_user_body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sync_user_body'])
 
       # return_type
-      return_type = opts[:return_type] || 'UserResponse' 
+      return_type = opts[:debug_return_type] || 'UserResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.sync_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -406,23 +417,27 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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[:body] || @api_client.object_to_http_body(user_update_body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_update_body)
 
       # return_type
-      return_type = opts[:return_type] || 'UserResponse' 
+      return_type = opts[:debug_return_type] || 'UserResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"UsersApi.update_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/sunshine-conversations-client/api/webhooks_api.rb

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'cgi'
@@ -60,23 +60,27 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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[:body] || @api_client.object_to_http_body(webhook_create_body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_create_body)
 
       # return_type
-      return_type = opts[:return_type] || 'WebhookResponse' 
+      return_type = opts[:debug_return_type] || 'WebhookResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"WebhooksApi.create_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -136,21 +140,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Object' 
+      return_type = opts[:debug_return_type] || 'Object'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"WebhooksApi.delete_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -210,21 +215,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'WebhookResponse' 
+      return_type = opts[:debug_return_type] || 'WebhookResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"WebhooksApi.get_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -278,21 +284,22 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      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[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'WebhookListResponse' 
+      return_type = opts[:debug_return_type] || 'WebhookListResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"WebhooksApi.list_webhooks",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -358,23 +365,27 @@ module SunshineConversationsClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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[:body] || @api_client.object_to_http_body(webhook_body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_body)
 
       # return_type
-      return_type = opts[:return_type] || 'WebhookResponse' 
+      return_type = opts[:debug_return_type] || 'WebhookResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']
 
       new_options = opts.merge(
+        :operation => :"WebhooksApi.update_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/sunshine-conversations-client/api_client.rb

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'date'
@@ -42,9 +42,11 @@ module SunshineConversationsClient
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = nil
+      (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -66,7 +68,9 @@ module SunshineConversationsClient
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -84,12 +88,13 @@ module SunshineConversationsClient
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -106,7 +111,8 @@ module SunshineConversationsClient
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided
@@ -120,9 +126,7 @@ module SunshineConversationsClient
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -153,6 +157,47 @@ module SunshineConversationsClient
       data
     end
 
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
+    #
+    # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
+    def download_file(request)
+      tempfile = nil
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do
+        if !tempfile
+          fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
+        end
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+        yield tempfile if block_given?
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json

data/lib/sunshine-conversations-client/api_error.rb

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 module SunshineConversationsClient
@@ -29,6 +29,7 @@ module SunshineConversationsClient
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/sunshine-conversations-client/configuration.rb

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 module SunshineConversationsClient
@@ -88,41 +88,38 @@ module SunshineConversationsClient
     # @return [true, false]
     attr_accessor :client_side_validation
 
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Set this to false to skip SSL certificate verification
     # Default to true.
     #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
     # @return [true, false]
     attr_accessor :verify_ssl
 
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
+    # Set this to false to skip SSL host verification
     # Default to true.
     #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
     # @return [true, false]
     attr_accessor :verify_ssl_host
 
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
+    # TLS/SSL setting
+    # Set this to specify the path to SSL client cert file (.pem format)
+    # Default to nil.
     #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-    attr_accessor :ssl_ca_cert
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
+    # @return [String]
     attr_accessor :cert_file
 
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
+    # TLS/SSL setting
+    # Set this to specify the path to SSL client key file (.pem format)
+    # Default to nil.
+    #
+    # @return [String]
     attr_accessor :key_file
 
+    # TLS/SSL setting
+    # Set this to specify the path to SSL CA certificate file (.pem format)
+    # Default to nil.
+    #
+    # @return [String]
+    attr_accessor :ssl_ca_cert
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
     #
@@ -151,6 +148,7 @@ module SunshineConversationsClient
       @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @ssl_ca_cert = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -210,13 +208,6 @@ module SunshineConversationsClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'basicAuth' =>
-          {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
-            value: basic_auth_token
-          },
         'bearerAuth' =>
           {
             type: 'bearer',
@@ -225,6 +216,13 @@ module SunshineConversationsClient
             key: 'Authorization',
             value: access_token ? "Bearer #{access_token}" : nil 
           },
+        'basicAuth' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
       }
     end