lib/fastly/api/acl_entry_api.rb in fastly-5.3.1 vs lib/fastly/api/acl_entry_api.rb in fastly-6.0.0

- old
+ new

@@ -92,10 +92,87 @@ @api_client.config.logger.debug "API called: AclEntryApi#bulk_update_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end + # Create an ACL entry + # Add an ACL entry to an ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [AclEntry] :acl_entry + # @return [AclEntryResponse] + def create_acl_entry(opts = {}) + data, _status_code, _headers = create_acl_entry_with_http_info(opts) + data + end + + # Create an ACL entry + # Add an ACL entry to an ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [AclEntry] :acl_entry + # @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers + def create_acl_entry_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AclEntryApi.create_acl_entry ...' + end + # unbox the parameters from the hash + service_id = opts[:'service_id'] + acl_id = opts[:'acl_id'] + # verify the required parameter 'service_id' is set + if @api_client.config.client_side_validation && service_id.nil? + fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.create_acl_entry" + end + # verify the required parameter 'acl_id' is set + if @api_client.config.client_side_validation && acl_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.create_acl_entry" + end + # resource path + local_var_path = '/service/{service_id}/acl/{acl_id}/entry'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)) + + # 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']) + # 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(opts[:'acl_entry']) + + # return_type + return_type = opts[:debug_return_type] || 'AclEntryResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['token'] + + new_options = opts.merge( + :operation => :"AclEntryApi.create_acl_entry", + :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: AclEntryApi#create_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Delete an ACL entry # Delete an ACL entry from a specified ACL. # @option opts [String] :service_id Alphanumeric string identifying the service. (required) # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) # @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required) @@ -165,9 +242,264 @@ ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: AclEntryApi#delete_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Describe an ACL entry + # Retrieve a single ACL entry. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required) + # @return [AclEntryResponse] + def get_acl_entry(opts = {}) + data, _status_code, _headers = get_acl_entry_with_http_info(opts) + data + end + + # Describe an ACL entry + # Retrieve a single ACL entry. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required) + # @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers + def get_acl_entry_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AclEntryApi.get_acl_entry ...' + end + # unbox the parameters from the hash + service_id = opts[:'service_id'] + acl_id = opts[:'acl_id'] + acl_entry_id = opts[:'acl_entry_id'] + # verify the required parameter 'service_id' is set + if @api_client.config.client_side_validation && service_id.nil? + fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.get_acl_entry" + end + # verify the required parameter 'acl_id' is set + if @api_client.config.client_side_validation && acl_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.get_acl_entry" + end + # verify the required parameter 'acl_entry_id' is set + if @api_client.config.client_side_validation && acl_entry_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.get_acl_entry" + end + # resource path + local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_id.to_s)) + + # 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']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'AclEntryResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['token'] + + new_options = opts.merge( + :operation => :"AclEntryApi.get_acl_entry", + :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: AclEntryApi#get_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List ACL entries + # List ACL entries for a specified ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [Integer] :page Current page. + # @option opts [Integer] :per_page Number of records per page. (default to 20) + # @option opts [String] :sort Field on which to sort. (default to 'created') + # @option opts [String] :direction Direction in which to sort results. (default to 'ascend') + # @return [Array<AclEntryResponse>] + def list_acl_entries(opts = {}) + data, _status_code, _headers = list_acl_entries_with_http_info(opts) + data + end + + # List ACL entries + # List ACL entries for a specified ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [Integer] :page Current page. + # @option opts [Integer] :per_page Number of records per page. (default to 20) + # @option opts [String] :sort Field on which to sort. (default to 'created') + # @option opts [String] :direction Direction in which to sort results. (default to 'ascend') + # @return [Array<(Array<AclEntryResponse>, Integer, Hash)>] Array<AclEntryResponse> data, response status code and response headers + def list_acl_entries_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AclEntryApi.list_acl_entries ...' + end + # unbox the parameters from the hash + service_id = opts[:'service_id'] + acl_id = opts[:'acl_id'] + # verify the required parameter 'service_id' is set + if @api_client.config.client_side_validation && service_id.nil? + fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.list_acl_entries" + end + # verify the required parameter 'acl_id' is set + if @api_client.config.client_side_validation && acl_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.list_acl_entries" + end + if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 + fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be smaller than or equal to 100.' + end + + if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 + fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be greater than or equal to 1.' + end + + allowable_values = ["ascend", "descend"] + if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction']) + fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/service/{service_id}/acl/{acl_id}/entries'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? + query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? + query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? + query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].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[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'Array<AclEntryResponse>' + + # auth_names + auth_names = opts[:debug_auth_names] || ['token'] + + new_options = opts.merge( + :operation => :"AclEntryApi.list_acl_entries", + :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: AclEntryApi#list_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update an ACL entry + # Update an ACL entry for a specified ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required) + # @option opts [AclEntry] :acl_entry + # @return [AclEntryResponse] + def update_acl_entry(opts = {}) + data, _status_code, _headers = update_acl_entry_with_http_info(opts) + data + end + + # Update an ACL entry + # Update an ACL entry for a specified ACL. + # @option opts [String] :service_id Alphanumeric string identifying the service. (required) + # @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required) + # @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required) + # @option opts [AclEntry] :acl_entry + # @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers + def update_acl_entry_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AclEntryApi.update_acl_entry ...' + end + # unbox the parameters from the hash + service_id = opts[:'service_id'] + acl_id = opts[:'acl_id'] + acl_entry_id = opts[:'acl_entry_id'] + # verify the required parameter 'service_id' is set + if @api_client.config.client_side_validation && service_id.nil? + fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.update_acl_entry" + end + # verify the required parameter 'acl_id' is set + if @api_client.config.client_side_validation && acl_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.update_acl_entry" + end + # verify the required parameter 'acl_entry_id' is set + if @api_client.config.client_side_validation && acl_entry_id.nil? + fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.update_acl_entry" + end + # resource path + local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_id.to_s)) + + # 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']) + # 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(opts[:'acl_entry']) + + # return_type + return_type = opts[:debug_return_type] || 'AclEntryResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['token'] + + new_options = opts.merge( + :operation => :"AclEntryApi.update_acl_entry", + :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: AclEntryApi#update_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end