ultracart_api 3.1.46 → 3.2.6

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,20 @@
1
+ # UltracartClient::IntegrationLogQueryRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | | [optional]
7
+ **direction** | **String** | | [optional]
8
+ **email** | **String** | | [optional]
9
+ **file_names** | **Array<String>** | | [optional]
10
+ **item_id** | **String** | | [optional]
11
+ **item_ipn_oid** | **Integer** | | [optional]
12
+ **log_dts_begin** | **String** | Log date/time begin | [optional]
13
+ **log_dts_end** | **String** | Log date/time end | [optional]
14
+ **log_type** | **String** | | [optional]
15
+ **logger_id** | **String** | | [optional]
16
+ **logger_name** | **String** | | [optional]
17
+ **order_ids** | **Array<String>** | | [optional]
18
+ **status** | **String** | | [optional]
19
+
20
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::IntegrationLogQueryResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **filter_values** | [**IntegrationLogQueryFilterValues**](IntegrationLogQueryFilterValues.md) | | [optional]
8
+ **integration_logs** | [**Array<IntegrationLog>**](IntegrationLog.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::IntegrationLogResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **integration_log** | [**IntegrationLog**](IntegrationLog.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -3,17 +3,29 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **large_click_thumbnail_url** | **String** | | [optional]
6
7
  **large_click_url** | **String** | | [optional]
8
+ **large_movement_thumbnail_url** | **String** | | [optional]
7
9
  **large_movement_url** | **String** | | [optional]
10
+ **large_regular_thumbnail_url** | **String** | | [optional]
8
11
  **large_regular_url** | **String** | | [optional]
12
+ **large_scroll_thumbnail_url** | **String** | | [optional]
9
13
  **large_scroll_url** | **String** | | [optional]
14
+ **medium_click_thumbnail_url** | **String** | | [optional]
10
15
  **medium_click_url** | **String** | | [optional]
16
+ **medium_movement_thumbnail_url** | **String** | | [optional]
11
17
  **medium_movement_url** | **String** | | [optional]
18
+ **medium_regular_thumbnail_url** | **String** | | [optional]
12
19
  **medium_regular_url** | **String** | | [optional]
20
+ **medium_scroll_thumbnail_url** | **String** | | [optional]
13
21
  **medium_scroll_url** | **String** | | [optional]
22
+ **small_click_thumbnail_url** | **String** | | [optional]
14
23
  **small_click_url** | **String** | | [optional]
24
+ **small_movement_thumbnail_url** | **String** | | [optional]
15
25
  **small_movement_url** | **String** | | [optional]
26
+ **small_regular_thumbnail_url** | **String** | | [optional]
16
27
  **small_regular_url** | **String** | | [optional]
28
+ **small_scroll_thumbnail_url** | **String** | | [optional]
17
29
  **small_scroll_url** | **String** | | [optional]
18
30
 
19
31
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **range** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) | | [optional]
7
+ **screen_sizes** | **Array<String>** | | [optional]
7
8
  **url** | **String** | | [optional]
8
9
 
9
10
 
@@ -88,7 +88,6 @@ Method | HTTP request | Description
88
88
  [**get_library_filter_values**](StorefrontApi.md#get_library_filter_values) | **GET** /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering.
89
89
  [**get_library_item**](StorefrontApi.md#get_library_item) | **GET** /storefront/code_library/{library_item_oid} | Get library item.
90
90
  [**get_library_item_published_versions**](StorefrontApi.md#get_library_item_published_versions) | **GET** /storefront/code_library/{library_item_oid}/published_versions | Get all published versions for a library item.
91
- [**get_pricing_tiers**](StorefrontApi.md#get_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
92
91
  [**get_screen_recording**](StorefrontApi.md#get_screen_recording) | **GET** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid} | Get screen recording
93
92
  [**get_screen_recording_page_view_data**](StorefrontApi.md#get_screen_recording_page_view_data) | **GET** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid} | Get screen recording page view data
94
93
  [**get_screen_recording_segment**](StorefrontApi.md#get_screen_recording_segment) | **GET** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Get screen recording segment
@@ -97,6 +96,7 @@ Method | HTTP request | Description
97
96
  [**get_screen_recording_tags**](StorefrontApi.md#get_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/tags | Get tags used by screen recording
98
97
  [**get_screen_recordings_by_query**](StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings
99
98
  [**get_screen_recordings_by_segment**](StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment
99
+ [**get_store_front_pricing_tiers**](StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
100
100
  [**get_thumbnail_parameters**](StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
101
101
  [**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
102
102
  [**get_transaction_email_list**](StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
@@ -4430,57 +4430,6 @@ Name | Type | Description | Notes
4430
4430
 
4431
4431
 
4432
4432
 
4433
- # **get_pricing_tiers**
4434
- > PricingTiersResponse get_pricing_tiers(opts)
4435
-
4436
- Retrieve pricing tiers
4437
-
4438
- Retrieves the pricing tiers
4439
-
4440
- ### Example
4441
- ```ruby
4442
- # load the gem
4443
- require 'ultracart_api'
4444
-
4445
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4446
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4447
- api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
4448
-
4449
-
4450
- opts = {
4451
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
4452
- }
4453
-
4454
- begin
4455
- #Retrieve pricing tiers
4456
- result = api_instance.get_pricing_tiers(opts)
4457
- p result
4458
- rescue UltracartClient::ApiError => e
4459
- puts "Exception when calling StorefrontApi->get_pricing_tiers: #{e}"
4460
- end
4461
- ```
4462
-
4463
- ### Parameters
4464
-
4465
- Name | Type | Description | Notes
4466
- ------------- | ------------- | ------------- | -------------
4467
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
4468
-
4469
- ### Return type
4470
-
4471
- [**PricingTiersResponse**](PricingTiersResponse.md)
4472
-
4473
- ### Authorization
4474
-
4475
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4476
-
4477
- ### HTTP request headers
4478
-
4479
- - **Content-Type**: application/json
4480
- - **Accept**: application/json
4481
-
4482
-
4483
-
4484
4433
  # **get_screen_recording**
4485
4434
  > ScreenRecordingResponse get_screen_recording(storefront_oid, screen_recording_uuid)
4486
4435
 
@@ -4909,6 +4858,57 @@ Name | Type | Description | Notes
4909
4858
 
4910
4859
 
4911
4860
 
4861
+ # **get_store_front_pricing_tiers**
4862
+ > PricingTiersResponse get_store_front_pricing_tiers(opts)
4863
+
4864
+ Retrieve pricing tiers
4865
+
4866
+ Retrieves the pricing tiers
4867
+
4868
+ ### Example
4869
+ ```ruby
4870
+ # load the gem
4871
+ require 'ultracart_api'
4872
+
4873
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4874
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4875
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
4876
+
4877
+
4878
+ opts = {
4879
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
4880
+ }
4881
+
4882
+ begin
4883
+ #Retrieve pricing tiers
4884
+ result = api_instance.get_store_front_pricing_tiers(opts)
4885
+ p result
4886
+ rescue UltracartClient::ApiError => e
4887
+ puts "Exception when calling StorefrontApi->get_store_front_pricing_tiers: #{e}"
4888
+ end
4889
+ ```
4890
+
4891
+ ### Parameters
4892
+
4893
+ Name | Type | Description | Notes
4894
+ ------------- | ------------- | ------------- | -------------
4895
+ **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
4896
+
4897
+ ### Return type
4898
+
4899
+ [**PricingTiersResponse**](PricingTiersResponse.md)
4900
+
4901
+ ### Authorization
4902
+
4903
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4904
+
4905
+ ### HTTP request headers
4906
+
4907
+ - **Content-Type**: application/json
4908
+ - **Accept**: application/json
4909
+
4910
+
4911
+
4912
4912
  # **get_thumbnail_parameters**
4913
4913
  > ThumbnailParametersResponse get_thumbnail_parameters(thumbnail_parameters)
4914
4914
 
data/lib/ultracart_api.rb CHANGED
@@ -325,6 +325,13 @@ require 'ultracart_api/models/group_response'
325
325
  require 'ultracart_api/models/group_user_membership'
326
326
  require 'ultracart_api/models/groups_response'
327
327
  require 'ultracart_api/models/http_header'
328
+ require 'ultracart_api/models/integration_log'
329
+ require 'ultracart_api/models/integration_log_file'
330
+ require 'ultracart_api/models/integration_log_log'
331
+ require 'ultracart_api/models/integration_log_query_filter_values'
332
+ require 'ultracart_api/models/integration_log_query_request'
333
+ require 'ultracart_api/models/integration_log_query_response'
334
+ require 'ultracart_api/models/integration_log_response'
328
335
  require 'ultracart_api/models/item'
329
336
  require 'ultracart_api/models/item_accounting'
330
337
  require 'ultracart_api/models/item_amember'
@@ -600,6 +607,7 @@ require 'ultracart_api/api/checkout_api'
600
607
  require 'ultracart_api/api/coupon_api'
601
608
  require 'ultracart_api/api/customer_api'
602
609
  require 'ultracart_api/api/fulfillment_api'
610
+ require 'ultracart_api/api/integration_log_api'
603
611
  require 'ultracart_api/api/item_api'
604
612
  require 'ultracart_api/api/oauth_api'
605
613
  require 'ultracart_api/api/order_api'
@@ -203,6 +203,104 @@ module UltracartClient
203
203
  end
204
204
  return data, status_code, headers
205
205
  end
206
+ # Retrieve values needed for a customer profile editor
207
+ # Retrieve values needed for a customer profile editor.
208
+ # @param [Hash] opts the optional parameters
209
+ # @return [CustomerEditorValues]
210
+ def get_customer_editor_values(opts = {})
211
+ data, _status_code, _headers = get_customer_editor_values_with_http_info(opts)
212
+ data
213
+ end
214
+
215
+ # Retrieve values needed for a customer profile editor
216
+ # Retrieve values needed for a customer profile editor.
217
+ # @param [Hash] opts the optional parameters
218
+ # @return [Array<(CustomerEditorValues, Fixnum, Hash)>] CustomerEditorValues data, response status code and response headers
219
+ def get_customer_editor_values_with_http_info(opts = {})
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_editor_values ...'
222
+ end
223
+ # resource path
224
+ local_var_path = '/customer/editor_values'
225
+
226
+ # query parameters
227
+ query_params = {}
228
+
229
+ # header parameters
230
+ header_params = {}
231
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
232
+ # HTTP header 'Accept' (if needed)
233
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
234
+ # HTTP header 'Content-Type'
235
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
236
+
237
+ # form parameters
238
+ form_params = {}
239
+
240
+ # http body (model)
241
+ post_body = nil
242
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
243
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
244
+ :header_params => header_params,
245
+ :query_params => query_params,
246
+ :form_params => form_params,
247
+ :body => post_body,
248
+ :auth_names => auth_names,
249
+ :return_type => 'CustomerEditorValues')
250
+ if @api_client.config.debugging
251
+ @api_client.config.logger.debug "API called: CustomerApi#get_customer_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
252
+ end
253
+ return data, status_code, headers
254
+ end
255
+ # Retrieve all email lists across all storefronts
256
+ # Retrieve all email lists across all storefronts
257
+ # @param [Hash] opts the optional parameters
258
+ # @return [EmailListsResponse]
259
+ def get_customer_email_lists(opts = {})
260
+ data, _status_code, _headers = get_customer_email_lists_with_http_info(opts)
261
+ data
262
+ end
263
+
264
+ # Retrieve all email lists across all storefronts
265
+ # Retrieve all email lists across all storefronts
266
+ # @param [Hash] opts the optional parameters
267
+ # @return [Array<(EmailListsResponse, Fixnum, Hash)>] EmailListsResponse data, response status code and response headers
268
+ def get_customer_email_lists_with_http_info(opts = {})
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_email_lists ...'
271
+ end
272
+ # resource path
273
+ local_var_path = '/customer/email_lists'
274
+
275
+ # query parameters
276
+ query_params = {}
277
+
278
+ # header parameters
279
+ header_params = {}
280
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
281
+ # HTTP header 'Accept' (if needed)
282
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
283
+ # HTTP header 'Content-Type'
284
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
285
+
286
+ # form parameters
287
+ form_params = {}
288
+
289
+ # http body (model)
290
+ post_body = nil
291
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
292
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
293
+ :header_params => header_params,
294
+ :query_params => query_params,
295
+ :form_params => form_params,
296
+ :body => post_body,
297
+ :auth_names => auth_names,
298
+ :return_type => 'EmailListsResponse')
299
+ if @api_client.config.debugging
300
+ @api_client.config.logger.debug "API called: CustomerApi#get_customer_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
301
+ end
302
+ return data, status_code, headers
303
+ end
206
304
  # Retrieve customers
207
305
  # Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
208
306
  # @param [Hash] opts the optional parameters
@@ -470,104 +568,6 @@ module UltracartClient
470
568
  end
471
569
  return data, status_code, headers
472
570
  end
473
- # Retrieve values needed for a customer profile editor
474
- # Retrieve values needed for a customer profile editor.
475
- # @param [Hash] opts the optional parameters
476
- # @return [CustomerEditorValues]
477
- def get_editor_values(opts = {})
478
- data, _status_code, _headers = get_editor_values_with_http_info(opts)
479
- data
480
- end
481
-
482
- # Retrieve values needed for a customer profile editor
483
- # Retrieve values needed for a customer profile editor.
484
- # @param [Hash] opts the optional parameters
485
- # @return [Array<(CustomerEditorValues, Fixnum, Hash)>] CustomerEditorValues data, response status code and response headers
486
- def get_editor_values_with_http_info(opts = {})
487
- if @api_client.config.debugging
488
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_editor_values ...'
489
- end
490
- # resource path
491
- local_var_path = '/customer/editor_values'
492
-
493
- # query parameters
494
- query_params = {}
495
-
496
- # header parameters
497
- header_params = {}
498
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
499
- # HTTP header 'Accept' (if needed)
500
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
501
- # HTTP header 'Content-Type'
502
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
503
-
504
- # form parameters
505
- form_params = {}
506
-
507
- # http body (model)
508
- post_body = nil
509
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
510
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
511
- :header_params => header_params,
512
- :query_params => query_params,
513
- :form_params => form_params,
514
- :body => post_body,
515
- :auth_names => auth_names,
516
- :return_type => 'CustomerEditorValues')
517
- if @api_client.config.debugging
518
- @api_client.config.logger.debug "API called: CustomerApi#get_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
519
- end
520
- return data, status_code, headers
521
- end
522
- # Retrieve all email lists across all storefronts
523
- # Retrieve all email lists across all storefronts
524
- # @param [Hash] opts the optional parameters
525
- # @return [EmailListsResponse]
526
- def get_email_lists(opts = {})
527
- data, _status_code, _headers = get_email_lists_with_http_info(opts)
528
- data
529
- end
530
-
531
- # Retrieve all email lists across all storefronts
532
- # Retrieve all email lists across all storefronts
533
- # @param [Hash] opts the optional parameters
534
- # @return [Array<(EmailListsResponse, Fixnum, Hash)>] EmailListsResponse data, response status code and response headers
535
- def get_email_lists_with_http_info(opts = {})
536
- if @api_client.config.debugging
537
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_email_lists ...'
538
- end
539
- # resource path
540
- local_var_path = '/customer/email_lists'
541
-
542
- # query parameters
543
- query_params = {}
544
-
545
- # header parameters
546
- header_params = {}
547
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
548
- # HTTP header 'Accept' (if needed)
549
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
550
- # HTTP header 'Content-Type'
551
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
552
-
553
- # form parameters
554
- form_params = {}
555
-
556
- # http body (model)
557
- post_body = nil
558
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
559
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
560
- :header_params => header_params,
561
- :query_params => query_params,
562
- :form_params => form_params,
563
- :body => post_body,
564
- :auth_names => auth_names,
565
- :return_type => 'EmailListsResponse')
566
- if @api_client.config.debugging
567
- @api_client.config.logger.debug "API called: CustomerApi#get_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
568
- end
569
- return data, status_code, headers
570
- end
571
571
  # Create a token that can be used to verify a customer email address
572
572
  # Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
573
573
  # @param token_request Token request