xero-ruby 2.6.1 → 2.8.1

data/lib/xero-ruby/api/asset_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Xero Assets API
 
-#This is the Xero Assets API
+#The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
 
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
@@ -168,7 +168,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # retrieves fixed asset by id
+    # Retrieves fixed asset by id
     # By passing in the appropriate asset id, you can search for a specific fixed asset in the system 
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param id [String] fixed asset id for single object
@@ -179,7 +179,7 @@ module XeroRuby
       data
     end
 
-    # retrieves fixed asset by id
+    # Retrieves fixed asset by id
     # By passing in the appropriate asset id, you can search for a specific fixed asset in the system 
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param id [String] fixed asset id for single object
@@ -431,10 +431,6 @@ module XeroRuby
       if @api_client.config.client_side_validation && opts[:'sort_direction'] && !allowable_values.include?(opts[:'sort_direction'])
         fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{allowable_values}"
       end
-      allowable_values = ["AssetName", "AssetNumber", "Description", "AssetTypeName"]
-      if @api_client.config.client_side_validation && opts[:'filter_by'] && !allowable_values.include?(opts[:'filter_by'])
-        fail ArgumentError, "invalid value for \"filter_by\", must be one of #{allowable_values}"
-      end
       # resource path
       local_var_path = '/Assets'
 

data/lib/xero-ruby/api/files_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Xero Files API
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#These endpoints are specific to Xero Files API
 
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
@@ -16,7 +16,7 @@ module XeroRuby
     def initialize(api_client = ApiClient.new)
       @api_client = api_client
     end
-    # create a new association
+    # Creates a new file association
     # By passing in the appropriate options, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -28,7 +28,7 @@ module XeroRuby
       data
     end
 
-    # create a new association
+    # Creates a new file association
     # By passing in the appropriate options, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -96,7 +96,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # create a new folder
+    # Creates a new folder
     # By passing in the appropriate properties, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -107,7 +107,7 @@ module XeroRuby
       data
     end
 
-    # create a new folder
+    # Creates a new folder
     # By passing in the appropriate properties, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -170,23 +170,23 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # delete a file
+    # Deletes a specific file
     # Delete a specific file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
-    # @return [FileResponse204]
+    # @return [nil]
     def delete_file(xero_tenant_id, file_id, opts = {})
-      data, _status_code, _headers = delete_file_with_http_info(xero_tenant_id, file_id, opts)
-      data
+      delete_file_with_http_info(xero_tenant_id, file_id, opts)
+      nil
     end
 
-    # delete a file
+    # Deletes a specific file
     # Delete a specific file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
-    # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_file_with_http_info(xero_tenant_id, file_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FilesApi.delete_file ...'
@@ -214,8 +214,6 @@ module XeroRuby
 
       # header parameters
       header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'xero-tenant-id'] = xero_tenant_id
 
       # form parameters
@@ -225,7 +223,7 @@ module XeroRuby
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileResponse204' 
+      return_type = opts[:return_type] 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']
@@ -246,25 +244,25 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # create a new association
+    # Deletes an existing file association
     # By passing in the appropriate options, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param object_id [String] Object id for single object
     # @param [Hash] opts the optional parameters
-    # @return [FileResponse204]
+    # @return [nil]
     def delete_file_association(xero_tenant_id, file_id, object_id, opts = {})
-      data, _status_code, _headers = delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
-      data
+      delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
+      nil
     end
 
-    # create a new association
+    # Deletes an existing file association
     # By passing in the appropriate options, you can create a new folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param object_id [String] Object id for single object
     # @param [Hash] opts the optional parameters
-    # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FilesApi.delete_file_association ...'
@@ -296,8 +294,6 @@ module XeroRuby
 
       # header parameters
       header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'xero-tenant-id'] = xero_tenant_id
 
       # form parameters
@@ -307,7 +303,7 @@ module XeroRuby
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileResponse204' 
+      return_type = opts[:return_type] 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']
@@ -328,23 +324,23 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # delete a folder
+    # Deletes a folder
     # By passing in the appropriate ID, you can delete a folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
     # @param [Hash] opts the optional parameters
-    # @return [FileResponse204]
+    # @return [nil]
     def delete_folder(xero_tenant_id, folder_id, opts = {})
-      data, _status_code, _headers = delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
-      data
+      delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
+      nil
     end
 
-    # delete a folder
+    # Deletes a folder
     # By passing in the appropriate ID, you can delete a folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
     # @param [Hash] opts the optional parameters
-    # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_folder_with_http_info(xero_tenant_id, folder_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FilesApi.delete_folder ...'
@@ -372,8 +368,6 @@ module XeroRuby
 
       # header parameters
       header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'xero-tenant-id'] = xero_tenant_id
 
       # form parameters
@@ -383,7 +377,7 @@ module XeroRuby
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileResponse204' 
+      return_type = opts[:return_type] 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']
@@ -404,7 +398,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches files
+    # Retrieves an association object using a unique object ID
     # By passing in the appropriate options,
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param object_id [String] Object id for single object
@@ -415,7 +409,7 @@ module XeroRuby
       data
     end
 
-    # searches files
+    # Retrieves an association object using a unique object ID
     # By passing in the appropriate options,
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param object_id [String] Object id for single object
@@ -480,7 +474,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches for file by unique id
+    # Retrieves a file by a unique file ID
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
@@ -490,7 +484,7 @@ module XeroRuby
       data
     end
 
-    # searches for file by unique id
+    # Retrieves a file by a unique file ID
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
@@ -554,7 +548,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches files
+    # Retrieves a specific file associations
     # By passing in the appropriate options,  
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -565,7 +559,7 @@ module XeroRuby
       data
     end
 
-    # searches files
+    # Retrieves a specific file associations
     # By passing in the appropriate options,  
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -630,7 +624,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches files to retrieve the data
+    # Retrieves the content of a specific file
     # By passing in the appropriate options, retrieve data for specific file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -641,7 +635,7 @@ module XeroRuby
       data
     end
 
-    # searches files to retrieve the data
+    # Retrieves the content of a specific file
     # By passing in the appropriate options, retrieve data for specific file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
@@ -706,7 +700,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches files
+    # Retrieves files
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :pagesize pass an optional page size value
@@ -718,7 +712,7 @@ module XeroRuby
       data
     end
 
-    # searches files
+    # Retrieves files
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :pagesize pass an optional page size value
@@ -795,7 +789,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches specific folder by id
+    # Retrieves specific folder by using a unique folder ID
     # By passing in the appropriate ID, you can search for specific folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
@@ -806,7 +800,7 @@ module XeroRuby
       data
     end
 
-    # searches specific folder by id
+    # Retrieves specific folder by using a unique folder ID
     # By passing in the appropriate ID, you can search for specific folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
@@ -871,7 +865,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches folder
+    # Retrieves folders
     # By passing in the appropriate options, you can search for available folders
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -882,7 +876,7 @@ module XeroRuby
       data
     end
 
-    # searches folder
+    # Retrieves folders
     # By passing in the appropriate options, you can search for available folders
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -948,7 +942,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # searches inbox folder
+    # Retrieves inbox folder
     # Search for the user inbox
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -958,7 +952,7 @@ module XeroRuby
       data
     end
 
-    # searches inbox folder
+    # Retrieves inbox folder
     # Search for the user inbox
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
@@ -1019,7 +1013,7 @@ module XeroRuby
     end
 
     # Update a file
-    # Update properties on a single file
+    # Updates file properties of a single file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
@@ -1031,7 +1025,7 @@ module XeroRuby
     end
 
     # Update a file
-    # Update properties on a single file
+    # Updates file properties of a single file
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object
     # @param [Hash] opts the optional parameters
@@ -1098,7 +1092,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # update folder
+    # Updates an existing folder
     # By passing in the appropriate ID and properties, you can update a folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
@@ -1110,7 +1104,7 @@ module XeroRuby
       data
     end
 
-    # update folder
+    # Updates an existing folder
     # By passing in the appropriate ID and properties, you can update a folder
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param folder_id [String] Folder id for single object
@@ -1182,30 +1176,28 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # upload an File
+    # Uploads a File to the inbox
     # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param body [String] 
+    # @param name [String] exact name of the file you are uploading
+    # @param filename [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :folder_id pass an optional folder id to save file to specific folder
-    # @option opts [String] :body 
-    # @option opts [String] :name exact name of the file you are uploading
-    # @option opts [String] :filename 
     # @option opts [String] :mime_type 
     # @return [FileObject]
-    def upload_file(xero_tenant_id, opts = {})
-      data, _status_code, _headers = upload_file_with_http_info(xero_tenant_id, opts)
+    def upload_file(xero_tenant_id, body, name, filename, opts = {})
+      data, _status_code, _headers = upload_file_with_http_info(xero_tenant_id, body, name, filename, opts)
       data
     end
 
-    # upload an File
+    # Uploads a File to the inbox
     # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param body [String] 
+    # @param name [String] exact name of the file you are uploading
+    # @param filename [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :folder_id pass an optional folder id to save file to specific folder
-    # @option opts [String] :body 
-    # @option opts [String] :name exact name of the file you are uploading
-    # @option opts [String] :filename 
     # @option opts [String] :mime_type 
     # @return [Array<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers
-    def upload_file_with_http_info(xero_tenant_id, opts = {})
+    def upload_file_with_http_info(xero_tenant_id, body, name, filename, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FilesApi.upload_file ...'
       end
@@ -1213,6 +1205,18 @@ module XeroRuby
       if @api_client.config.client_side_validation && xero_tenant_id.nil?
         fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FilesApi.upload_file"
       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 FilesApi.upload_file"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling FilesApi.upload_file"
+      end
+      # verify the required parameter 'filename' is set
+      if @api_client.config.client_side_validation && filename.nil?
+        fail ArgumentError, "Missing the required parameter 'filename' when calling FilesApi.upload_file"
+      end
       # resource path
       local_var_path = '/Files'
 
@@ -1221,7 +1225,6 @@ module XeroRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
       
       # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
       query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -1237,9 +1240,9 @@ module XeroRuby
 
       # form parameters
       form_params = opts[:form_params] || {}
-      form_params['body'] = opts[:'body'] if !opts[:'body'].nil?
-      form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
-      form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
+      form_params['body'] = body
+      form_params['name'] = name
+      form_params['filename'] = filename
       form_params['mimeType'] = opts[:'mime_type'] if !opts[:'mime_type'].nil?
 
       # http body (model)
@@ -1266,5 +1269,105 @@ module XeroRuby
       end
       return data, status_code, headers
     end
+
+    # Uploads a File to a specific folder
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param folder_id [String] pass required folder id to save file to specific folder
+    # @param body [String] 
+    # @param name [String] exact name of the file you are uploading
+    # @param filename [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :mime_type 
+    # @return [FileObject]
+    def upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, opts = {})
+      data, _status_code, _headers = upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, opts)
+      data
+    end
+
+    # Uploads a File to a specific folder
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param folder_id [String] pass required folder id to save file to specific folder
+    # @param body [String] 
+    # @param name [String] exact name of the file you are uploading
+    # @param filename [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :mime_type 
+    # @return [Array<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers
+    def upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.upload_file_to_folder ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FilesApi.upload_file_to_folder"
+      end
+      # verify the required parameter 'folder_id' is set
+      if @api_client.config.client_side_validation && folder_id.nil?
+        fail ArgumentError, "Missing the required parameter 'folder_id' when calling FilesApi.upload_file_to_folder"
+      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 FilesApi.upload_file_to_folder"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling FilesApi.upload_file_to_folder"
+      end
+      # verify the required parameter 'filename' is set
+      if @api_client.config.client_side_validation && filename.nil?
+        fail ArgumentError, "Missing the required parameter 'filename' when calling FilesApi.upload_file_to_folder"
+      end
+      # resource path
+      local_var_path = '/Files/{FolderId}'.sub('{' + 'FolderId' + '}', folder_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['body'] = body
+      form_params['name'] = name
+      form_params['filename'] = filename
+      form_params['mimeType'] = opts[:'mime_type'] if !opts[:'mime_type'].nil?
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'FileObject' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :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, "FilesApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#upload_file_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end