Class: OrderCloud::FileApi
- Inherits:
-
Object
- Object
- OrderCloud::FileApi
- Defined in:
- lib/order_cloud/api/file_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
- #get(file_id, opts = {}) ⇒ File
-
#get_with_http_info(file_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>
File data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ FileApi
constructor
A new instance of FileApi.
- #list(opts = {}) ⇒ ListFile
-
#list_with_http_info(opts = {}) ⇒ Array<(ListFile, Fixnum, Hash)>
ListFile data, response status code and response headers.
- #post_file_data(opts = {}) ⇒ File
-
#post_file_data_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>
File data, response status code and response headers.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
28 29 30 |
# File 'lib/order_cloud/api/file_api.rb', line 28 def api_client @api_client end |
Instance Method Details
#get(file_id, opts = {}) ⇒ File
39 40 41 42 |
# File 'lib/order_cloud/api/file_api.rb', line 39 def get(file_id, opts = {}) data, _status_code, _headers = get_with_http_info(file_id, opts) return data end |
#get_with_http_info(file_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>
Returns File data, response status code and response headers.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/order_cloud/api/file_api.rb', line 49 def get_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FileApi.get ..." end # verify the required parameter 'file_id' is set fail ArgumentError, "Missing the required parameter 'file_id' when calling FileApi.get" if file_id.nil? # resource path local_var_path = "/files/{fileID}".sub('{format}','json').sub('{' + 'fileID' + '}', file_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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 => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: FileApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ ListFile
97 98 99 100 |
# File 'lib/order_cloud/api/file_api.rb', line 97 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) return data end |
#list_with_http_info(opts = {}) ⇒ Array<(ListFile, Fixnum, Hash)>
Returns ListFile data, response status code and response headers.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/order_cloud/api/file_api.rb', line 108 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FileApi.list ..." end # resource path local_var_path = "/files".sub('{format}','json') # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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 => 'ListFile') if @api_client.config.debugging @api_client.config.logger.debug "API called: FileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_file_data(opts = {}) ⇒ File
155 156 157 158 |
# File 'lib/order_cloud/api/file_api.rb', line 155 def post_file_data(opts = {}) data, _status_code, _headers = post_file_data_with_http_info(opts) return data end |
#post_file_data_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>
Returns File data, response status code and response headers.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/order_cloud/api/file_api.rb', line 165 def post_file_data_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FileApi.post_file_data ..." end # resource path local_var_path = "/files".sub('{format}','json') # query parameters query_params = {} query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: FileApi#post_file_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |