Class: VericredClient::EmbargoesApi
- Inherits:
-
Object
- Object
- VericredClient::EmbargoesApi
- Defined in:
- lib/vericred_client/api/embargoes_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_embargo(vericred_id, opts = {}) ⇒ nil
Delete an Embargo.
-
#delete_embargo_with_http_info(vericred_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Embargo.
-
#initialize(api_client = ApiClient.default) ⇒ EmbargoesApi
constructor
A new instance of EmbargoesApi.
-
#put_embargo(vericred_id, body, opts = {}) ⇒ nil
Create/update an Embargo Add or update an Embargo to the database.
-
#put_embargo_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Create/update an Embargo Add or update an Embargo to the database.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ EmbargoesApi
Returns a new instance of EmbargoesApi.
19 20 21 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_embargo(vericred_id, opts = {}) ⇒ nil
Delete an Embargo. Delete an Embargo from the database.
28 29 30 31 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 28 def (vericred_id, opts = {}) (vericred_id, opts) return nil end |
#delete_embargo_with_http_info(vericred_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Embargo. Delete an Embargo from the database.
38 39 40 41 42 43 44 45 46 47 48 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 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 38 def (vericred_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmbargoesApi.delete_embargo ..." end # verify the required parameter 'vericred_id' is set if @api_client.config.client_side_validation && vericred_id.nil? fail ArgumentError, "Missing the required parameter 'vericred_id' when calling EmbargoesApi.delete_embargo" end # resource path local_var_path = "/embargoes/{vericred_id}".sub('{' + 'vericred_id' + '}', vericred_id.to_s) # query parameters query_params = {} # header parameters 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(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: EmbargoesApi#delete_embargo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_embargo(vericred_id, body, opts = {}) ⇒ nil
Create/update an Embargo Add or update an Embargo to the database.
83 84 85 86 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 83 def (vericred_id, body, opts = {}) (vericred_id, body, opts) return nil end |
#put_embargo_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Create/update an Embargo Add or update an Embargo to the database.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 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 |
# File 'lib/vericred_client/api/embargoes_api.rb', line 94 def (vericred_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmbargoesApi.put_embargo ..." end # verify the required parameter 'vericred_id' is set if @api_client.config.client_side_validation && vericred_id.nil? fail ArgumentError, "Missing the required parameter 'vericred_id' when calling EmbargoesApi.put_embargo" 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 EmbargoesApi.put_embargo" end # resource path local_var_path = "/embargoes/{vericred_id}".sub('{' + 'vericred_id' + '}', vericred_id.to_s) # query parameters query_params = {} # header parameters 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(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: EmbargoesApi#put_embargo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |