ultracart_api 4.1.185 → 4.1.190

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.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -2
  3. data/docs/SfvbApi.md +621 -0
  4. data/docs/SfvbI18nGlossary.md +24 -0
  5. data/docs/SfvbI18nGlossaryRequest.md +18 -0
  6. data/docs/SfvbI18nLanguage.md +30 -0
  7. data/docs/SfvbI18nLanguageEnableRequest.md +18 -0
  8. data/docs/SfvbI18nLanguagesResponse.md +32 -0
  9. data/docs/SfvbI18nMachineTranslationsResponse.md +28 -0
  10. data/docs/SfvbI18nMessage.md +30 -0
  11. data/docs/SfvbI18nMessageValue.md +20 -0
  12. data/docs/SfvbI18nMessageWriteRequest.md +18 -0
  13. data/docs/SfvbI18nMessagesResponse.md +28 -0
  14. data/docs/SfvbI18nResetResponse.md +22 -0
  15. data/docs/SfvbI18nTranslation.md +22 -0
  16. data/docs/SfvbLibraryAiReview.md +1 -1
  17. data/docs/SfvbLibraryContentManifest.md +4 -4
  18. data/docs/SfvbLibraryManifestFinding.md +22 -0
  19. data/docs/SfvbLibraryParameter.md +2 -2
  20. data/docs/SfvbLibraryTaxonomyCatalog.md +1 -1
  21. data/docs/SfvbLibraryTaxonomyDimension.md +22 -0
  22. data/docs/SfvbLibraryTaxonomyTag.md +20 -0
  23. data/lib/ultracart_api/api/sfvb_api.rb +860 -17
  24. data/lib/ultracart_api/models/sfvb_i18n_glossary.rb +250 -0
  25. data/lib/ultracart_api/models/sfvb_i18n_glossary_request.rb +220 -0
  26. data/lib/ultracart_api/models/sfvb_i18n_language.rb +282 -0
  27. data/lib/ultracart_api/models/sfvb_i18n_language_enable_request.rb +220 -0
  28. data/lib/ultracart_api/models/sfvb_i18n_languages_response.rb +292 -0
  29. data/lib/ultracart_api/models/sfvb_i18n_machine_translations_response.rb +272 -0
  30. data/lib/ultracart_api/models/sfvb_i18n_message.rb +282 -0
  31. data/lib/ultracart_api/models/sfvb_i18n_message_value.rb +230 -0
  32. data/lib/ultracart_api/models/sfvb_i18n_message_write_request.rb +222 -0
  33. data/lib/ultracart_api/models/sfvb_i18n_messages_response.rb +272 -0
  34. data/lib/ultracart_api/models/sfvb_i18n_reset_response.rb +240 -0
  35. data/lib/ultracart_api/models/sfvb_i18n_translation.rb +240 -0
  36. data/lib/ultracart_api/models/sfvb_library_ai_review.rb +4 -2
  37. data/lib/ultracart_api/models/sfvb_library_content_manifest.rb +16 -8
  38. data/lib/ultracart_api/models/sfvb_library_manifest_finding.rb +240 -0
  39. data/lib/ultracart_api/models/sfvb_library_parameter.rb +7 -7
  40. data/lib/ultracart_api/models/sfvb_library_taxonomy_catalog.rb +4 -2
  41. data/lib/ultracart_api/models/sfvb_library_taxonomy_dimension.rb +276 -0
  42. data/lib/ultracart_api/models/sfvb_library_taxonomy_tag.rb +230 -0
  43. data/lib/ultracart_api/version.rb +1 -1
  44. data/lib/ultracart_api.rb +15 -0
  45. metadata +32 -2
@@ -1305,6 +1305,83 @@ module UltracartClient
1305
1305
  return data, status_code, headers
1306
1306
  end
1307
1307
 
1308
+ # Disable a language
1309
+ # Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
1310
+ # @param storefront_oid [Integer]
1311
+ # @param code [String]
1312
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1313
+ # @param [Hash] opts the optional parameters
1314
+ # @return [SfvbI18nLanguagesResponse]
1315
+ def disable_sfvb_i18n_language(storefront_oid, code, if_match, opts = {})
1316
+ data, _status_code, _headers = disable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, opts)
1317
+ data
1318
+ end
1319
+
1320
+ # Disable a language
1321
+ # Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
1322
+ # @param storefront_oid [Integer]
1323
+ # @param code [String]
1324
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1325
+ # @param [Hash] opts the optional parameters
1326
+ # @return [Array<(SfvbI18nLanguagesResponse, Integer, Hash)>] SfvbI18nLanguagesResponse data, response status code and response headers
1327
+ def disable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, opts = {})
1328
+ if @api_client.config.debugging
1329
+ @api_client.config.logger.debug 'Calling API: SfvbApi.disable_sfvb_i18n_language ...'
1330
+ end
1331
+ # verify the required parameter 'storefront_oid' is set
1332
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1333
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.disable_sfvb_i18n_language"
1334
+ end
1335
+ # verify the required parameter 'code' is set
1336
+ if @api_client.config.client_side_validation && code.nil?
1337
+ fail ArgumentError, "Missing the required parameter 'code' when calling SfvbApi.disable_sfvb_i18n_language"
1338
+ end
1339
+ # verify the required parameter 'if_match' is set
1340
+ if @api_client.config.client_side_validation && if_match.nil?
1341
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.disable_sfvb_i18n_language"
1342
+ end
1343
+ # resource path
1344
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'code' + '}', CGI.escape(code.to_s))
1345
+
1346
+ # query parameters
1347
+ query_params = opts[:query_params] || {}
1348
+
1349
+ # header parameters
1350
+ header_params = opts[:header_params] || {}
1351
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1352
+ # HTTP header 'Accept' (if needed)
1353
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1354
+ header_params[:'If-Match'] = if_match
1355
+
1356
+ # form parameters
1357
+ form_params = opts[:form_params] || {}
1358
+
1359
+ # http body (model)
1360
+ post_body = opts[:debug_body]
1361
+
1362
+ # return_type
1363
+ return_type = opts[:debug_return_type] || 'SfvbI18nLanguagesResponse'
1364
+
1365
+ # auth_names
1366
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1367
+
1368
+ new_options = opts.merge(
1369
+ :operation => :"SfvbApi.disable_sfvb_i18n_language",
1370
+ :header_params => header_params,
1371
+ :query_params => query_params,
1372
+ :form_params => form_params,
1373
+ :body => post_body,
1374
+ :auth_names => auth_names,
1375
+ :return_type => return_type
1376
+ )
1377
+
1378
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1379
+ if @api_client.config.debugging
1380
+ @api_client.config.logger.debug "API called: SfvbApi#disable_sfvb_i18n_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1381
+ end
1382
+ return data, status_code, headers
1383
+ end
1384
+
1308
1385
  # Disable an upsell offer
1309
1386
  # Switches the offer off. Disabling one that is switched on is a live change and needs sfvb_publish. An offer that is already off is returned unchanged. There is no delete.
1310
1387
  # @param storefront_oid [Integer]
@@ -1888,6 +1965,94 @@ module UltracartClient
1888
1965
  return data, status_code, headers
1889
1966
  end
1890
1967
 
1968
+ # Enable a language
1969
+ # Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
1970
+ # @param storefront_oid [Integer]
1971
+ # @param code [String]
1972
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1973
+ # @param language_enable_request [SfvbI18nLanguageEnableRequest] The cost acknowledgement
1974
+ # @param [Hash] opts the optional parameters
1975
+ # @return [SfvbI18nLanguagesResponse]
1976
+ def enable_sfvb_i18n_language(storefront_oid, code, if_match, language_enable_request, opts = {})
1977
+ data, _status_code, _headers = enable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, language_enable_request, opts)
1978
+ data
1979
+ end
1980
+
1981
+ # Enable a language
1982
+ # Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
1983
+ # @param storefront_oid [Integer]
1984
+ # @param code [String]
1985
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1986
+ # @param language_enable_request [SfvbI18nLanguageEnableRequest] The cost acknowledgement
1987
+ # @param [Hash] opts the optional parameters
1988
+ # @return [Array<(SfvbI18nLanguagesResponse, Integer, Hash)>] SfvbI18nLanguagesResponse data, response status code and response headers
1989
+ def enable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, language_enable_request, opts = {})
1990
+ if @api_client.config.debugging
1991
+ @api_client.config.logger.debug 'Calling API: SfvbApi.enable_sfvb_i18n_language ...'
1992
+ end
1993
+ # verify the required parameter 'storefront_oid' is set
1994
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1995
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.enable_sfvb_i18n_language"
1996
+ end
1997
+ # verify the required parameter 'code' is set
1998
+ if @api_client.config.client_side_validation && code.nil?
1999
+ fail ArgumentError, "Missing the required parameter 'code' when calling SfvbApi.enable_sfvb_i18n_language"
2000
+ end
2001
+ # verify the required parameter 'if_match' is set
2002
+ if @api_client.config.client_side_validation && if_match.nil?
2003
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.enable_sfvb_i18n_language"
2004
+ end
2005
+ # verify the required parameter 'language_enable_request' is set
2006
+ if @api_client.config.client_side_validation && language_enable_request.nil?
2007
+ fail ArgumentError, "Missing the required parameter 'language_enable_request' when calling SfvbApi.enable_sfvb_i18n_language"
2008
+ end
2009
+ # resource path
2010
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'code' + '}', CGI.escape(code.to_s))
2011
+
2012
+ # query parameters
2013
+ query_params = opts[:query_params] || {}
2014
+
2015
+ # header parameters
2016
+ header_params = opts[:header_params] || {}
2017
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2018
+ # HTTP header 'Accept' (if needed)
2019
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2020
+ # HTTP header 'Content-Type'
2021
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
2022
+ if !content_type.nil?
2023
+ header_params['Content-Type'] = content_type
2024
+ end
2025
+ header_params[:'If-Match'] = if_match
2026
+
2027
+ # form parameters
2028
+ form_params = opts[:form_params] || {}
2029
+
2030
+ # http body (model)
2031
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(language_enable_request)
2032
+
2033
+ # return_type
2034
+ return_type = opts[:debug_return_type] || 'SfvbI18nLanguagesResponse'
2035
+
2036
+ # auth_names
2037
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2038
+
2039
+ new_options = opts.merge(
2040
+ :operation => :"SfvbApi.enable_sfvb_i18n_language",
2041
+ :header_params => header_params,
2042
+ :query_params => query_params,
2043
+ :form_params => form_params,
2044
+ :body => post_body,
2045
+ :auth_names => auth_names,
2046
+ :return_type => return_type
2047
+ )
2048
+
2049
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2050
+ if @api_client.config.debugging
2051
+ @api_client.config.logger.debug "API called: SfvbApi#enable_sfvb_i18n_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2052
+ end
2053
+ return data, status_code, headers
2054
+ end
2055
+
1891
2056
  # End an experiment
1892
2057
  # Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
1893
2058
  # @param storefront_oid [Integer]
@@ -2606,35 +2771,382 @@ module UltracartClient
2606
2771
  # @param storefront_oid [Integer]
2607
2772
  # @param extension [String]
2608
2773
  # @param [Hash] opts the optional parameters
2609
- # @return [SfvbFileUploadUrlResponse]
2610
- def get_sfvb_file_upload_url(storefront_oid, extension, opts = {})
2611
- data, _status_code, _headers = get_sfvb_file_upload_url_with_http_info(storefront_oid, extension, opts)
2774
+ # @return [SfvbFileUploadUrlResponse]
2775
+ def get_sfvb_file_upload_url(storefront_oid, extension, opts = {})
2776
+ data, _status_code, _headers = get_sfvb_file_upload_url_with_http_info(storefront_oid, extension, opts)
2777
+ data
2778
+ end
2779
+
2780
+ # Get a URL to upload a binary asset to
2781
+ # Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps. Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given. The bytes never pass through the API server. The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file. The URL is short lived and the key is bound to your account.
2782
+ # @param storefront_oid [Integer]
2783
+ # @param extension [String]
2784
+ # @param [Hash] opts the optional parameters
2785
+ # @return [Array<(SfvbFileUploadUrlResponse, Integer, Hash)>] SfvbFileUploadUrlResponse data, response status code and response headers
2786
+ def get_sfvb_file_upload_url_with_http_info(storefront_oid, extension, opts = {})
2787
+ if @api_client.config.debugging
2788
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_file_upload_url ...'
2789
+ end
2790
+ # verify the required parameter 'storefront_oid' is set
2791
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2792
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_file_upload_url"
2793
+ end
2794
+ # verify the required parameter 'extension' is set
2795
+ if @api_client.config.client_side_validation && extension.nil?
2796
+ fail ArgumentError, "Missing the required parameter 'extension' when calling SfvbApi.get_sfvb_file_upload_url"
2797
+ end
2798
+ # resource path
2799
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/files/upload_url/{extension}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'extension' + '}', CGI.escape(extension.to_s))
2800
+
2801
+ # query parameters
2802
+ query_params = opts[:query_params] || {}
2803
+
2804
+ # header parameters
2805
+ header_params = opts[:header_params] || {}
2806
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2807
+ # HTTP header 'Accept' (if needed)
2808
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2809
+
2810
+ # form parameters
2811
+ form_params = opts[:form_params] || {}
2812
+
2813
+ # http body (model)
2814
+ post_body = opts[:debug_body]
2815
+
2816
+ # return_type
2817
+ return_type = opts[:debug_return_type] || 'SfvbFileUploadUrlResponse'
2818
+
2819
+ # auth_names
2820
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2821
+
2822
+ new_options = opts.merge(
2823
+ :operation => :"SfvbApi.get_sfvb_file_upload_url",
2824
+ :header_params => header_params,
2825
+ :query_params => query_params,
2826
+ :form_params => form_params,
2827
+ :body => post_body,
2828
+ :auth_names => auth_names,
2829
+ :return_type => return_type
2830
+ )
2831
+
2832
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2833
+ if @api_client.config.debugging
2834
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_file_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2835
+ end
2836
+ return data, status_code, headers
2837
+ end
2838
+
2839
+ # Read the storefront's translation glossary
2840
+ # The storefront's glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
2841
+ # @param storefront_oid [Integer]
2842
+ # @param [Hash] opts the optional parameters
2843
+ # @return [SfvbI18nGlossary]
2844
+ def get_sfvb_i18n_glossary(storefront_oid, opts = {})
2845
+ data, _status_code, _headers = get_sfvb_i18n_glossary_with_http_info(storefront_oid, opts)
2846
+ data
2847
+ end
2848
+
2849
+ # Read the storefront&#39;s translation glossary
2850
+ # The storefront&#39;s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
2851
+ # @param storefront_oid [Integer]
2852
+ # @param [Hash] opts the optional parameters
2853
+ # @return [Array<(SfvbI18nGlossary, Integer, Hash)>] SfvbI18nGlossary data, response status code and response headers
2854
+ def get_sfvb_i18n_glossary_with_http_info(storefront_oid, opts = {})
2855
+ if @api_client.config.debugging
2856
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_i18n_glossary ...'
2857
+ end
2858
+ # verify the required parameter 'storefront_oid' is set
2859
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2860
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_i18n_glossary"
2861
+ end
2862
+ # resource path
2863
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/glossary'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
2864
+
2865
+ # query parameters
2866
+ query_params = opts[:query_params] || {}
2867
+
2868
+ # header parameters
2869
+ header_params = opts[:header_params] || {}
2870
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2871
+ # HTTP header 'Accept' (if needed)
2872
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2873
+
2874
+ # form parameters
2875
+ form_params = opts[:form_params] || {}
2876
+
2877
+ # http body (model)
2878
+ post_body = opts[:debug_body]
2879
+
2880
+ # return_type
2881
+ return_type = opts[:debug_return_type] || 'SfvbI18nGlossary'
2882
+
2883
+ # auth_names
2884
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2885
+
2886
+ new_options = opts.merge(
2887
+ :operation => :"SfvbApi.get_sfvb_i18n_glossary",
2888
+ :header_params => header_params,
2889
+ :query_params => query_params,
2890
+ :form_params => form_params,
2891
+ :body => post_body,
2892
+ :auth_names => auth_names,
2893
+ :return_type => return_type
2894
+ )
2895
+
2896
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2897
+ if @api_client.config.debugging
2898
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_i18n_glossary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2899
+ end
2900
+ return data, status_code, headers
2901
+ end
2902
+
2903
+ # List a storefront's languages
2904
+ # Every language the storefront can be translated into, with UltraCart's three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
2905
+ # @param storefront_oid [Integer]
2906
+ # @param [Hash] opts the optional parameters
2907
+ # @return [SfvbI18nLanguagesResponse]
2908
+ def get_sfvb_i18n_languages(storefront_oid, opts = {})
2909
+ data, _status_code, _headers = get_sfvb_i18n_languages_with_http_info(storefront_oid, opts)
2910
+ data
2911
+ end
2912
+
2913
+ # List a storefront&#39;s languages
2914
+ # Every language the storefront can be translated into, with UltraCart&#39;s three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
2915
+ # @param storefront_oid [Integer]
2916
+ # @param [Hash] opts the optional parameters
2917
+ # @return [Array<(SfvbI18nLanguagesResponse, Integer, Hash)>] SfvbI18nLanguagesResponse data, response status code and response headers
2918
+ def get_sfvb_i18n_languages_with_http_info(storefront_oid, opts = {})
2919
+ if @api_client.config.debugging
2920
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_i18n_languages ...'
2921
+ end
2922
+ # verify the required parameter 'storefront_oid' is set
2923
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2924
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_i18n_languages"
2925
+ end
2926
+ # resource path
2927
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/languages'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
2928
+
2929
+ # query parameters
2930
+ query_params = opts[:query_params] || {}
2931
+
2932
+ # header parameters
2933
+ header_params = opts[:header_params] || {}
2934
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2935
+ # HTTP header 'Accept' (if needed)
2936
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2937
+
2938
+ # form parameters
2939
+ form_params = opts[:form_params] || {}
2940
+
2941
+ # http body (model)
2942
+ post_body = opts[:debug_body]
2943
+
2944
+ # return_type
2945
+ return_type = opts[:debug_return_type] || 'SfvbI18nLanguagesResponse'
2946
+
2947
+ # auth_names
2948
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2949
+
2950
+ new_options = opts.merge(
2951
+ :operation => :"SfvbApi.get_sfvb_i18n_languages",
2952
+ :header_params => header_params,
2953
+ :query_params => query_params,
2954
+ :form_params => form_params,
2955
+ :body => post_body,
2956
+ :auth_names => auth_names,
2957
+ :return_type => return_type
2958
+ )
2959
+
2960
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2961
+ if @api_client.config.debugging
2962
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_i18n_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2963
+ end
2964
+ return data, status_code, headers
2965
+ end
2966
+
2967
+ # Read where a widget setting's translations come from
2968
+ # For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language's text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
2969
+ # @param storefront_oid [Integer]
2970
+ # @param [Hash] opts the optional parameters
2971
+ # @option opts [Integer] :theme_oid
2972
+ # @option opts [String] :widget_id
2973
+ # @option opts [String] :property
2974
+ # @return [SfvbI18nMachineTranslationsResponse]
2975
+ def get_sfvb_i18n_machine_translations(storefront_oid, opts = {})
2976
+ data, _status_code, _headers = get_sfvb_i18n_machine_translations_with_http_info(storefront_oid, opts)
2977
+ data
2978
+ end
2979
+
2980
+ # Read where a widget setting&#39;s translations come from
2981
+ # For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language&#39;s text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
2982
+ # @param storefront_oid [Integer]
2983
+ # @param [Hash] opts the optional parameters
2984
+ # @option opts [Integer] :theme_oid
2985
+ # @option opts [String] :widget_id
2986
+ # @option opts [String] :property
2987
+ # @return [Array<(SfvbI18nMachineTranslationsResponse, Integer, Hash)>] SfvbI18nMachineTranslationsResponse data, response status code and response headers
2988
+ def get_sfvb_i18n_machine_translations_with_http_info(storefront_oid, opts = {})
2989
+ if @api_client.config.debugging
2990
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_i18n_machine_translations ...'
2991
+ end
2992
+ # verify the required parameter 'storefront_oid' is set
2993
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2994
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_i18n_machine_translations"
2995
+ end
2996
+ # resource path
2997
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/machine_translations'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
2998
+
2999
+ # query parameters
3000
+ query_params = opts[:query_params] || {}
3001
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
3002
+ query_params[:'widget_id'] = opts[:'widget_id'] if !opts[:'widget_id'].nil?
3003
+ query_params[:'property'] = opts[:'property'] if !opts[:'property'].nil?
3004
+
3005
+ # header parameters
3006
+ header_params = opts[:header_params] || {}
3007
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3008
+ # HTTP header 'Accept' (if needed)
3009
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3010
+
3011
+ # form parameters
3012
+ form_params = opts[:form_params] || {}
3013
+
3014
+ # http body (model)
3015
+ post_body = opts[:debug_body]
3016
+
3017
+ # return_type
3018
+ return_type = opts[:debug_return_type] || 'SfvbI18nMachineTranslationsResponse'
3019
+
3020
+ # auth_names
3021
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3022
+
3023
+ new_options = opts.merge(
3024
+ :operation => :"SfvbApi.get_sfvb_i18n_machine_translations",
3025
+ :header_params => header_params,
3026
+ :query_params => query_params,
3027
+ :form_params => form_params,
3028
+ :body => post_body,
3029
+ :auth_names => auth_names,
3030
+ :return_type => return_type
3031
+ )
3032
+
3033
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3034
+ if @api_client.config.debugging
3035
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_i18n_machine_translations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3036
+ end
3037
+ return data, status_code, headers
3038
+ end
3039
+
3040
+ # Read one built-in message
3041
+ # One message by key, with the hash_sha256 a set or reset sends back.
3042
+ # @param storefront_oid [Integer]
3043
+ # @param key [String]
3044
+ # @param [Hash] opts the optional parameters
3045
+ # @option opts [Integer] :theme_oid
3046
+ # @return [SfvbI18nMessage]
3047
+ def get_sfvb_i18n_message(storefront_oid, key, opts = {})
3048
+ data, _status_code, _headers = get_sfvb_i18n_message_with_http_info(storefront_oid, key, opts)
3049
+ data
3050
+ end
3051
+
3052
+ # Read one built-in message
3053
+ # One message by key, with the hash_sha256 a set or reset sends back.
3054
+ # @param storefront_oid [Integer]
3055
+ # @param key [String]
3056
+ # @param [Hash] opts the optional parameters
3057
+ # @option opts [Integer] :theme_oid
3058
+ # @return [Array<(SfvbI18nMessage, Integer, Hash)>] SfvbI18nMessage data, response status code and response headers
3059
+ def get_sfvb_i18n_message_with_http_info(storefront_oid, key, opts = {})
3060
+ if @api_client.config.debugging
3061
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_i18n_message ...'
3062
+ end
3063
+ # verify the required parameter 'storefront_oid' is set
3064
+ if @api_client.config.client_side_validation && storefront_oid.nil?
3065
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_i18n_message"
3066
+ end
3067
+ # verify the required parameter 'key' is set
3068
+ if @api_client.config.client_side_validation && key.nil?
3069
+ fail ArgumentError, "Missing the required parameter 'key' when calling SfvbApi.get_sfvb_i18n_message"
3070
+ end
3071
+ # resource path
3072
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/messages/{key}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
3073
+
3074
+ # query parameters
3075
+ query_params = opts[:query_params] || {}
3076
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
3077
+
3078
+ # header parameters
3079
+ header_params = opts[:header_params] || {}
3080
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3081
+ # HTTP header 'Accept' (if needed)
3082
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3083
+
3084
+ # form parameters
3085
+ form_params = opts[:form_params] || {}
3086
+
3087
+ # http body (model)
3088
+ post_body = opts[:debug_body]
3089
+
3090
+ # return_type
3091
+ return_type = opts[:debug_return_type] || 'SfvbI18nMessage'
3092
+
3093
+ # auth_names
3094
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3095
+
3096
+ new_options = opts.merge(
3097
+ :operation => :"SfvbApi.get_sfvb_i18n_message",
3098
+ :header_params => header_params,
3099
+ :query_params => query_params,
3100
+ :form_params => form_params,
3101
+ :body => post_body,
3102
+ :auth_names => auth_names,
3103
+ :return_type => return_type
3104
+ )
3105
+
3106
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3107
+ if @api_client.config.debugging
3108
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_i18n_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3109
+ end
3110
+ return data, status_code, headers
3111
+ end
3112
+
3113
+ # Read where a message's translations come from
3114
+ # For one message, each enabled language's text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
3115
+ # @param storefront_oid [Integer]
3116
+ # @param key [String]
3117
+ # @param [Hash] opts the optional parameters
3118
+ # @option opts [Integer] :theme_oid
3119
+ # @return [SfvbI18nMachineTranslationsResponse]
3120
+ def get_sfvb_i18n_message_machine_translations(storefront_oid, key, opts = {})
3121
+ data, _status_code, _headers = get_sfvb_i18n_message_machine_translations_with_http_info(storefront_oid, key, opts)
2612
3122
  data
2613
3123
  end
2614
3124
 
2615
- # Get a URL to upload a binary asset to
2616
- # Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps. Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given. The bytes never pass through the API server. The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file. The URL is short lived and the key is bound to your account.
3125
+ # Read where a message&#39;s translations come from
3126
+ # For one message, each enabled language&#39;s text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
2617
3127
  # @param storefront_oid [Integer]
2618
- # @param extension [String]
3128
+ # @param key [String]
2619
3129
  # @param [Hash] opts the optional parameters
2620
- # @return [Array<(SfvbFileUploadUrlResponse, Integer, Hash)>] SfvbFileUploadUrlResponse data, response status code and response headers
2621
- def get_sfvb_file_upload_url_with_http_info(storefront_oid, extension, opts = {})
3130
+ # @option opts [Integer] :theme_oid
3131
+ # @return [Array<(SfvbI18nMachineTranslationsResponse, Integer, Hash)>] SfvbI18nMachineTranslationsResponse data, response status code and response headers
3132
+ def get_sfvb_i18n_message_machine_translations_with_http_info(storefront_oid, key, opts = {})
2622
3133
  if @api_client.config.debugging
2623
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_file_upload_url ...'
3134
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_i18n_message_machine_translations ...'
2624
3135
  end
2625
3136
  # verify the required parameter 'storefront_oid' is set
2626
3137
  if @api_client.config.client_side_validation && storefront_oid.nil?
2627
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_file_upload_url"
3138
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_i18n_message_machine_translations"
2628
3139
  end
2629
- # verify the required parameter 'extension' is set
2630
- if @api_client.config.client_side_validation && extension.nil?
2631
- fail ArgumentError, "Missing the required parameter 'extension' when calling SfvbApi.get_sfvb_file_upload_url"
3140
+ # verify the required parameter 'key' is set
3141
+ if @api_client.config.client_side_validation && key.nil?
3142
+ fail ArgumentError, "Missing the required parameter 'key' when calling SfvbApi.get_sfvb_i18n_message_machine_translations"
2632
3143
  end
2633
3144
  # resource path
2634
- local_var_path = '/sfvb/storefronts/{storefront_oid}/files/upload_url/{extension}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'extension' + '}', CGI.escape(extension.to_s))
3145
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
2635
3146
 
2636
3147
  # query parameters
2637
3148
  query_params = opts[:query_params] || {}
3149
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
2638
3150
 
2639
3151
  # header parameters
2640
3152
  header_params = opts[:header_params] || {}
@@ -2649,13 +3161,13 @@ module UltracartClient
2649
3161
  post_body = opts[:debug_body]
2650
3162
 
2651
3163
  # return_type
2652
- return_type = opts[:debug_return_type] || 'SfvbFileUploadUrlResponse'
3164
+ return_type = opts[:debug_return_type] || 'SfvbI18nMachineTranslationsResponse'
2653
3165
 
2654
3166
  # auth_names
2655
3167
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2656
3168
 
2657
3169
  new_options = opts.merge(
2658
- :operation => :"SfvbApi.get_sfvb_file_upload_url",
3170
+ :operation => :"SfvbApi.get_sfvb_i18n_message_machine_translations",
2659
3171
  :header_params => header_params,
2660
3172
  :query_params => query_params,
2661
3173
  :form_params => form_params,
@@ -2666,7 +3178,7 @@ module UltracartClient
2666
3178
 
2667
3179
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2668
3180
  if @api_client.config.debugging
2669
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_file_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3181
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_i18n_message_machine_translations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2670
3182
  end
2671
3183
  return data, status_code, headers
2672
3184
  end
@@ -5135,6 +5647,88 @@ module UltracartClient
5135
5647
  return data, status_code, headers
5136
5648
  end
5137
5649
 
5650
+ # List built-in messages
5651
+ # The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language's text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
5652
+ # @param storefront_oid [Integer]
5653
+ # @param [Hash] opts the optional parameters
5654
+ # @option opts [Integer] :theme_oid
5655
+ # @option opts [String] :q
5656
+ # @option opts [String] :language
5657
+ # @option opts [Boolean] :overridden
5658
+ # @option opts [Integer] :offset
5659
+ # @option opts [Integer] :limit
5660
+ # @return [SfvbI18nMessagesResponse]
5661
+ def list_sfvb_i18n_messages(storefront_oid, opts = {})
5662
+ data, _status_code, _headers = list_sfvb_i18n_messages_with_http_info(storefront_oid, opts)
5663
+ data
5664
+ end
5665
+
5666
+ # List built-in messages
5667
+ # The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language&#39;s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
5668
+ # @param storefront_oid [Integer]
5669
+ # @param [Hash] opts the optional parameters
5670
+ # @option opts [Integer] :theme_oid
5671
+ # @option opts [String] :q
5672
+ # @option opts [String] :language
5673
+ # @option opts [Boolean] :overridden
5674
+ # @option opts [Integer] :offset
5675
+ # @option opts [Integer] :limit
5676
+ # @return [Array<(SfvbI18nMessagesResponse, Integer, Hash)>] SfvbI18nMessagesResponse data, response status code and response headers
5677
+ def list_sfvb_i18n_messages_with_http_info(storefront_oid, opts = {})
5678
+ if @api_client.config.debugging
5679
+ @api_client.config.logger.debug 'Calling API: SfvbApi.list_sfvb_i18n_messages ...'
5680
+ end
5681
+ # verify the required parameter 'storefront_oid' is set
5682
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5683
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.list_sfvb_i18n_messages"
5684
+ end
5685
+ # resource path
5686
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/messages'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5687
+
5688
+ # query parameters
5689
+ query_params = opts[:query_params] || {}
5690
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
5691
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
5692
+ query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
5693
+ query_params[:'overridden'] = opts[:'overridden'] if !opts[:'overridden'].nil?
5694
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
5695
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
5696
+
5697
+ # header parameters
5698
+ header_params = opts[:header_params] || {}
5699
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5700
+ # HTTP header 'Accept' (if needed)
5701
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5702
+
5703
+ # form parameters
5704
+ form_params = opts[:form_params] || {}
5705
+
5706
+ # http body (model)
5707
+ post_body = opts[:debug_body]
5708
+
5709
+ # return_type
5710
+ return_type = opts[:debug_return_type] || 'SfvbI18nMessagesResponse'
5711
+
5712
+ # auth_names
5713
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5714
+
5715
+ new_options = opts.merge(
5716
+ :operation => :"SfvbApi.list_sfvb_i18n_messages",
5717
+ :header_params => header_params,
5718
+ :query_params => query_params,
5719
+ :form_params => form_params,
5720
+ :body => post_body,
5721
+ :auth_names => auth_names,
5722
+ :return_type => return_type
5723
+ )
5724
+
5725
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5726
+ if @api_client.config.debugging
5727
+ @api_client.config.logger.debug "API called: SfvbApi#list_sfvb_i18n_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5728
+ end
5729
+ return data, status_code, headers
5730
+ end
5731
+
5138
5732
  # List the item containers on the account
5139
5733
  # An itemcontainer element renders nothing of its own. It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers. This says which of them exist. Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has. Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist. Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first. Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller's storefront but does not narrow the result.
5140
5734
  # @param storefront_oid [Integer]
@@ -6213,6 +6807,175 @@ module UltracartClient
6213
6807
  return data, status_code, headers
6214
6808
  end
6215
6809
 
6810
+ # Replace the storefront's translation glossary
6811
+ # Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
6812
+ # @param storefront_oid [Integer]
6813
+ # @param glossary_request [SfvbI18nGlossaryRequest] The glossary
6814
+ # @param [Hash] opts the optional parameters
6815
+ # @option opts [String] :if_match hash_sha256 from the last read. Not needed for the first save; otherwise 428 when absent, 412 when stale.
6816
+ # @return [SfvbI18nGlossary]
6817
+ def put_sfvb_i18n_glossary(storefront_oid, glossary_request, opts = {})
6818
+ data, _status_code, _headers = put_sfvb_i18n_glossary_with_http_info(storefront_oid, glossary_request, opts)
6819
+ data
6820
+ end
6821
+
6822
+ # Replace the storefront&#39;s translation glossary
6823
+ # Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
6824
+ # @param storefront_oid [Integer]
6825
+ # @param glossary_request [SfvbI18nGlossaryRequest] The glossary
6826
+ # @param [Hash] opts the optional parameters
6827
+ # @option opts [String] :if_match hash_sha256 from the last read. Not needed for the first save; otherwise 428 when absent, 412 when stale.
6828
+ # @return [Array<(SfvbI18nGlossary, Integer, Hash)>] SfvbI18nGlossary data, response status code and response headers
6829
+ def put_sfvb_i18n_glossary_with_http_info(storefront_oid, glossary_request, opts = {})
6830
+ if @api_client.config.debugging
6831
+ @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_i18n_glossary ...'
6832
+ end
6833
+ # verify the required parameter 'storefront_oid' is set
6834
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6835
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_i18n_glossary"
6836
+ end
6837
+ # verify the required parameter 'glossary_request' is set
6838
+ if @api_client.config.client_side_validation && glossary_request.nil?
6839
+ fail ArgumentError, "Missing the required parameter 'glossary_request' when calling SfvbApi.put_sfvb_i18n_glossary"
6840
+ end
6841
+ # resource path
6842
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/glossary'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
6843
+
6844
+ # query parameters
6845
+ query_params = opts[:query_params] || {}
6846
+
6847
+ # header parameters
6848
+ header_params = opts[:header_params] || {}
6849
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6850
+ # HTTP header 'Accept' (if needed)
6851
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6852
+ # HTTP header 'Content-Type'
6853
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
6854
+ if !content_type.nil?
6855
+ header_params['Content-Type'] = content_type
6856
+ end
6857
+ header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
6858
+
6859
+ # form parameters
6860
+ form_params = opts[:form_params] || {}
6861
+
6862
+ # http body (model)
6863
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(glossary_request)
6864
+
6865
+ # return_type
6866
+ return_type = opts[:debug_return_type] || 'SfvbI18nGlossary'
6867
+
6868
+ # auth_names
6869
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6870
+
6871
+ new_options = opts.merge(
6872
+ :operation => :"SfvbApi.put_sfvb_i18n_glossary",
6873
+ :header_params => header_params,
6874
+ :query_params => query_params,
6875
+ :form_params => form_params,
6876
+ :body => post_body,
6877
+ :auth_names => auth_names,
6878
+ :return_type => return_type
6879
+ )
6880
+
6881
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
6882
+ if @api_client.config.debugging
6883
+ @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_i18n_glossary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6884
+ end
6885
+ return data, status_code, headers
6886
+ end
6887
+
6888
+ # Change one built-in message
6889
+ # Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone; empty text is refused. Shoppers see it at once. Always needs sfvb_publish.
6890
+ # @param storefront_oid [Integer]
6891
+ # @param key [String]
6892
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
6893
+ # @param message_write_request [SfvbI18nMessageWriteRequest] The languages to change
6894
+ # @param [Hash] opts the optional parameters
6895
+ # @option opts [Integer] :theme_oid
6896
+ # @return [SfvbI18nMessage]
6897
+ def put_sfvb_i18n_message(storefront_oid, key, if_match, message_write_request, opts = {})
6898
+ data, _status_code, _headers = put_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, message_write_request, opts)
6899
+ data
6900
+ end
6901
+
6902
+ # Change one built-in message
6903
+ # Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone; empty text is refused. Shoppers see it at once. Always needs sfvb_publish.
6904
+ # @param storefront_oid [Integer]
6905
+ # @param key [String]
6906
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
6907
+ # @param message_write_request [SfvbI18nMessageWriteRequest] The languages to change
6908
+ # @param [Hash] opts the optional parameters
6909
+ # @option opts [Integer] :theme_oid
6910
+ # @return [Array<(SfvbI18nMessage, Integer, Hash)>] SfvbI18nMessage data, response status code and response headers
6911
+ def put_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, message_write_request, opts = {})
6912
+ if @api_client.config.debugging
6913
+ @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_i18n_message ...'
6914
+ end
6915
+ # verify the required parameter 'storefront_oid' is set
6916
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6917
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_i18n_message"
6918
+ end
6919
+ # verify the required parameter 'key' is set
6920
+ if @api_client.config.client_side_validation && key.nil?
6921
+ fail ArgumentError, "Missing the required parameter 'key' when calling SfvbApi.put_sfvb_i18n_message"
6922
+ end
6923
+ # verify the required parameter 'if_match' is set
6924
+ if @api_client.config.client_side_validation && if_match.nil?
6925
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.put_sfvb_i18n_message"
6926
+ end
6927
+ # verify the required parameter 'message_write_request' is set
6928
+ if @api_client.config.client_side_validation && message_write_request.nil?
6929
+ fail ArgumentError, "Missing the required parameter 'message_write_request' when calling SfvbApi.put_sfvb_i18n_message"
6930
+ end
6931
+ # resource path
6932
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/messages/{key}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
6933
+
6934
+ # query parameters
6935
+ query_params = opts[:query_params] || {}
6936
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
6937
+
6938
+ # header parameters
6939
+ header_params = opts[:header_params] || {}
6940
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6941
+ # HTTP header 'Accept' (if needed)
6942
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6943
+ # HTTP header 'Content-Type'
6944
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
6945
+ if !content_type.nil?
6946
+ header_params['Content-Type'] = content_type
6947
+ end
6948
+ header_params[:'If-Match'] = if_match
6949
+
6950
+ # form parameters
6951
+ form_params = opts[:form_params] || {}
6952
+
6953
+ # http body (model)
6954
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(message_write_request)
6955
+
6956
+ # return_type
6957
+ return_type = opts[:debug_return_type] || 'SfvbI18nMessage'
6958
+
6959
+ # auth_names
6960
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6961
+
6962
+ new_options = opts.merge(
6963
+ :operation => :"SfvbApi.put_sfvb_i18n_message",
6964
+ :header_params => header_params,
6965
+ :query_params => query_params,
6966
+ :form_params => form_params,
6967
+ :body => post_body,
6968
+ :auth_names => auth_names,
6969
+ :return_type => return_type
6970
+ )
6971
+
6972
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
6973
+ if @api_client.config.debugging
6974
+ @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_i18n_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6975
+ end
6976
+ return data, status_code, headers
6977
+ end
6978
+
6216
6979
  # Change some of an item's attributes
6217
6980
  # Partial - only the attributes named change, and an empty value empties one but keeps it on the item. To remove an attribute no template declares, use the attribute DELETE. Every entry is validated before any is written, so a refusal leaves the item untouched. The list types are checked against the shape their renderer actually parses, which matters more than it sounds: a definition list is a bare array with one letter keys, a video list is a wrapper object with keys spelled out, and an item set is comma separated text rather than JSON. A shape the renderer cannot read is not reported at render time - it renders exactly like an attribute nobody ever set.
6218
6981
  # @param storefront_oid [Integer]
@@ -7651,6 +8414,86 @@ module UltracartClient
7651
8414
  return data, status_code, headers
7652
8415
  end
7653
8416
 
8417
+ # Reset one built-in message
8418
+ # Puts a message back to the template's text. The merchant's English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme's locale file is refused. Always needs sfvb_publish.
8419
+ # @param storefront_oid [Integer]
8420
+ # @param key [String]
8421
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
8422
+ # @param [Hash] opts the optional parameters
8423
+ # @option opts [Integer] :theme_oid
8424
+ # @return [SfvbI18nResetResponse]
8425
+ def reset_sfvb_i18n_message(storefront_oid, key, if_match, opts = {})
8426
+ data, _status_code, _headers = reset_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, opts)
8427
+ data
8428
+ end
8429
+
8430
+ # Reset one built-in message
8431
+ # Puts a message back to the template&#39;s text. The merchant&#39;s English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme&#39;s locale file is refused. Always needs sfvb_publish.
8432
+ # @param storefront_oid [Integer]
8433
+ # @param key [String]
8434
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
8435
+ # @param [Hash] opts the optional parameters
8436
+ # @option opts [Integer] :theme_oid
8437
+ # @return [Array<(SfvbI18nResetResponse, Integer, Hash)>] SfvbI18nResetResponse data, response status code and response headers
8438
+ def reset_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, opts = {})
8439
+ if @api_client.config.debugging
8440
+ @api_client.config.logger.debug 'Calling API: SfvbApi.reset_sfvb_i18n_message ...'
8441
+ end
8442
+ # verify the required parameter 'storefront_oid' is set
8443
+ if @api_client.config.client_side_validation && storefront_oid.nil?
8444
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.reset_sfvb_i18n_message"
8445
+ end
8446
+ # verify the required parameter 'key' is set
8447
+ if @api_client.config.client_side_validation && key.nil?
8448
+ fail ArgumentError, "Missing the required parameter 'key' when calling SfvbApi.reset_sfvb_i18n_message"
8449
+ end
8450
+ # verify the required parameter 'if_match' is set
8451
+ if @api_client.config.client_side_validation && if_match.nil?
8452
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.reset_sfvb_i18n_message"
8453
+ end
8454
+ # resource path
8455
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/i18n/messages/{key}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
8456
+
8457
+ # query parameters
8458
+ query_params = opts[:query_params] || {}
8459
+ query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
8460
+
8461
+ # header parameters
8462
+ header_params = opts[:header_params] || {}
8463
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
8464
+ # HTTP header 'Accept' (if needed)
8465
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8466
+ header_params[:'If-Match'] = if_match
8467
+
8468
+ # form parameters
8469
+ form_params = opts[:form_params] || {}
8470
+
8471
+ # http body (model)
8472
+ post_body = opts[:debug_body]
8473
+
8474
+ # return_type
8475
+ return_type = opts[:debug_return_type] || 'SfvbI18nResetResponse'
8476
+
8477
+ # auth_names
8478
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8479
+
8480
+ new_options = opts.merge(
8481
+ :operation => :"SfvbApi.reset_sfvb_i18n_message",
8482
+ :header_params => header_params,
8483
+ :query_params => query_params,
8484
+ :form_params => form_params,
8485
+ :body => post_body,
8486
+ :auth_names => auth_names,
8487
+ :return_type => return_type
8488
+ )
8489
+
8490
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
8491
+ if @api_client.config.debugging
8492
+ @api_client.config.logger.debug "API called: SfvbApi#reset_sfvb_i18n_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8493
+ end
8494
+ return data, status_code, headers
8495
+ end
8496
+
7654
8497
  # Resolve a template name to the file a page renders
7655
8498
  # 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.
7656
8499
  # @param storefront_oid [Integer]