ultracart_api 4.1.228 → 4.1.229

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.
@@ -1900,6 +1900,76 @@ module UltracartClient
1900
1900
  return data, status_code, headers
1901
1901
  end
1902
1902
 
1903
+ # Remove a 404 path from the log
1904
+ # The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
1905
+ # @param storefront_oid [Integer]
1906
+ # @param not_found_id [String]
1907
+ # @param [Hash] opts the optional parameters
1908
+ # @return [nil]
1909
+ def delete_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
1910
+ delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
1911
+ nil
1912
+ end
1913
+
1914
+ # Remove a 404 path from the log
1915
+ # The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
1916
+ # @param storefront_oid [Integer]
1917
+ # @param not_found_id [String]
1918
+ # @param [Hash] opts the optional parameters
1919
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1920
+ def delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
1921
+ if @api_client.config.debugging
1922
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_not_found_entry ...'
1923
+ end
1924
+ # verify the required parameter 'storefront_oid' is set
1925
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1926
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_not_found_entry"
1927
+ end
1928
+ # verify the required parameter 'not_found_id' is set
1929
+ if @api_client.config.client_side_validation && not_found_id.nil?
1930
+ fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.delete_sfvb_not_found_entry"
1931
+ end
1932
+ # resource path
1933
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
1934
+
1935
+ # query parameters
1936
+ query_params = opts[:query_params] || {}
1937
+
1938
+ # header parameters
1939
+ header_params = opts[:header_params] || {}
1940
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1941
+ # HTTP header 'Accept' (if needed)
1942
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1943
+
1944
+ # form parameters
1945
+ form_params = opts[:form_params] || {}
1946
+
1947
+ # http body (model)
1948
+ post_body = opts[:debug_body]
1949
+
1950
+ # return_type
1951
+ return_type = opts[:debug_return_type]
1952
+
1953
+ # auth_names
1954
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1955
+
1956
+ new_options = opts.merge(
1957
+ :operation => :"SfvbApi.delete_sfvb_not_found_entry",
1958
+ :header_params => header_params,
1959
+ :query_params => query_params,
1960
+ :form_params => form_params,
1961
+ :body => post_body,
1962
+ :auth_names => auth_names,
1963
+ :return_type => return_type
1964
+ )
1965
+
1966
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1967
+ if @api_client.config.debugging
1968
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1969
+ end
1970
+ return data, status_code, headers
1971
+ end
1972
+
1903
1973
  # Detach an image from a page
1904
1974
  # Name exactly one of code or default. Removes the page's copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
1905
1975
  # @param storefront_oid [Integer]
@@ -3924,6 +3994,76 @@ module UltracartClient
3924
3994
  return data, status_code, headers
3925
3995
  end
3926
3996
 
3997
+ # Export the open 404 paths
3998
+ # Up to 5,000 open paths, most hits first, as the admin's mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
3999
+ # @param storefront_oid [Integer]
4000
+ # @param [Hash] opts the optional parameters
4001
+ # @option opts [Boolean] :include_bots
4002
+ # @option opts [Boolean] :include_tokens
4003
+ # @return [SfvbNotFoundResponse]
4004
+ def export_sfvb_not_found(storefront_oid, opts = {})
4005
+ data, _status_code, _headers = export_sfvb_not_found_with_http_info(storefront_oid, opts)
4006
+ data
4007
+ end
4008
+
4009
+ # Export the open 404 paths
4010
+ # Up to 5,000 open paths, most hits first, as the admin&#39;s mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
4011
+ # @param storefront_oid [Integer]
4012
+ # @param [Hash] opts the optional parameters
4013
+ # @option opts [Boolean] :include_bots
4014
+ # @option opts [Boolean] :include_tokens
4015
+ # @return [Array<(SfvbNotFoundResponse, Integer, Hash)>] SfvbNotFoundResponse data, response status code and response headers
4016
+ def export_sfvb_not_found_with_http_info(storefront_oid, opts = {})
4017
+ if @api_client.config.debugging
4018
+ @api_client.config.logger.debug 'Calling API: SfvbApi.export_sfvb_not_found ...'
4019
+ end
4020
+ # verify the required parameter 'storefront_oid' is set
4021
+ if @api_client.config.client_side_validation && storefront_oid.nil?
4022
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.export_sfvb_not_found"
4023
+ end
4024
+ # resource path
4025
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/export'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
4026
+
4027
+ # query parameters
4028
+ query_params = opts[:query_params] || {}
4029
+ query_params[:'include_bots'] = opts[:'include_bots'] if !opts[:'include_bots'].nil?
4030
+ query_params[:'include_tokens'] = opts[:'include_tokens'] if !opts[:'include_tokens'].nil?
4031
+
4032
+ # header parameters
4033
+ header_params = opts[:header_params] || {}
4034
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4035
+ # HTTP header 'Accept' (if needed)
4036
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4037
+
4038
+ # form parameters
4039
+ form_params = opts[:form_params] || {}
4040
+
4041
+ # http body (model)
4042
+ post_body = opts[:debug_body]
4043
+
4044
+ # return_type
4045
+ return_type = opts[:debug_return_type] || 'SfvbNotFoundResponse'
4046
+
4047
+ # auth_names
4048
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4049
+
4050
+ new_options = opts.merge(
4051
+ :operation => :"SfvbApi.export_sfvb_not_found",
4052
+ :header_params => header_params,
4053
+ :query_params => query_params,
4054
+ :form_params => form_params,
4055
+ :body => post_body,
4056
+ :auth_names => auth_names,
4057
+ :return_type => return_type
4058
+ )
4059
+
4060
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4061
+ if @api_client.config.debugging
4062
+ @api_client.config.logger.debug "API called: SfvbApi#export_sfvb_not_found\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4063
+ end
4064
+ return data, status_code, headers
4065
+ end
4066
+
3927
4067
  # Favorite a library entry
3928
4068
  # Bookmarks the entry for the calling user. Idempotent. Owner or anyone the entry is shared with.
3929
4069
  # @param storefront_oid [Integer]
@@ -3994,6 +4134,76 @@ module UltracartClient
3994
4134
  return data, status_code, headers
3995
4135
  end
3996
4136
 
4137
+ # Mark a 404 path fixed
4138
+ # For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin's Mark Fixed.
4139
+ # @param storefront_oid [Integer]
4140
+ # @param not_found_id [String]
4141
+ # @param [Hash] opts the optional parameters
4142
+ # @return [SfvbNotFoundEntry]
4143
+ def fix_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
4144
+ data, _status_code, _headers = fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
4145
+ data
4146
+ end
4147
+
4148
+ # Mark a 404 path fixed
4149
+ # For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin&#39;s Mark Fixed.
4150
+ # @param storefront_oid [Integer]
4151
+ # @param not_found_id [String]
4152
+ # @param [Hash] opts the optional parameters
4153
+ # @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
4154
+ def fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
4155
+ if @api_client.config.debugging
4156
+ @api_client.config.logger.debug 'Calling API: SfvbApi.fix_sfvb_not_found_entry ...'
4157
+ end
4158
+ # verify the required parameter 'storefront_oid' is set
4159
+ if @api_client.config.client_side_validation && storefront_oid.nil?
4160
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.fix_sfvb_not_found_entry"
4161
+ end
4162
+ # verify the required parameter 'not_found_id' is set
4163
+ if @api_client.config.client_side_validation && not_found_id.nil?
4164
+ fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.fix_sfvb_not_found_entry"
4165
+ end
4166
+ # resource path
4167
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/fixed'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
4168
+
4169
+ # query parameters
4170
+ query_params = opts[:query_params] || {}
4171
+
4172
+ # header parameters
4173
+ header_params = opts[:header_params] || {}
4174
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4175
+ # HTTP header 'Accept' (if needed)
4176
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4177
+
4178
+ # form parameters
4179
+ form_params = opts[:form_params] || {}
4180
+
4181
+ # http body (model)
4182
+ post_body = opts[:debug_body]
4183
+
4184
+ # return_type
4185
+ return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
4186
+
4187
+ # auth_names
4188
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4189
+
4190
+ new_options = opts.merge(
4191
+ :operation => :"SfvbApi.fix_sfvb_not_found_entry",
4192
+ :header_params => header_params,
4193
+ :query_params => query_params,
4194
+ :form_params => form_params,
4195
+ :body => post_body,
4196
+ :auth_names => auth_names,
4197
+ :return_type => return_type
4198
+ )
4199
+
4200
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4201
+ if @api_client.config.debugging
4202
+ @api_client.config.logger.debug "API called: SfvbApi#fix_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4203
+ end
4204
+ return data, status_code, headers
4205
+ end
4206
+
3997
4207
  # Read one affiliate network
3998
4208
  # The network with its conversion_pixel, and the hash_sha256 an update or delete sends back as If-Match.
3999
4209
  # @param storefront_oid [Integer]
@@ -6662,6 +6872,70 @@ module UltracartClient
6662
6872
  return data, status_code, headers
6663
6873
  end
6664
6874
 
6875
+ # The 404 log's trend
6876
+ # The admin's 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
6877
+ # @param storefront_oid [Integer]
6878
+ # @param [Hash] opts the optional parameters
6879
+ # @return [SfvbNotFoundSummary]
6880
+ def get_sfvb_not_found_summary(storefront_oid, opts = {})
6881
+ data, _status_code, _headers = get_sfvb_not_found_summary_with_http_info(storefront_oid, opts)
6882
+ data
6883
+ end
6884
+
6885
+ # The 404 log&#39;s trend
6886
+ # The admin&#39;s 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
6887
+ # @param storefront_oid [Integer]
6888
+ # @param [Hash] opts the optional parameters
6889
+ # @return [Array<(SfvbNotFoundSummary, Integer, Hash)>] SfvbNotFoundSummary data, response status code and response headers
6890
+ def get_sfvb_not_found_summary_with_http_info(storefront_oid, opts = {})
6891
+ if @api_client.config.debugging
6892
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_not_found_summary ...'
6893
+ end
6894
+ # verify the required parameter 'storefront_oid' is set
6895
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6896
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_not_found_summary"
6897
+ end
6898
+ # resource path
6899
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/summary'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
6900
+
6901
+ # query parameters
6902
+ query_params = opts[:query_params] || {}
6903
+
6904
+ # header parameters
6905
+ header_params = opts[:header_params] || {}
6906
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6907
+ # HTTP header 'Accept' (if needed)
6908
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6909
+
6910
+ # form parameters
6911
+ form_params = opts[:form_params] || {}
6912
+
6913
+ # http body (model)
6914
+ post_body = opts[:debug_body]
6915
+
6916
+ # return_type
6917
+ return_type = opts[:debug_return_type] || 'SfvbNotFoundSummary'
6918
+
6919
+ # auth_names
6920
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6921
+
6922
+ new_options = opts.merge(
6923
+ :operation => :"SfvbApi.get_sfvb_not_found_summary",
6924
+ :header_params => header_params,
6925
+ :query_params => query_params,
6926
+ :form_params => form_params,
6927
+ :body => post_body,
6928
+ :auth_names => auth_names,
6929
+ :return_type => return_type
6930
+ )
6931
+
6932
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6933
+ if @api_client.config.debugging
6934
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_not_found_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6935
+ end
6936
+ return data, status_code, headers
6937
+ end
6938
+
6665
6939
  # Read a page's attributes and images
6666
6940
  # What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
6667
6941
  # @param storefront_oid [Integer]
@@ -7847,6 +8121,70 @@ module UltracartClient
7847
8121
  return data, status_code, headers
7848
8122
  end
7849
8123
 
8124
+ # Read a storefront's search engine settings
8125
+ # Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
8126
+ # @param storefront_oid [Integer]
8127
+ # @param [Hash] opts the optional parameters
8128
+ # @return [SfvbSiteSeo]
8129
+ def get_sfvb_site_seo(storefront_oid, opts = {})
8130
+ data, _status_code, _headers = get_sfvb_site_seo_with_http_info(storefront_oid, opts)
8131
+ data
8132
+ end
8133
+
8134
+ # Read a storefront&#39;s search engine settings
8135
+ # Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
8136
+ # @param storefront_oid [Integer]
8137
+ # @param [Hash] opts the optional parameters
8138
+ # @return [Array<(SfvbSiteSeo, Integer, Hash)>] SfvbSiteSeo data, response status code and response headers
8139
+ def get_sfvb_site_seo_with_http_info(storefront_oid, opts = {})
8140
+ if @api_client.config.debugging
8141
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_site_seo ...'
8142
+ end
8143
+ # verify the required parameter 'storefront_oid' is set
8144
+ if @api_client.config.client_side_validation && storefront_oid.nil?
8145
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_site_seo"
8146
+ end
8147
+ # resource path
8148
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/seo'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
8149
+
8150
+ # query parameters
8151
+ query_params = opts[:query_params] || {}
8152
+
8153
+ # header parameters
8154
+ header_params = opts[:header_params] || {}
8155
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
8156
+ # HTTP header 'Accept' (if needed)
8157
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8158
+
8159
+ # form parameters
8160
+ form_params = opts[:form_params] || {}
8161
+
8162
+ # http body (model)
8163
+ post_body = opts[:debug_body]
8164
+
8165
+ # return_type
8166
+ return_type = opts[:debug_return_type] || 'SfvbSiteSeo'
8167
+
8168
+ # auth_names
8169
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8170
+
8171
+ new_options = opts.merge(
8172
+ :operation => :"SfvbApi.get_sfvb_site_seo",
8173
+ :header_params => header_params,
8174
+ :query_params => query_params,
8175
+ :form_params => form_params,
8176
+ :body => post_body,
8177
+ :auth_names => auth_names,
8178
+ :return_type => return_type
8179
+ )
8180
+
8181
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8182
+ if @api_client.config.debugging
8183
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_site_seo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8184
+ end
8185
+ return data, status_code, headers
8186
+ end
8187
+
7850
8188
  # Read a storefront's sitemaps and robots.txt
7851
8189
  # The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
7852
8190
  # @param storefront_oid [Integer]
@@ -14618,6 +14956,81 @@ module UltracartClient
14618
14956
  return data, status_code, headers
14619
14957
  end
14620
14958
 
14959
+ # What a shopper gets for each of many paths
14960
+ # Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
14961
+ # @param storefront_oid [Integer]
14962
+ # @param redirect_resolve_batch_request [SfvbRedirectResolveBatchRequest] The paths
14963
+ # @param [Hash] opts the optional parameters
14964
+ # @return [SfvbRedirectResolveBatchResponse]
14965
+ def resolve_sfvb_redirect_batch(storefront_oid, redirect_resolve_batch_request, opts = {})
14966
+ data, _status_code, _headers = resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request, opts)
14967
+ data
14968
+ end
14969
+
14970
+ # What a shopper gets for each of many paths
14971
+ # Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
14972
+ # @param storefront_oid [Integer]
14973
+ # @param redirect_resolve_batch_request [SfvbRedirectResolveBatchRequest] The paths
14974
+ # @param [Hash] opts the optional parameters
14975
+ # @return [Array<(SfvbRedirectResolveBatchResponse, Integer, Hash)>] SfvbRedirectResolveBatchResponse data, response status code and response headers
14976
+ def resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request, opts = {})
14977
+ if @api_client.config.debugging
14978
+ @api_client.config.logger.debug 'Calling API: SfvbApi.resolve_sfvb_redirect_batch ...'
14979
+ end
14980
+ # verify the required parameter 'storefront_oid' is set
14981
+ if @api_client.config.client_side_validation && storefront_oid.nil?
14982
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.resolve_sfvb_redirect_batch"
14983
+ end
14984
+ # verify the required parameter 'redirect_resolve_batch_request' is set
14985
+ if @api_client.config.client_side_validation && redirect_resolve_batch_request.nil?
14986
+ fail ArgumentError, "Missing the required parameter 'redirect_resolve_batch_request' when calling SfvbApi.resolve_sfvb_redirect_batch"
14987
+ end
14988
+ # resource path
14989
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/resolve_batch'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
14990
+
14991
+ # query parameters
14992
+ query_params = opts[:query_params] || {}
14993
+
14994
+ # header parameters
14995
+ header_params = opts[:header_params] || {}
14996
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
14997
+ # HTTP header 'Accept' (if needed)
14998
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14999
+ # HTTP header 'Content-Type'
15000
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
15001
+ if !content_type.nil?
15002
+ header_params['Content-Type'] = content_type
15003
+ end
15004
+
15005
+ # form parameters
15006
+ form_params = opts[:form_params] || {}
15007
+
15008
+ # http body (model)
15009
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_resolve_batch_request)
15010
+
15011
+ # return_type
15012
+ return_type = opts[:debug_return_type] || 'SfvbRedirectResolveBatchResponse'
15013
+
15014
+ # auth_names
15015
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
15016
+
15017
+ new_options = opts.merge(
15018
+ :operation => :"SfvbApi.resolve_sfvb_redirect_batch",
15019
+ :header_params => header_params,
15020
+ :query_params => query_params,
15021
+ :form_params => form_params,
15022
+ :body => post_body,
15023
+ :auth_names => auth_names,
15024
+ :return_type => return_type
15025
+ )
15026
+
15027
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
15028
+ if @api_client.config.debugging
15029
+ @api_client.config.logger.debug "API called: SfvbApi#resolve_sfvb_redirect_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
15030
+ end
15031
+ return data, status_code, headers
15032
+ end
15033
+
14621
15034
  # Resolve a template name to the file a page renders
14622
15035
  # A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
14623
15036
  # @param storefront_oid [Integer]
@@ -16894,6 +17307,91 @@ module UltracartClient
16894
17307
  return data, status_code, headers
16895
17308
  end
16896
17309
 
17310
+ # Change a storefront's search engine settings
17311
+ # A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
17312
+ # @param storefront_oid [Integer]
17313
+ # @param if_match [String] The hash_sha256 from the last read. 428 when absent, 412 when stale.
17314
+ # @param site_seo_request [SfvbSiteSeoRequest] The switches to change
17315
+ # @param [Hash] opts the optional parameters
17316
+ # @option opts [String] :approval_id When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals.
17317
+ # @return [SfvbSiteSeo]
17318
+ def update_sfvb_site_seo(storefront_oid, if_match, site_seo_request, opts = {})
17319
+ data, _status_code, _headers = update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
17320
+ data
17321
+ end
17322
+
17323
+ # Change a storefront&#39;s search engine settings
17324
+ # A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
17325
+ # @param storefront_oid [Integer]
17326
+ # @param if_match [String] The hash_sha256 from the last read. 428 when absent, 412 when stale.
17327
+ # @param site_seo_request [SfvbSiteSeoRequest] The switches to change
17328
+ # @param [Hash] opts the optional parameters
17329
+ # @option opts [String] :approval_id When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals.
17330
+ # @return [Array<(SfvbSiteSeo, Integer, Hash)>] SfvbSiteSeo data, response status code and response headers
17331
+ def update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts = {})
17332
+ if @api_client.config.debugging
17333
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_site_seo ...'
17334
+ end
17335
+ # verify the required parameter 'storefront_oid' is set
17336
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17337
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_site_seo"
17338
+ end
17339
+ # verify the required parameter 'if_match' is set
17340
+ if @api_client.config.client_side_validation && if_match.nil?
17341
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_site_seo"
17342
+ end
17343
+ # verify the required parameter 'site_seo_request' is set
17344
+ if @api_client.config.client_side_validation && site_seo_request.nil?
17345
+ fail ArgumentError, "Missing the required parameter 'site_seo_request' when calling SfvbApi.update_sfvb_site_seo"
17346
+ end
17347
+ # resource path
17348
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/seo'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
17349
+
17350
+ # query parameters
17351
+ query_params = opts[:query_params] || {}
17352
+
17353
+ # header parameters
17354
+ header_params = opts[:header_params] || {}
17355
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17356
+ # HTTP header 'Accept' (if needed)
17357
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17358
+ # HTTP header 'Content-Type'
17359
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17360
+ if !content_type.nil?
17361
+ header_params['Content-Type'] = content_type
17362
+ end
17363
+ header_params[:'If-Match'] = if_match
17364
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
17365
+
17366
+ # form parameters
17367
+ form_params = opts[:form_params] || {}
17368
+
17369
+ # http body (model)
17370
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(site_seo_request)
17371
+
17372
+ # return_type
17373
+ return_type = opts[:debug_return_type] || 'SfvbSiteSeo'
17374
+
17375
+ # auth_names
17376
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17377
+
17378
+ new_options = opts.merge(
17379
+ :operation => :"SfvbApi.update_sfvb_site_seo",
17380
+ :header_params => header_params,
17381
+ :query_params => query_params,
17382
+ :form_params => form_params,
17383
+ :body => post_body,
17384
+ :auth_names => auth_names,
17385
+ :return_type => return_type
17386
+ )
17387
+
17388
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17389
+ if @api_client.config.debugging
17390
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_site_seo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17391
+ end
17392
+ return data, status_code, headers
17393
+ end
17394
+
16897
17395
  # Change a storefront's Smart Attribution configuration
16898
17396
  # A partial update of the mode, model, global split and lookback. platforms, when sent, replaces the whole list. The global split must total exactly 1 and the lookback is 7 to 365. On an unconfigured storefront it creates the configuration. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, and when the mode is active or the change makes it active, an approved smart_attribution.change request for exactly this change (Approval-Id), because active mode decides which conversions each platform is sent. A change that stores what is already stored returns the configuration unchanged and uses no approval.
16899
17397
  # @param storefront_oid [Integer]
@@ -40,6 +40,8 @@ module UltracartClient
40
40
 
41
41
  attr_accessor :segment_update
42
42
 
43
+ attr_accessor :site_seo
44
+
43
45
  attr_accessor :smart_attribution
44
46
 
45
47
  attr_accessor :tracking_provider
@@ -79,6 +81,7 @@ module UltracartClient
79
81
  :'reason' => :'reason',
80
82
  :'redirect_rows' => :'redirect_rows',
81
83
  :'segment_update' => :'segment_update',
84
+ :'site_seo' => :'site_seo',
82
85
  :'smart_attribution' => :'smart_attribution',
83
86
  :'tracking_provider' => :'tracking_provider'
84
87
  }
@@ -102,6 +105,7 @@ module UltracartClient
102
105
  :'reason' => :'String',
103
106
  :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>',
104
107
  :'segment_update' => :'SfvbCommsSegmentWriteRequest',
108
+ :'site_seo' => :'SfvbSiteSeoRequest',
105
109
  :'smart_attribution' => :'SfvbSmartAttributionRequest',
106
110
  :'tracking_provider' => :'SfvbTrackingProviderRequest'
107
111
  }
@@ -172,6 +176,10 @@ module UltracartClient
172
176
  self.segment_update = attributes[:'segment_update']
173
177
  end
174
178
 
179
+ if attributes.key?(:'site_seo')
180
+ self.site_seo = attributes[:'site_seo']
181
+ end
182
+
175
183
  if attributes.key?(:'smart_attribution')
176
184
  self.smart_attribution = attributes[:'smart_attribution']
177
185
  end
@@ -191,7 +199,7 @@ module UltracartClient
191
199
  # Check to see if the all the properties in the model are valid
192
200
  # @return true if the model is valid
193
201
  def valid?
194
- action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete"])
202
+ action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
195
203
  return false unless action_validator.valid?(@action)
196
204
  true
197
205
  end
@@ -199,7 +207,7 @@ module UltracartClient
199
207
  # Custom attribute writer method checking allowed values (enum).
200
208
  # @param [Object] action Object to be assigned
201
209
  def action=(action)
202
- validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete"])
210
+ validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
203
211
  unless validator.valid?(action)
204
212
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
205
213
  end
@@ -221,6 +229,7 @@ module UltracartClient
221
229
  reason == o.reason &&
222
230
  redirect_rows == o.redirect_rows &&
223
231
  segment_update == o.segment_update &&
232
+ site_seo == o.site_seo &&
224
233
  smart_attribution == o.smart_attribution &&
225
234
  tracking_provider == o.tracking_provider
226
235
  end
@@ -234,7 +243,7 @@ module UltracartClient
234
243
  # Calculates hash code according to all attributes.
235
244
  # @return [Integer] Hash code
236
245
  def hash
237
- [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, smart_attribution, tracking_provider].hash
246
+ [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider].hash
238
247
  end
239
248
 
240
249
  # Builds the object from hash
@@ -27,6 +27,9 @@ module UltracartClient
27
27
  # First hit, ISO 8601.
28
28
  attr_accessor :first_seen_dts
29
29
 
30
+ # True when the entry is marked fixed or mapped. The next hit on the path clears it.
31
+ attr_accessor :fixed
32
+
30
33
  # Every recorded hit, bots included.
31
34
  attr_accessor :hits
32
35
 
@@ -55,6 +58,7 @@ module UltracartClient
55
58
  :'bot_share' => :'bot_share',
56
59
  :'counted_hits' => :'counted_hits',
57
60
  :'first_seen_dts' => :'first_seen_dts',
61
+ :'fixed' => :'fixed',
58
62
  :'hits' => :'hits',
59
63
  :'ignored' => :'ignored',
60
64
  :'last_seen_dts' => :'last_seen_dts',
@@ -77,6 +81,7 @@ module UltracartClient
77
81
  :'bot_share' => :'Object',
78
82
  :'counted_hits' => :'Integer',
79
83
  :'first_seen_dts' => :'String',
84
+ :'fixed' => :'Boolean',
80
85
  :'hits' => :'Integer',
81
86
  :'ignored' => :'Boolean',
82
87
  :'last_seen_dts' => :'String',
@@ -124,6 +129,10 @@ module UltracartClient
124
129
  self.first_seen_dts = attributes[:'first_seen_dts']
125
130
  end
126
131
 
132
+ if attributes.key?(:'fixed')
133
+ self.fixed = attributes[:'fixed']
134
+ end
135
+
127
136
  if attributes.key?(:'hits')
128
137
  self.hits = attributes[:'hits']
129
138
  end
@@ -177,6 +186,7 @@ module UltracartClient
177
186
  bot_share == o.bot_share &&
178
187
  counted_hits == o.counted_hits &&
179
188
  first_seen_dts == o.first_seen_dts &&
189
+ fixed == o.fixed &&
180
190
  hits == o.hits &&
181
191
  ignored == o.ignored &&
182
192
  last_seen_dts == o.last_seen_dts &&
@@ -195,7 +205,7 @@ module UltracartClient
195
205
  # Calculates hash code according to all attributes.
196
206
  # @return [Integer] Hash code
197
207
  def hash
198
- [bot_hits, bot_share, counted_hits, first_seen_dts, hits, ignored, last_seen_dts, not_found_id, path, redirected_to, referrer_hosts].hash
208
+ [bot_hits, bot_share, counted_hits, first_seen_dts, fixed, hits, ignored, last_seen_dts, not_found_id, path, redirected_to, referrer_hosts].hash
199
209
  end
200
210
 
201
211
  # Builds the object from hash