ultracart_api 4.1.252 → 4.1.253

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.
@@ -9923,6 +9923,70 @@ module UltracartClient
9923
9923
  return data, status_code, headers
9924
9924
  end
9925
9925
 
9926
+ # Read the storefront's faceted search configuration
9927
+ # Every facet the storefront can offer shoppers - the standard ones and one per item attribute on the storefront - with its heading and whether it is on, in the fixed order shoppers see them, and the Cost facet's price breaks. The same settings as the store admin's Faceted Search Results. Send hash_sha256 as If-Match to change them.
9928
+ # @param storefront_oid [Integer]
9929
+ # @param [Hash] opts the optional parameters
9930
+ # @return [SfvbSearchFacetsResponse]
9931
+ def get_sfvb_search_facets(storefront_oid, opts = {})
9932
+ data, _status_code, _headers = get_sfvb_search_facets_with_http_info(storefront_oid, opts)
9933
+ data
9934
+ end
9935
+
9936
+ # Read the storefront's faceted search configuration
9937
+ # Every facet the storefront can offer shoppers - the standard ones and one per item attribute on the storefront - with its heading and whether it is on, in the fixed order shoppers see them, and the Cost facet's price breaks. The same settings as the store admin's Faceted Search Results. Send hash_sha256 as If-Match to change them.
9938
+ # @param storefront_oid [Integer]
9939
+ # @param [Hash] opts the optional parameters
9940
+ # @return [Array<(SfvbSearchFacetsResponse, Integer, Hash)>] SfvbSearchFacetsResponse data, response status code and response headers
9941
+ def get_sfvb_search_facets_with_http_info(storefront_oid, opts = {})
9942
+ if @api_client.config.debugging
9943
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_search_facets ...'
9944
+ end
9945
+ # verify the required parameter 'storefront_oid' is set
9946
+ if @api_client.config.client_side_validation && storefront_oid.nil?
9947
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_search_facets"
9948
+ end
9949
+ # resource path
9950
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/search/facets'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
9951
+
9952
+ # query parameters
9953
+ query_params = opts[:query_params] || {}
9954
+
9955
+ # header parameters
9956
+ header_params = opts[:header_params] || {}
9957
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
9958
+ # HTTP header 'Accept' (if needed)
9959
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9960
+
9961
+ # form parameters
9962
+ form_params = opts[:form_params] || {}
9963
+
9964
+ # http body (model)
9965
+ post_body = opts[:debug_body]
9966
+
9967
+ # return_type
9968
+ return_type = opts[:debug_return_type] || 'SfvbSearchFacetsResponse'
9969
+
9970
+ # auth_names
9971
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
9972
+
9973
+ new_options = opts.merge(
9974
+ :operation => :"SfvbApi.get_sfvb_search_facets",
9975
+ :header_params => header_params,
9976
+ :query_params => query_params,
9977
+ :form_params => form_params,
9978
+ :body => post_body,
9979
+ :auth_names => auth_names,
9980
+ :return_type => return_type
9981
+ )
9982
+
9983
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
9984
+ if @api_client.config.debugging
9985
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_search_facets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9986
+ end
9987
+ return data, status_code, headers
9988
+ end
9989
+
9926
9990
  # List the secrets this server collects
9927
9991
  # The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
9928
9992
  # @param [Hash] opts the optional parameters
@@ -15119,6 +15183,84 @@ module UltracartClient
15119
15183
  return data, status_code, headers
15120
15184
  end
15121
15185
 
15186
+ # Move or rename a page
15187
+ # Moves a page to a new path - a new parent, a new last part, or both, so a rename is a move under the same parent. Its sub-pages, their items and the page folder with its body move with it. Refused for the root page, a path inside the page itself, a path where a page or folder already exists, a parent that does not exist, and a page whose folder holds a started experiment. With redirect_old_url 301 the same call adds one pattern redirect from the old path to the new one, so every old address, sub-pages and items included, keeps working; the redirect is checked before anything moves, and if it is refused after the move the move is undone, so the page moves with its redirect or not at all. dry_run runs every check and reports what would move. Needs sfvb_publish, plus the approval of the person who signed in the CLI, as an approved page.move request for exactly this path, new path and redirect in the Approval-Id header.
15188
+ # @param storefront_oid [Integer]
15189
+ # @param page_move_request [SfvbPageMoveRequest] The page and where it goes
15190
+ # @param [Hash] opts the optional parameters
15191
+ # @option opts [String] :approval_id The approval_id of an approved page.move request for exactly this path, new path and redirect. Required unless dry_run. See POST /sfvb/approvals.
15192
+ # @return [SfvbPageMoveResponse]
15193
+ def move_sfvb_page(storefront_oid, page_move_request, opts = {})
15194
+ data, _status_code, _headers = move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts)
15195
+ data
15196
+ end
15197
+
15198
+ # Move or rename a page
15199
+ # Moves a page to a new path - a new parent, a new last part, or both, so a rename is a move under the same parent. Its sub-pages, their items and the page folder with its body move with it. Refused for the root page, a path inside the page itself, a path where a page or folder already exists, a parent that does not exist, and a page whose folder holds a started experiment. With redirect_old_url 301 the same call adds one pattern redirect from the old path to the new one, so every old address, sub-pages and items included, keeps working; the redirect is checked before anything moves, and if it is refused after the move the move is undone, so the page moves with its redirect or not at all. dry_run runs every check and reports what would move. Needs sfvb_publish, plus the approval of the person who signed in the CLI, as an approved page.move request for exactly this path, new path and redirect in the Approval-Id header.
15200
+ # @param storefront_oid [Integer]
15201
+ # @param page_move_request [SfvbPageMoveRequest] The page and where it goes
15202
+ # @param [Hash] opts the optional parameters
15203
+ # @option opts [String] :approval_id The approval_id of an approved page.move request for exactly this path, new path and redirect. Required unless dry_run. See POST /sfvb/approvals.
15204
+ # @return [Array<(SfvbPageMoveResponse, Integer, Hash)>] SfvbPageMoveResponse data, response status code and response headers
15205
+ def move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts = {})
15206
+ if @api_client.config.debugging
15207
+ @api_client.config.logger.debug 'Calling API: SfvbApi.move_sfvb_page ...'
15208
+ end
15209
+ # verify the required parameter 'storefront_oid' is set
15210
+ if @api_client.config.client_side_validation && storefront_oid.nil?
15211
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.move_sfvb_page"
15212
+ end
15213
+ # verify the required parameter 'page_move_request' is set
15214
+ if @api_client.config.client_side_validation && page_move_request.nil?
15215
+ fail ArgumentError, "Missing the required parameter 'page_move_request' when calling SfvbApi.move_sfvb_page"
15216
+ end
15217
+ # resource path
15218
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/move'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
15219
+
15220
+ # query parameters
15221
+ query_params = opts[:query_params] || {}
15222
+
15223
+ # header parameters
15224
+ header_params = opts[:header_params] || {}
15225
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
15226
+ # HTTP header 'Accept' (if needed)
15227
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
15228
+ # HTTP header 'Content-Type'
15229
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
15230
+ if !content_type.nil?
15231
+ header_params['Content-Type'] = content_type
15232
+ end
15233
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
15234
+
15235
+ # form parameters
15236
+ form_params = opts[:form_params] || {}
15237
+
15238
+ # http body (model)
15239
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(page_move_request)
15240
+
15241
+ # return_type
15242
+ return_type = opts[:debug_return_type] || 'SfvbPageMoveResponse'
15243
+
15244
+ # auth_names
15245
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
15246
+
15247
+ new_options = opts.merge(
15248
+ :operation => :"SfvbApi.move_sfvb_page",
15249
+ :header_params => header_params,
15250
+ :query_params => query_params,
15251
+ :form_params => form_params,
15252
+ :body => post_body,
15253
+ :auth_names => auth_names,
15254
+ :return_type => return_type
15255
+ )
15256
+
15257
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
15258
+ if @api_client.config.debugging
15259
+ @api_client.config.logger.debug "API called: SfvbApi#move_sfvb_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
15260
+ end
15261
+ return data, status_code, headers
15262
+ end
15263
+
15122
15264
  # Move one step
15123
15265
  # Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step's hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
15124
15266
  # @param storefront_oid [Integer]
@@ -17094,7 +17236,7 @@ module UltracartClient
17094
17236
  end
17095
17237
 
17096
17238
  # Change a page's settings
17097
- # A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin's page save, the page's attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live.
17239
+ # A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin's page save, the page's attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live. Hiding a page with redirect_old_url 301 and redirect_target also adds a 301 redirect from its address, checked first like any redirect rule. The page is hidden and the rule added together, or neither.
17098
17240
  # @param storefront_oid [Integer]
17099
17241
  # @param path [String] Page path, for example /lp/spring-sale/
17100
17242
  # @param page_settings_request [SfvbPageSettingsRequest] The settings to change
@@ -17106,7 +17248,7 @@ module UltracartClient
17106
17248
  end
17107
17249
 
17108
17250
  # Change a page&#39;s settings
17109
- # A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin&#39;s page save, the page&#39;s attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live.
17251
+ # A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin&#39;s page save, the page&#39;s attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live. Hiding a page with redirect_old_url 301 and redirect_target also adds a 301 redirect from its address, checked first like any redirect rule. The page is hidden and the rule added together, or neither.
17110
17252
  # @param storefront_oid [Integer]
17111
17253
  # @param path [String] Page path, for example /lp/spring-sale/
17112
17254
  # @param page_settings_request [SfvbPageSettingsRequest] The settings to change
@@ -18566,7 +18708,7 @@ module UltracartClient
18566
18708
  # @param storefront_oid [Integer]
18567
18709
  # @param owner_type [String]
18568
18710
  # @param owner_object_id [String]
18569
- # @param if_match [String] CJSON hash of the container being reverted. Required; 428 when absent, 412 when stale.
18711
+ # @param if_match [String] CJSON hash of the container being reverted. Required while the container holds content; 428 when absent, 412 when stale. Leave it out when the container has been removed, since there is nothing to match.
18570
18712
  # @param container_revert_request [SfvbContainerRevertRequest] Version to revert the container to
18571
18713
  # @param [Hash] opts the optional parameters
18572
18714
  # @option opts [String] :container_name
@@ -18581,7 +18723,7 @@ module UltracartClient
18581
18723
  # @param storefront_oid [Integer]
18582
18724
  # @param owner_type [String]
18583
18725
  # @param owner_object_id [String]
18584
- # @param if_match [String] CJSON hash of the container being reverted. Required; 428 when absent, 412 when stale.
18726
+ # @param if_match [String] CJSON hash of the container being reverted. Required while the container holds content; 428 when absent, 412 when stale. Leave it out when the container has been removed, since there is nothing to match.
18585
18727
  # @param container_revert_request [SfvbContainerRevertRequest] Version to revert the container to
18586
18728
  # @param [Hash] opts the optional parameters
18587
18729
  # @option opts [String] :container_name
@@ -21445,6 +21587,84 @@ module UltracartClient
21445
21587
  return data, status_code, headers
21446
21588
  end
21447
21589
 
21590
+ # Change the storefront's faceted search configuration
21591
+ # A partial update. Turn facets on or off, change their headings, and replace the Cost facet's price breaks; facets left out and every other search setting are unchanged. Facets cannot be reordered - the order is fixed. Turning facets on or off, or changing the price breaks, starts a search index rebuild, reported in rebuild. dry_run checks the change and reports it, and the rebuild it would start, without saving. Needs sfvb_publish, because facets show on every search and category page at once.
21592
+ # @param storefront_oid [Integer]
21593
+ # @param search_facets_request [SfvbSearchFacetsRequest] The facets and price breaks to change
21594
+ # @param [Hash] opts the optional parameters
21595
+ # @option opts [String] :if_match hash_sha256 from the last read. Required unless dry_run; 428 when absent, 412 when stale.
21596
+ # @return [SfvbSearchFacetsResponse]
21597
+ def update_sfvb_search_facets(storefront_oid, search_facets_request, opts = {})
21598
+ data, _status_code, _headers = update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts)
21599
+ data
21600
+ end
21601
+
21602
+ # Change the storefront&#39;s faceted search configuration
21603
+ # A partial update. Turn facets on or off, change their headings, and replace the Cost facet&#39;s price breaks; facets left out and every other search setting are unchanged. Facets cannot be reordered - the order is fixed. Turning facets on or off, or changing the price breaks, starts a search index rebuild, reported in rebuild. dry_run checks the change and reports it, and the rebuild it would start, without saving. Needs sfvb_publish, because facets show on every search and category page at once.
21604
+ # @param storefront_oid [Integer]
21605
+ # @param search_facets_request [SfvbSearchFacetsRequest] The facets and price breaks to change
21606
+ # @param [Hash] opts the optional parameters
21607
+ # @option opts [String] :if_match hash_sha256 from the last read. Required unless dry_run; 428 when absent, 412 when stale.
21608
+ # @return [Array<(SfvbSearchFacetsResponse, Integer, Hash)>] SfvbSearchFacetsResponse data, response status code and response headers
21609
+ def update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts = {})
21610
+ if @api_client.config.debugging
21611
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_search_facets ...'
21612
+ end
21613
+ # verify the required parameter 'storefront_oid' is set
21614
+ if @api_client.config.client_side_validation && storefront_oid.nil?
21615
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_search_facets"
21616
+ end
21617
+ # verify the required parameter 'search_facets_request' is set
21618
+ if @api_client.config.client_side_validation && search_facets_request.nil?
21619
+ fail ArgumentError, "Missing the required parameter 'search_facets_request' when calling SfvbApi.update_sfvb_search_facets"
21620
+ end
21621
+ # resource path
21622
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/search/facets'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
21623
+
21624
+ # query parameters
21625
+ query_params = opts[:query_params] || {}
21626
+
21627
+ # header parameters
21628
+ header_params = opts[:header_params] || {}
21629
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
21630
+ # HTTP header 'Accept' (if needed)
21631
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
21632
+ # HTTP header 'Content-Type'
21633
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
21634
+ if !content_type.nil?
21635
+ header_params['Content-Type'] = content_type
21636
+ end
21637
+ header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
21638
+
21639
+ # form parameters
21640
+ form_params = opts[:form_params] || {}
21641
+
21642
+ # http body (model)
21643
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(search_facets_request)
21644
+
21645
+ # return_type
21646
+ return_type = opts[:debug_return_type] || 'SfvbSearchFacetsResponse'
21647
+
21648
+ # auth_names
21649
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
21650
+
21651
+ new_options = opts.merge(
21652
+ :operation => :"SfvbApi.update_sfvb_search_facets",
21653
+ :header_params => header_params,
21654
+ :query_params => query_params,
21655
+ :form_params => form_params,
21656
+ :body => post_body,
21657
+ :auth_names => auth_names,
21658
+ :return_type => return_type
21659
+ )
21660
+
21661
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
21662
+ if @api_client.config.debugging
21663
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_search_facets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
21664
+ end
21665
+ return data, status_code, headers
21666
+ end
21667
+
21448
21668
  # Change one step's settings or audience filter
21449
21669
  # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. An email step's audience filter changes here, but not its settings. Experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
21450
21670
  # @param storefront_oid [Integer]
@@ -283,7 +283,7 @@ module UltracartClient
283
283
  # Check to see if the all the properties in the model are valid
284
284
  # @return true if the model is valid
285
285
  def valid?
286
- action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "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_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
286
+ action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "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_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move"])
287
287
  return false unless action_validator.valid?(@action)
288
288
  true
289
289
  end
@@ -291,7 +291,7 @@ module UltracartClient
291
291
  # Custom attribute writer method checking allowed values (enum).
292
292
  # @param [Object] action Object to be assigned
293
293
  def action=(action)
294
- validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "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_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
294
+ validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "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_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move"])
295
295
  unless validator.valid?(action)
296
296
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
297
297
  end
@@ -48,9 +48,18 @@ module UltracartClient
48
48
  # For item.pricing, the item whose pricing changes.
49
49
  attr_accessor :merchant_item_oid
50
50
 
51
+ # For page.move, where the page goes, exactly as the move will send it. path is the page as it is now.
52
+ attr_accessor :new_path
53
+
54
+ # For page.move, how many pages move, the page itself included, when it was requested. Set by the server.
55
+ attr_accessor :pages_moved
56
+
51
57
  # The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it.
52
58
  attr_accessor :path
53
59
 
60
+ # For page.move, 301 when the move also redirects the old addresses, as the move will send it. Left out or none for no redirect.
61
+ attr_accessor :redirect_old_url
62
+
54
63
  # For experiment.start of a url experiment, the hash of the checked experiment approved, for item.pricing, tracking_provider.change and affiliate_network.change the hash of the change, and for smart_attribution.change the hash of the configuration the change would store. Set by the server. The gated call must send the same.
55
64
  attr_accessor :request_sha256
56
65
 
@@ -129,7 +138,10 @@ module UltracartClient
129
138
  :'experiment_oid' => :'experiment_oid',
130
139
  :'item_count' => :'item_count',
131
140
  :'merchant_item_oid' => :'merchant_item_oid',
141
+ :'new_path' => :'new_path',
142
+ :'pages_moved' => :'pages_moved',
132
143
  :'path' => :'path',
144
+ :'redirect_old_url' => :'redirect_old_url',
133
145
  :'request_sha256' => :'request_sha256',
134
146
  :'rows_sha256' => :'rows_sha256',
135
147
  :'rule_count' => :'rule_count',
@@ -166,7 +178,10 @@ module UltracartClient
166
178
  :'experiment_oid' => :'Integer',
167
179
  :'item_count' => :'Integer',
168
180
  :'merchant_item_oid' => :'Integer',
181
+ :'new_path' => :'String',
182
+ :'pages_moved' => :'Integer',
169
183
  :'path' => :'String',
184
+ :'redirect_old_url' => :'String',
170
185
  :'request_sha256' => :'String',
171
186
  :'rows_sha256' => :'String',
172
187
  :'rule_count' => :'Integer',
@@ -251,10 +266,22 @@ module UltracartClient
251
266
  self.merchant_item_oid = attributes[:'merchant_item_oid']
252
267
  end
253
268
 
269
+ if attributes.key?(:'new_path')
270
+ self.new_path = attributes[:'new_path']
271
+ end
272
+
273
+ if attributes.key?(:'pages_moved')
274
+ self.pages_moved = attributes[:'pages_moved']
275
+ end
276
+
254
277
  if attributes.key?(:'path')
255
278
  self.path = attributes[:'path']
256
279
  end
257
280
 
281
+ if attributes.key?(:'redirect_old_url')
282
+ self.redirect_old_url = attributes[:'redirect_old_url']
283
+ end
284
+
258
285
  if attributes.key?(:'request_sha256')
259
286
  self.request_sha256 = attributes[:'request_sha256']
260
287
  end
@@ -353,7 +380,10 @@ module UltracartClient
353
380
  experiment_oid == o.experiment_oid &&
354
381
  item_count == o.item_count &&
355
382
  merchant_item_oid == o.merchant_item_oid &&
383
+ new_path == o.new_path &&
384
+ pages_moved == o.pages_moved &&
356
385
  path == o.path &&
386
+ redirect_old_url == o.redirect_old_url &&
357
387
  request_sha256 == o.request_sha256 &&
358
388
  rows_sha256 == o.rows_sha256 &&
359
389
  rule_count == o.rule_count &&
@@ -379,7 +409,7 @@ module UltracartClient
379
409
  # Calculates hash code according to all attributes.
380
410
  # @return [Integer] Hash code
381
411
  def hash
382
- [affiliate_network_oid, after_step_uuid, attribute_names, blog_post_oid, branch_step_uuid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, side, slot, step_uuid, tracking_provider, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
412
+ [affiliate_network_oid, after_step_uuid, attribute_names, blog_post_oid, branch_step_uuid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, new_path, pages_moved, path, redirect_old_url, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, side, slot, step_uuid, tracking_provider, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
383
413
  end
384
414
 
385
415
  # Builds the object from hash