Class: PinterestSdkClient::IntegrationsApi
- Inherits:
-
Object
- Object
- PinterestSdkClient::IntegrationsApi
- Defined in:
- lib/pinterest_sdk/api/integrations_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) ⇒ IntegrationsApi
constructor
A new instance of IntegrationsApi.
-
#integrations_commerce_del(external_business_id, opts = {}) ⇒ nil
Delete commerce integration Delete commerce integration metadata for the given external business ID.
-
#integrations_commerce_del_with_http_info(external_business_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete commerce integration Delete commerce integration metadata for the given external business ID.
-
#integrations_commerce_get(external_business_id, opts = {}) ⇒ IntegrationMetadata
Get commerce integration Get commerce integration metadata associated with the given external business ID.
-
#integrations_commerce_get_with_http_info(external_business_id, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Get commerce integration Get commerce integration metadata associated with the given external business ID.
-
#integrations_commerce_patch(external_business_id, integration_request_patch, opts = {}) ⇒ IntegrationMetadata
Update commerce integration Update commerce integration metadata for the given external business ID.
-
#integrations_commerce_patch_with_http_info(external_business_id, integration_request_patch, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Update commerce integration Update commerce integration metadata for the given external business ID.
-
#integrations_commerce_post(integration_request, opts = {}) ⇒ IntegrationMetadata
Create commerce integration Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account.
-
#integrations_commerce_post_with_http_info(integration_request, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Create commerce integration Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account.
-
#integrations_get_by_id(id, opts = {}) ⇒ IntegrationRecord
Get integration metadata Get integration metadata by ID.
-
#integrations_get_by_id_with_http_info(id, opts = {}) ⇒ Array<(IntegrationRecord, Integer, Hash)>
Get integration metadata Get integration metadata by ID.
-
#integrations_get_list(opts = {}) ⇒ IntegrationsGetList200Response
Get integration metadata list Get integration metadata list.
-
#integrations_get_list_with_http_info(opts = {}) ⇒ Array<(IntegrationsGetList200Response, Integer, Hash)>
Get integration metadata list Get integration metadata list.
-
#integrations_logs_post(integration_logs_request, opts = {}) ⇒ IntegrationLogsSuccessResponse
Receives batched logs from integration applications.
-
#integrations_logs_post_with_http_info(integration_logs_request, opts = {}) ⇒ Array<(IntegrationLogsSuccessResponse, Integer, Hash)>
Receives batched logs from integration applications.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi
Returns a new instance of IntegrationsApi.
19 20 21 |
# File 'lib/pinterest_sdk/api/integrations_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/pinterest_sdk/api/integrations_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#integrations_commerce_del(external_business_id, opts = {}) ⇒ nil
Delete commerce integration Delete commerce integration metadata for the given external business ID. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
27 28 29 30 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 27 def integrations_commerce_del(external_business_id, opts = {}) integrations_commerce_del_with_http_info(external_business_id, opts) nil end |
#integrations_commerce_del_with_http_info(external_business_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete commerce integration Delete commerce integration metadata for the given external business ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
37 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 76 77 78 79 80 81 82 83 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 37 def integrations_commerce_del_with_http_info(external_business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_commerce_del ...' end # verify the required parameter 'external_business_id' is set if @api_client.config.client_side_validation && external_business_id.nil? fail ArgumentError, "Missing the required parameter 'external_business_id' when calling IntegrationsApi.integrations_commerce_del" end # resource path local_var_path = '/integrations/commerce/{external_business_id}'.sub('{' + 'external_business_id' + '}', CGI.escape(external_business_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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_commerce_del", :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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: IntegrationsApi#integrations_commerce_del\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_commerce_get(external_business_id, opts = {}) ⇒ IntegrationMetadata
Get commerce integration Get commerce integration metadata associated with the given external business ID. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
90 91 92 93 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 90 def integrations_commerce_get(external_business_id, opts = {}) data, _status_code, _headers = integrations_commerce_get_with_http_info(external_business_id, opts) data end |
#integrations_commerce_get_with_http_info(external_business_id, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Get commerce integration Get commerce integration metadata associated with the given external business ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
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 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 100 def integrations_commerce_get_with_http_info(external_business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_commerce_get ...' end # verify the required parameter 'external_business_id' is set if @api_client.config.client_side_validation && external_business_id.nil? fail ArgumentError, "Missing the required parameter 'external_business_id' when calling IntegrationsApi.integrations_commerce_get" end # resource path local_var_path = '/integrations/commerce/{external_business_id}'.sub('{' + 'external_business_id' + '}', CGI.escape(external_business_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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'IntegrationMetadata' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_commerce_get", :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: IntegrationsApi#integrations_commerce_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_commerce_patch(external_business_id, integration_request_patch, opts = {}) ⇒ IntegrationMetadata
Update commerce integration Update commerce integration metadata for the given external business ID. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
154 155 156 157 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 154 def integrations_commerce_patch(external_business_id, integration_request_patch, opts = {}) data, _status_code, _headers = integrations_commerce_patch_with_http_info(external_business_id, integration_request_patch, opts) data end |
#integrations_commerce_patch_with_http_info(external_business_id, integration_request_patch, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Update commerce integration Update commerce integration metadata for the given external business ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
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 215 216 217 218 219 220 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 165 def integrations_commerce_patch_with_http_info(external_business_id, integration_request_patch, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_commerce_patch ...' end # verify the required parameter 'external_business_id' is set if @api_client.config.client_side_validation && external_business_id.nil? fail ArgumentError, "Missing the required parameter 'external_business_id' when calling IntegrationsApi.integrations_commerce_patch" end # verify the required parameter 'integration_request_patch' is set if @api_client.config.client_side_validation && integration_request_patch.nil? fail ArgumentError, "Missing the required parameter 'integration_request_patch' when calling IntegrationsApi.integrations_commerce_patch" end # resource path local_var_path = '/integrations/commerce/{external_business_id}'.sub('{' + 'external_business_id' + '}', CGI.escape(external_business_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']) unless header_params['Accept'] # 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(integration_request_patch) # return_type return_type = opts[:debug_return_type] || 'IntegrationMetadata' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_commerce_patch", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: IntegrationsApi#integrations_commerce_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_commerce_post(integration_request, opts = {}) ⇒ IntegrationMetadata
Create commerce integration Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
227 228 229 230 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 227 def integrations_commerce_post(integration_request, opts = {}) data, _status_code, _headers = integrations_commerce_post_with_http_info(integration_request, opts) data end |
#integrations_commerce_post_with_http_info(integration_request, opts = {}) ⇒ Array<(IntegrationMetadata, Integer, Hash)>
Create commerce integration Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 237 def integrations_commerce_post_with_http_info(integration_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_commerce_post ...' end # verify the required parameter 'integration_request' is set if @api_client.config.client_side_validation && integration_request.nil? fail ArgumentError, "Missing the required parameter 'integration_request' when calling IntegrationsApi.integrations_commerce_post" end # resource path local_var_path = '/integrations/commerce' # 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']) unless header_params['Accept'] # 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(integration_request) # return_type return_type = opts[:debug_return_type] || 'IntegrationMetadata' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_commerce_post", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: IntegrationsApi#integrations_commerce_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_get_by_id(id, opts = {}) ⇒ IntegrationRecord
Get integration metadata Get integration metadata by ID. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
295 296 297 298 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 295 def integrations_get_by_id(id, opts = {}) data, _status_code, _headers = integrations_get_by_id_with_http_info(id, opts) data end |
#integrations_get_by_id_with_http_info(id, opts = {}) ⇒ Array<(IntegrationRecord, Integer, Hash)>
Get integration metadata Get integration metadata by ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 305 def integrations_get_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_get_by_id ...' 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 IntegrationsApi.integrations_get_by_id" end # resource path local_var_path = '/integrations/{id}'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'IntegrationRecord' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_get_by_id", :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: IntegrationsApi#integrations_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_get_list(opts = {}) ⇒ IntegrationsGetList200Response
Get integration metadata list Get integration metadata list. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
359 360 361 362 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 359 def integrations_get_list(opts = {}) data, _status_code, _headers = integrations_get_list_with_http_info(opts) data end |
#integrations_get_list_with_http_info(opts = {}) ⇒ Array<(IntegrationsGetList200Response, Integer, Hash)>
Get integration metadata list Get integration metadata list. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 370 def integrations_get_list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_get_list ...' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationsApi.integrations_get_list, must be smaller than or equal to 250.' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationsApi.integrations_get_list, must be greater than or equal to 1.' end # resource path local_var_path = '/integrations' # query parameters query_params = opts[:query_params] || {} query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'IntegrationsGetList200Response' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_get_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: IntegrationsApi#integrations_get_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#integrations_logs_post(integration_logs_request, opts = {}) ⇒ IntegrationLogsSuccessResponse
Receives batched logs from integration applications. This endpoint receives batched logs from integration applications on partner platforms. Note: If you’re interested in joining the beta, please reach out to your Pinterest account manager.
429 430 431 432 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 429 def integrations_logs_post(integration_logs_request, opts = {}) data, _status_code, _headers = integrations_logs_post_with_http_info(integration_logs_request, opts) data end |
#integrations_logs_post_with_http_info(integration_logs_request, opts = {}) ⇒ Array<(IntegrationLogsSuccessResponse, Integer, Hash)>
Receives batched logs from integration applications. This endpoint receives batched logs from integration applications on partner platforms. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 |
# File 'lib/pinterest_sdk/api/integrations_api.rb', line 439 def integrations_logs_post_with_http_info(integration_logs_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrations_logs_post ...' end # verify the required parameter 'integration_logs_request' is set if @api_client.config.client_side_validation && integration_logs_request.nil? fail ArgumentError, "Missing the required parameter 'integration_logs_request' when calling IntegrationsApi.integrations_logs_post" end # resource path local_var_path = '/integrations/logs' # 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']) unless header_params['Accept'] # 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(integration_logs_request) # return_type return_type = opts[:debug_return_type] || 'IntegrationLogsSuccessResponse' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"IntegrationsApi.integrations_logs_post", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: IntegrationsApi#integrations_logs_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |