Class: MergeATSClient::OffersApi
- Inherits:
-
Object
- Object
- MergeATSClient::OffersApi
- Defined in:
- lib/merge_ats_client/api/offers_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ OffersApi
constructor
A new instance of OffersApi.
-
#offers_list(x_account_token, opts = {}) ⇒ PaginatedOfferList
Returns a list of ‘Offer` objects.
-
#offers_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedOfferList, Integer, Hash)>
Returns a list of `Offer` objects.
-
#offers_retrieve(x_account_token, id, opts = {}) ⇒ Offer
Returns an ‘Offer` object with the given `id`.
-
#offers_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Offer, Integer, Hash)>
Returns an `Offer` object with the given `id`.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_ats_client/api/offers_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#offers_list(x_account_token, opts = {}) ⇒ PaginatedOfferList
Returns a list of ‘Offer` objects.
39 40 41 42 |
# File 'lib/merge_ats_client/api/offers_api.rb', line 39 def offers_list(x_account_token, opts = {}) data, _status_code, _headers = offers_list_with_http_info(x_account_token, opts) data end |
#offers_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedOfferList, Integer, Hash)>
Returns a list of `Offer` objects.
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 90 91 92 93 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 |
# File 'lib/merge_ats_client/api/offers_api.rb', line 61 def offers_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OffersApi.offers_list ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OffersApi.offers_list" end allowable_values = ["application", "application,creator", "creator"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end allowable_values = ["status"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end # resource path local_var_path = '/offers' # query parameters query_params = opts[:query_params] || {} query_params[:'application_id'] = opts[:'application_id'] if !opts[:'application_id'].nil? query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'creator_id'] = opts[:'creator_id'] if !opts[:'creator_id'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil? query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedOfferList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"OffersApi.offers_list", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: OffersApi#offers_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#offers_retrieve(x_account_token, id, opts = {}) ⇒ Offer
Returns an ‘Offer` object with the given `id`.
139 140 141 142 |
# File 'lib/merge_ats_client/api/offers_api.rb', line 139 def offers_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = offers_retrieve_with_http_info(x_account_token, id, opts) data end |
#offers_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Offer, Integer, Hash)>
Returns an `Offer` object with the given `id`.
152 153 154 155 156 157 158 159 160 161 162 163 164 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 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/merge_ats_client/api/offers_api.rb', line 152 def offers_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OffersApi.offers_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling OffersApi.offers_retrieve" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling OffersApi.offers_retrieve" end allowable_values = ["application", "application,creator", "creator"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end allowable_values = ["status"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end # resource path local_var_path = '/offers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Offer' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"OffersApi.offers_retrieve", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: OffersApi#offers_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |