ultracart_api 4.1.178 → 4.1.180
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -2
- data/docs/AutoOrderApi.md +54 -0
- data/docs/OrderApi.md +165 -0
- data/docs/OrderAssignRmaRequest.md +18 -0
- data/docs/OrderAutoOrderUpdateBillingUrlResponse.md +26 -0
- data/docs/SfvbApi.md +111 -0
- data/docs/SfvbBlogPostDetail.md +8 -2
- data/docs/SfvbBlogPostRequest.md +6 -0
- data/docs/SfvbRecording.md +60 -0
- data/docs/SfvbRecordingEvent.md +24 -0
- data/docs/SfvbRecordingEventsResponse.md +24 -0
- data/docs/SfvbRecordingPageView.md +42 -0
- data/docs/SfvbRecordingParameter.md +20 -0
- data/docs/SfvbRecordingResponse.md +18 -0
- data/lib/ultracart_api/api/auto_order_api.rb +64 -0
- data/lib/ultracart_api/api/order_api.rb +209 -0
- data/lib/ultracart_api/api/sfvb_api.rb +146 -0
- data/lib/ultracart_api/models/order_assign_rma_request.rb +235 -0
- data/lib/ultracart_api/models/order_auto_order_update_billing_url_response.rb +257 -0
- data/lib/ultracart_api/models/sfvb_blog_post_detail.rb +33 -3
- data/lib/ultracart_api/models/sfvb_blog_post_request.rb +31 -1
- data/lib/ultracart_api/models/sfvb_recording.rb +431 -0
- data/lib/ultracart_api/models/sfvb_recording_event.rb +252 -0
- data/lib/ultracart_api/models/sfvb_recording_events_response.rb +250 -0
- data/lib/ultracart_api/models/sfvb_recording_page_view.rb +344 -0
- data/lib/ultracart_api/models/sfvb_recording_parameter.rb +230 -0
- data/lib/ultracart_api/models/sfvb_recording_response.rb +219 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingEvent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The event name, such as rage click, script error, checkout error or add to cart. | [optional] |
|
|
8
|
+
| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The event's parameters as name and value pairs. Omitted for input change events, whose values are what the visitor typed. | [optional] |
|
|
9
|
+
| **sub_text** | **String** | A short human readable summary of the event, when the recorder produced one. | [optional] |
|
|
10
|
+
| **timestamp** | **String** | When it happened, ISO-8601 in UTC. Subtract the page view's first_event_timestamp for the offset into the replay. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbRecordingEvent.new(
|
|
18
|
+
name: null,
|
|
19
|
+
params: null,
|
|
20
|
+
sub_text: null,
|
|
21
|
+
timestamp: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingEventsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **events_json** | **String** | The page view's rrweb events as a JSON array in a string, the input an rrweb Replayer takes. Card number and security code fields are masked by the recorder, but other text the visitor typed can appear in it. | [optional] |
|
|
8
|
+
| **rrweb_version** | **String** | The rrweb version that recorded the events. Replay with the same version. | [optional] |
|
|
9
|
+
| **screen_recording_page_view_uuid** | **String** | The page view these events replay. | [optional] |
|
|
10
|
+
| **screen_recording_uuid** | **String** | The recording the page view belongs to. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbRecordingEventsResponse.new(
|
|
18
|
+
events_json: null,
|
|
19
|
+
rrweb_version: null,
|
|
20
|
+
screen_recording_page_view_uuid: null,
|
|
21
|
+
screen_recording_uuid: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingPageView
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **domain** | **String** | The host name of the address. | [optional] |
|
|
8
|
+
| **events** | [**Array<SfvbRecordingEvent>**](SfvbRecordingEvent.md) | Named events on this page view in time order, such as rage clicks and script errors. | [optional] |
|
|
9
|
+
| **first_event_timestamp** | **String** | When recording of this page view began, ISO-8601 in UTC. | [optional] |
|
|
10
|
+
| **last_event_timestamp** | **String** | When recording of this page view ended, ISO-8601 in UTC. | [optional] |
|
|
11
|
+
| **missing_events** | **Boolean** | True when no replay events were stored for this page view. | [optional] |
|
|
12
|
+
| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The query string parameters on the address. | [optional] |
|
|
13
|
+
| **referrer** | **String** | The referring address, when there was one. | [optional] |
|
|
14
|
+
| **screen_recording_page_view_uuid** | **String** | Identifies this page view when fetching its replay events. | [optional] |
|
|
15
|
+
| **time_on_page** | **Integer** | Seconds the visitor spent on the page. | [optional] |
|
|
16
|
+
| **timing_dom_content_loaded** | **Integer** | Milliseconds until DOMContentLoaded fired. | [optional] |
|
|
17
|
+
| **timing_loaded** | **Integer** | Milliseconds until the load event fired. | [optional] |
|
|
18
|
+
| **truncated_events** | **Boolean** | True when the recorder stopped storing events part way through this page view. | [optional] |
|
|
19
|
+
| **url** | **String** | The address the visitor viewed. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'ultracart_api'
|
|
25
|
+
|
|
26
|
+
instance = UltracartClient::SfvbRecordingPageView.new(
|
|
27
|
+
domain: null,
|
|
28
|
+
events: null,
|
|
29
|
+
first_event_timestamp: null,
|
|
30
|
+
last_event_timestamp: null,
|
|
31
|
+
missing_events: null,
|
|
32
|
+
params: null,
|
|
33
|
+
referrer: null,
|
|
34
|
+
screen_recording_page_view_uuid: null,
|
|
35
|
+
time_on_page: null,
|
|
36
|
+
timing_dom_content_loaded: null,
|
|
37
|
+
timing_loaded: null,
|
|
38
|
+
truncated_events: null,
|
|
39
|
+
url: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingParameter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Parameter name. | [optional] |
|
|
8
|
+
| **value** | **String** | Parameter value as text. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRecordingParameter.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **recording** | [**SfvbRecording**](SfvbRecording.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbRecordingResponse.new(
|
|
15
|
+
recording: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -647,6 +647,70 @@ module UltracartClient
|
|
|
647
647
|
return data, status_code, headers
|
|
648
648
|
end
|
|
649
649
|
|
|
650
|
+
# Generate an auto order update billing url
|
|
651
|
+
# Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
652
|
+
# @param auto_order_oid [Integer] The auto order oid to generate the update billing url for.
|
|
653
|
+
# @param [Hash] opts the optional parameters
|
|
654
|
+
# @return [OrderAutoOrderUpdateBillingUrlResponse]
|
|
655
|
+
def get_auto_order_update_billing_url(auto_order_oid, opts = {})
|
|
656
|
+
data, _status_code, _headers = get_auto_order_update_billing_url_with_http_info(auto_order_oid, opts)
|
|
657
|
+
data
|
|
658
|
+
end
|
|
659
|
+
|
|
660
|
+
# Generate an auto order update billing url
|
|
661
|
+
# Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
662
|
+
# @param auto_order_oid [Integer] The auto order oid to generate the update billing url for.
|
|
663
|
+
# @param [Hash] opts the optional parameters
|
|
664
|
+
# @return [Array<(OrderAutoOrderUpdateBillingUrlResponse, Integer, Hash)>] OrderAutoOrderUpdateBillingUrlResponse data, response status code and response headers
|
|
665
|
+
def get_auto_order_update_billing_url_with_http_info(auto_order_oid, opts = {})
|
|
666
|
+
if @api_client.config.debugging
|
|
667
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.get_auto_order_update_billing_url ...'
|
|
668
|
+
end
|
|
669
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
670
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
671
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.get_auto_order_update_billing_url"
|
|
672
|
+
end
|
|
673
|
+
# resource path
|
|
674
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/update_billing_url'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
|
|
675
|
+
|
|
676
|
+
# query parameters
|
|
677
|
+
query_params = opts[:query_params] || {}
|
|
678
|
+
|
|
679
|
+
# header parameters
|
|
680
|
+
header_params = opts[:header_params] || {}
|
|
681
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
682
|
+
# HTTP header 'Accept' (if needed)
|
|
683
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
684
|
+
|
|
685
|
+
# form parameters
|
|
686
|
+
form_params = opts[:form_params] || {}
|
|
687
|
+
|
|
688
|
+
# http body (model)
|
|
689
|
+
post_body = opts[:debug_body]
|
|
690
|
+
|
|
691
|
+
# return_type
|
|
692
|
+
return_type = opts[:debug_return_type] || 'OrderAutoOrderUpdateBillingUrlResponse'
|
|
693
|
+
|
|
694
|
+
# auth_names
|
|
695
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
696
|
+
|
|
697
|
+
new_options = opts.merge(
|
|
698
|
+
:operation => :"AutoOrderApi.get_auto_order_update_billing_url",
|
|
699
|
+
:header_params => header_params,
|
|
700
|
+
:query_params => query_params,
|
|
701
|
+
:form_params => form_params,
|
|
702
|
+
:body => post_body,
|
|
703
|
+
:auth_names => auth_names,
|
|
704
|
+
:return_type => return_type
|
|
705
|
+
)
|
|
706
|
+
|
|
707
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
708
|
+
if @api_client.config.debugging
|
|
709
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#get_auto_order_update_billing_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
710
|
+
end
|
|
711
|
+
return data, status_code, headers
|
|
712
|
+
end
|
|
713
|
+
|
|
650
714
|
# Retrieve auto orders
|
|
651
715
|
# Retrieves auto orders from the account. If no parameters are specified, all auto orders 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.
|
|
652
716
|
# @param [Hash] opts the optional parameters
|
|
@@ -102,6 +102,84 @@ module UltracartClient
|
|
|
102
102
|
return data, status_code, headers
|
|
103
103
|
end
|
|
104
104
|
|
|
105
|
+
# Associates an RMA with an order
|
|
106
|
+
# Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
107
|
+
# @param order_id [String] The order id to associate the RMA with.
|
|
108
|
+
# @param assign_rma_request [OrderAssignRmaRequest] Assign RMA request
|
|
109
|
+
# @param [Hash] opts the optional parameters
|
|
110
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
111
|
+
# @return [OrderResponse]
|
|
112
|
+
def assign_rma(order_id, assign_rma_request, opts = {})
|
|
113
|
+
data, _status_code, _headers = assign_rma_with_http_info(order_id, assign_rma_request, opts)
|
|
114
|
+
data
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Associates an RMA with an order
|
|
118
|
+
# Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
119
|
+
# @param order_id [String] The order id to associate the RMA with.
|
|
120
|
+
# @param assign_rma_request [OrderAssignRmaRequest] Assign RMA request
|
|
121
|
+
# @param [Hash] opts the optional parameters
|
|
122
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
123
|
+
# @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
|
|
124
|
+
def assign_rma_with_http_info(order_id, assign_rma_request, opts = {})
|
|
125
|
+
if @api_client.config.debugging
|
|
126
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.assign_rma ...'
|
|
127
|
+
end
|
|
128
|
+
# verify the required parameter 'order_id' is set
|
|
129
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
|
130
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.assign_rma"
|
|
131
|
+
end
|
|
132
|
+
# verify the required parameter 'assign_rma_request' is set
|
|
133
|
+
if @api_client.config.client_side_validation && assign_rma_request.nil?
|
|
134
|
+
fail ArgumentError, "Missing the required parameter 'assign_rma_request' when calling OrderApi.assign_rma"
|
|
135
|
+
end
|
|
136
|
+
# resource path
|
|
137
|
+
local_var_path = '/order/orders/{order_id}/rma'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
|
|
138
|
+
|
|
139
|
+
# query parameters
|
|
140
|
+
query_params = opts[:query_params] || {}
|
|
141
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
142
|
+
|
|
143
|
+
# header parameters
|
|
144
|
+
header_params = opts[:header_params] || {}
|
|
145
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
146
|
+
# HTTP header 'Accept' (if needed)
|
|
147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
148
|
+
# HTTP header 'Content-Type'
|
|
149
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
150
|
+
if !content_type.nil?
|
|
151
|
+
header_params['Content-Type'] = content_type
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# form parameters
|
|
155
|
+
form_params = opts[:form_params] || {}
|
|
156
|
+
|
|
157
|
+
# http body (model)
|
|
158
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(assign_rma_request)
|
|
159
|
+
|
|
160
|
+
# return_type
|
|
161
|
+
return_type = opts[:debug_return_type] || 'OrderResponse'
|
|
162
|
+
|
|
163
|
+
# auth_names
|
|
164
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
165
|
+
|
|
166
|
+
new_options = opts.merge(
|
|
167
|
+
:operation => :"OrderApi.assign_rma",
|
|
168
|
+
:header_params => header_params,
|
|
169
|
+
:query_params => query_params,
|
|
170
|
+
:form_params => form_params,
|
|
171
|
+
:body => post_body,
|
|
172
|
+
:auth_names => auth_names,
|
|
173
|
+
:return_type => return_type
|
|
174
|
+
)
|
|
175
|
+
|
|
176
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
177
|
+
if @api_client.config.debugging
|
|
178
|
+
@api_client.config.logger.debug "API called: OrderApi#assign_rma\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
179
|
+
end
|
|
180
|
+
return data, status_code, headers
|
|
181
|
+
end
|
|
182
|
+
|
|
105
183
|
# Assigns an order to an affiliate
|
|
106
184
|
# Assigns an order to an affiliate.
|
|
107
185
|
# @param order_id [String] The order id to assign to the affiliate.
|
|
@@ -1810,6 +1888,137 @@ module UltracartClient
|
|
|
1810
1888
|
return data, status_code, headers
|
|
1811
1889
|
end
|
|
1812
1890
|
|
|
1891
|
+
# Retrieve orders by RMA
|
|
1892
|
+
# Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1893
|
+
# @param rma [String] The RMA number to search for.
|
|
1894
|
+
# @param [Hash] opts the optional parameters
|
|
1895
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
1896
|
+
# @return [OrdersResponse]
|
|
1897
|
+
def get_orders_by_rma(rma, opts = {})
|
|
1898
|
+
data, _status_code, _headers = get_orders_by_rma_with_http_info(rma, opts)
|
|
1899
|
+
data
|
|
1900
|
+
end
|
|
1901
|
+
|
|
1902
|
+
# Retrieve orders by RMA
|
|
1903
|
+
# Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1904
|
+
# @param rma [String] The RMA number to search for.
|
|
1905
|
+
# @param [Hash] opts the optional parameters
|
|
1906
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
1907
|
+
# @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
|
|
1908
|
+
def get_orders_by_rma_with_http_info(rma, opts = {})
|
|
1909
|
+
if @api_client.config.debugging
|
|
1910
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_rma ...'
|
|
1911
|
+
end
|
|
1912
|
+
# verify the required parameter 'rma' is set
|
|
1913
|
+
if @api_client.config.client_side_validation && rma.nil?
|
|
1914
|
+
fail ArgumentError, "Missing the required parameter 'rma' when calling OrderApi.get_orders_by_rma"
|
|
1915
|
+
end
|
|
1916
|
+
# resource path
|
|
1917
|
+
local_var_path = '/order/orders/rma/{rma}'.sub('{' + 'rma' + '}', CGI.escape(rma.to_s))
|
|
1918
|
+
|
|
1919
|
+
# query parameters
|
|
1920
|
+
query_params = opts[:query_params] || {}
|
|
1921
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
1922
|
+
|
|
1923
|
+
# header parameters
|
|
1924
|
+
header_params = opts[:header_params] || {}
|
|
1925
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1926
|
+
# HTTP header 'Accept' (if needed)
|
|
1927
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1928
|
+
|
|
1929
|
+
# form parameters
|
|
1930
|
+
form_params = opts[:form_params] || {}
|
|
1931
|
+
|
|
1932
|
+
# http body (model)
|
|
1933
|
+
post_body = opts[:debug_body]
|
|
1934
|
+
|
|
1935
|
+
# return_type
|
|
1936
|
+
return_type = opts[:debug_return_type] || 'OrdersResponse'
|
|
1937
|
+
|
|
1938
|
+
# auth_names
|
|
1939
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1940
|
+
|
|
1941
|
+
new_options = opts.merge(
|
|
1942
|
+
:operation => :"OrderApi.get_orders_by_rma",
|
|
1943
|
+
:header_params => header_params,
|
|
1944
|
+
:query_params => query_params,
|
|
1945
|
+
:form_params => form_params,
|
|
1946
|
+
:body => post_body,
|
|
1947
|
+
:auth_names => auth_names,
|
|
1948
|
+
:return_type => return_type
|
|
1949
|
+
)
|
|
1950
|
+
|
|
1951
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1952
|
+
if @api_client.config.debugging
|
|
1953
|
+
@api_client.config.logger.debug "API called: OrderApi#get_orders_by_rma\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1954
|
+
end
|
|
1955
|
+
return data, status_code, headers
|
|
1956
|
+
end
|
|
1957
|
+
|
|
1958
|
+
# Generate an auto order update billing url
|
|
1959
|
+
# Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1960
|
+
# @param order_id [String] The order id to generate the update billing url for.
|
|
1961
|
+
# @param [Hash] opts the optional parameters
|
|
1962
|
+
# @return [OrderAutoOrderUpdateBillingUrlResponse]
|
|
1963
|
+
def get_update_billing_url(order_id, opts = {})
|
|
1964
|
+
data, _status_code, _headers = get_update_billing_url_with_http_info(order_id, opts)
|
|
1965
|
+
data
|
|
1966
|
+
end
|
|
1967
|
+
|
|
1968
|
+
# Generate an auto order update billing url
|
|
1969
|
+
# Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1970
|
+
# @param order_id [String] The order id to generate the update billing url for.
|
|
1971
|
+
# @param [Hash] opts the optional parameters
|
|
1972
|
+
# @return [Array<(OrderAutoOrderUpdateBillingUrlResponse, Integer, Hash)>] OrderAutoOrderUpdateBillingUrlResponse data, response status code and response headers
|
|
1973
|
+
def get_update_billing_url_with_http_info(order_id, opts = {})
|
|
1974
|
+
if @api_client.config.debugging
|
|
1975
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.get_update_billing_url ...'
|
|
1976
|
+
end
|
|
1977
|
+
# verify the required parameter 'order_id' is set
|
|
1978
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
|
1979
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_update_billing_url"
|
|
1980
|
+
end
|
|
1981
|
+
# resource path
|
|
1982
|
+
local_var_path = '/order/orders/{order_id}/auto_order_update_billing_url'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
|
|
1983
|
+
|
|
1984
|
+
# query parameters
|
|
1985
|
+
query_params = opts[:query_params] || {}
|
|
1986
|
+
|
|
1987
|
+
# header parameters
|
|
1988
|
+
header_params = opts[:header_params] || {}
|
|
1989
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1990
|
+
# HTTP header 'Accept' (if needed)
|
|
1991
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1992
|
+
|
|
1993
|
+
# form parameters
|
|
1994
|
+
form_params = opts[:form_params] || {}
|
|
1995
|
+
|
|
1996
|
+
# http body (model)
|
|
1997
|
+
post_body = opts[:debug_body]
|
|
1998
|
+
|
|
1999
|
+
# return_type
|
|
2000
|
+
return_type = opts[:debug_return_type] || 'OrderAutoOrderUpdateBillingUrlResponse'
|
|
2001
|
+
|
|
2002
|
+
# auth_names
|
|
2003
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2004
|
+
|
|
2005
|
+
new_options = opts.merge(
|
|
2006
|
+
:operation => :"OrderApi.get_update_billing_url",
|
|
2007
|
+
:header_params => header_params,
|
|
2008
|
+
:query_params => query_params,
|
|
2009
|
+
:form_params => form_params,
|
|
2010
|
+
:body => post_body,
|
|
2011
|
+
:auth_names => auth_names,
|
|
2012
|
+
:return_type => return_type
|
|
2013
|
+
)
|
|
2014
|
+
|
|
2015
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2016
|
+
if @api_client.config.debugging
|
|
2017
|
+
@api_client.config.logger.debug "API called: OrderApi#get_update_billing_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2018
|
+
end
|
|
2019
|
+
return data, status_code, headers
|
|
2020
|
+
end
|
|
2021
|
+
|
|
1813
2022
|
# Add items and release a held order
|
|
1814
2023
|
# This method adds items to an order in the hold stage and releases it
|
|
1815
2024
|
# @param order_id [String] The order id to release.
|
|
@@ -2930,6 +2930,152 @@ module UltracartClient
|
|
|
2930
2930
|
return data, status_code, headers
|
|
2931
2931
|
end
|
|
2932
2932
|
|
|
2933
|
+
# Get a screen recording
|
|
2934
|
+
# One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2935
|
+
# @param storefront_oid [Integer]
|
|
2936
|
+
# @param screen_recording_uuid [String]
|
|
2937
|
+
# @param [Hash] opts the optional parameters
|
|
2938
|
+
# @return [SfvbRecordingResponse]
|
|
2939
|
+
def get_sfvb_recording(storefront_oid, screen_recording_uuid, opts = {})
|
|
2940
|
+
data, _status_code, _headers = get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
|
|
2941
|
+
data
|
|
2942
|
+
end
|
|
2943
|
+
|
|
2944
|
+
# Get a screen recording
|
|
2945
|
+
# One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2946
|
+
# @param storefront_oid [Integer]
|
|
2947
|
+
# @param screen_recording_uuid [String]
|
|
2948
|
+
# @param [Hash] opts the optional parameters
|
|
2949
|
+
# @return [Array<(SfvbRecordingResponse, Integer, Hash)>] SfvbRecordingResponse data, response status code and response headers
|
|
2950
|
+
def get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
|
|
2951
|
+
if @api_client.config.debugging
|
|
2952
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording ...'
|
|
2953
|
+
end
|
|
2954
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2955
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2956
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_recording"
|
|
2957
|
+
end
|
|
2958
|
+
# verify the required parameter 'screen_recording_uuid' is set
|
|
2959
|
+
if @api_client.config.client_side_validation && screen_recording_uuid.nil?
|
|
2960
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording"
|
|
2961
|
+
end
|
|
2962
|
+
# resource path
|
|
2963
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))
|
|
2964
|
+
|
|
2965
|
+
# query parameters
|
|
2966
|
+
query_params = opts[:query_params] || {}
|
|
2967
|
+
|
|
2968
|
+
# header parameters
|
|
2969
|
+
header_params = opts[:header_params] || {}
|
|
2970
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2971
|
+
# HTTP header 'Accept' (if needed)
|
|
2972
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2973
|
+
|
|
2974
|
+
# form parameters
|
|
2975
|
+
form_params = opts[:form_params] || {}
|
|
2976
|
+
|
|
2977
|
+
# http body (model)
|
|
2978
|
+
post_body = opts[:debug_body]
|
|
2979
|
+
|
|
2980
|
+
# return_type
|
|
2981
|
+
return_type = opts[:debug_return_type] || 'SfvbRecordingResponse'
|
|
2982
|
+
|
|
2983
|
+
# auth_names
|
|
2984
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2985
|
+
|
|
2986
|
+
new_options = opts.merge(
|
|
2987
|
+
:operation => :"SfvbApi.get_sfvb_recording",
|
|
2988
|
+
:header_params => header_params,
|
|
2989
|
+
:query_params => query_params,
|
|
2990
|
+
:form_params => form_params,
|
|
2991
|
+
:body => post_body,
|
|
2992
|
+
:auth_names => auth_names,
|
|
2993
|
+
:return_type => return_type
|
|
2994
|
+
)
|
|
2995
|
+
|
|
2996
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2997
|
+
if @api_client.config.debugging
|
|
2998
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2999
|
+
end
|
|
3000
|
+
return data, status_code, headers
|
|
3001
|
+
end
|
|
3002
|
+
|
|
3003
|
+
# Get one recorded page view's replay events
|
|
3004
|
+
# The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
3005
|
+
# @param storefront_oid [Integer]
|
|
3006
|
+
# @param screen_recording_uuid [String]
|
|
3007
|
+
# @param screen_recording_page_view_uuid [String]
|
|
3008
|
+
# @param [Hash] opts the optional parameters
|
|
3009
|
+
# @return [SfvbRecordingEventsResponse]
|
|
3010
|
+
def get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
|
|
3011
|
+
data, _status_code, _headers = get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts)
|
|
3012
|
+
data
|
|
3013
|
+
end
|
|
3014
|
+
|
|
3015
|
+
# Get one recorded page view's replay events
|
|
3016
|
+
# The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
3017
|
+
# @param storefront_oid [Integer]
|
|
3018
|
+
# @param screen_recording_uuid [String]
|
|
3019
|
+
# @param screen_recording_page_view_uuid [String]
|
|
3020
|
+
# @param [Hash] opts the optional parameters
|
|
3021
|
+
# @return [Array<(SfvbRecordingEventsResponse, Integer, Hash)>] SfvbRecordingEventsResponse data, response status code and response headers
|
|
3022
|
+
def get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
|
|
3023
|
+
if @api_client.config.debugging
|
|
3024
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording_page_view_events ...'
|
|
3025
|
+
end
|
|
3026
|
+
# verify the required parameter 'storefront_oid' is set
|
|
3027
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3028
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3029
|
+
end
|
|
3030
|
+
# verify the required parameter 'screen_recording_uuid' is set
|
|
3031
|
+
if @api_client.config.client_side_validation && screen_recording_uuid.nil?
|
|
3032
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3033
|
+
end
|
|
3034
|
+
# verify the required parameter 'screen_recording_page_view_uuid' is set
|
|
3035
|
+
if @api_client.config.client_side_validation && screen_recording_page_view_uuid.nil?
|
|
3036
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_page_view_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3037
|
+
end
|
|
3038
|
+
# resource path
|
|
3039
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s)).sub('{' + 'screen_recording_page_view_uuid' + '}', CGI.escape(screen_recording_page_view_uuid.to_s))
|
|
3040
|
+
|
|
3041
|
+
# query parameters
|
|
3042
|
+
query_params = opts[:query_params] || {}
|
|
3043
|
+
|
|
3044
|
+
# header parameters
|
|
3045
|
+
header_params = opts[:header_params] || {}
|
|
3046
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3047
|
+
# HTTP header 'Accept' (if needed)
|
|
3048
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3049
|
+
|
|
3050
|
+
# form parameters
|
|
3051
|
+
form_params = opts[:form_params] || {}
|
|
3052
|
+
|
|
3053
|
+
# http body (model)
|
|
3054
|
+
post_body = opts[:debug_body]
|
|
3055
|
+
|
|
3056
|
+
# return_type
|
|
3057
|
+
return_type = opts[:debug_return_type] || 'SfvbRecordingEventsResponse'
|
|
3058
|
+
|
|
3059
|
+
# auth_names
|
|
3060
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3061
|
+
|
|
3062
|
+
new_options = opts.merge(
|
|
3063
|
+
:operation => :"SfvbApi.get_sfvb_recording_page_view_events",
|
|
3064
|
+
:header_params => header_params,
|
|
3065
|
+
:query_params => query_params,
|
|
3066
|
+
:form_params => form_params,
|
|
3067
|
+
:body => post_body,
|
|
3068
|
+
:auth_names => auth_names,
|
|
3069
|
+
:return_type => return_type
|
|
3070
|
+
)
|
|
3071
|
+
|
|
3072
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3073
|
+
if @api_client.config.debugging
|
|
3074
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_recording_page_view_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3075
|
+
end
|
|
3076
|
+
return data, status_code, headers
|
|
3077
|
+
end
|
|
3078
|
+
|
|
2933
3079
|
# Get one storefront render log
|
|
2934
3080
|
# One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2935
3081
|
# @param storefront_oid [Integer]
|