ultracart_api 4.1.179 → 4.1.181

data/docs/SfvbRecordingSettingsResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbRecordingSettingsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **changed** | **Boolean** | On a change only.  False when recording was already in the requested state, so nothing was saved. | [optional] |
+| **settings** | [**SfvbRecordingSettings**](SfvbRecordingSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingSettingsResponse.new(
+  changed: null,
+  settings: null
+)
+```
+

data/lib/ultracart_api/api/auto_order_api.rb

@@ -647,6 +647,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Generate an auto order update billing url
+    # Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email. 
+    # @param auto_order_oid [Integer] The auto order oid to generate the update billing url for.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderAutoOrderUpdateBillingUrlResponse]
+    def get_auto_order_update_billing_url(auto_order_oid, opts = {})
+      data, _status_code, _headers = get_auto_order_update_billing_url_with_http_info(auto_order_oid, opts)
+      data
+    end
+
+    # Generate an auto order update billing url
+    # Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email. 
+    # @param auto_order_oid [Integer] The auto order oid to generate the update billing url for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderAutoOrderUpdateBillingUrlResponse, Integer, Hash)>] OrderAutoOrderUpdateBillingUrlResponse data, response status code and response headers
+    def get_auto_order_update_billing_url_with_http_info(auto_order_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.get_auto_order_update_billing_url ...'
+      end
+      # verify the required parameter 'auto_order_oid' is set
+      if @api_client.config.client_side_validation && auto_order_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.get_auto_order_update_billing_url"
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/{auto_order_oid}/update_billing_url'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderAutoOrderUpdateBillingUrlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AutoOrderApi.get_auto_order_update_billing_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutoOrderApi#get_auto_order_update_billing_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve auto orders
     # Retrieves auto orders from the account.  If no parameters are specified, all auto orders will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/order_api.rb

@@ -102,6 +102,84 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Associates an RMA with an order
+    # Associates an RMA number with an order.  Any existing RMA on the order is replaced. 
+    # @param order_id [String] The order id to associate the RMA with.
+    # @param assign_rma_request [OrderAssignRmaRequest] Assign RMA request
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [OrderResponse]
+    def assign_rma(order_id, assign_rma_request, opts = {})
+      data, _status_code, _headers = assign_rma_with_http_info(order_id, assign_rma_request, opts)
+      data
+    end
+
+    # Associates an RMA with an order
+    # Associates an RMA number with an order.  Any existing RMA on the order is replaced. 
+    # @param order_id [String] The order id to associate the RMA with.
+    # @param assign_rma_request [OrderAssignRmaRequest] Assign RMA request
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    def assign_rma_with_http_info(order_id, assign_rma_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.assign_rma ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.assign_rma"
+      end
+      # verify the required parameter 'assign_rma_request' is set
+      if @api_client.config.client_side_validation && assign_rma_request.nil?
+        fail ArgumentError, "Missing the required parameter 'assign_rma_request' when calling OrderApi.assign_rma"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/rma'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(assign_rma_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.assign_rma",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#assign_rma\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Assigns an order to an affiliate
     # Assigns an order to an affiliate. 
     # @param order_id [String] The order id to assign to the affiliate.
@@ -1810,6 +1888,137 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve orders by RMA
+    # Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted. 
+    # @param rma [String] The RMA number to search for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [OrdersResponse]
+    def get_orders_by_rma(rma, opts = {})
+      data, _status_code, _headers = get_orders_by_rma_with_http_info(rma, opts)
+      data
+    end
+
+    # Retrieve orders by RMA
+    # Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted. 
+    # @param rma [String] The RMA number to search for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
+    def get_orders_by_rma_with_http_info(rma, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_rma ...'
+      end
+      # verify the required parameter 'rma' is set
+      if @api_client.config.client_side_validation && rma.nil?
+        fail ArgumentError, "Missing the required parameter 'rma' when calling OrderApi.get_orders_by_rma"
+      end
+      # resource path
+      local_var_path = '/order/orders/rma/{rma}'.sub('{' + 'rma' + '}', CGI.escape(rma.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrdersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_orders_by_rma",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#get_orders_by_rma\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generate an auto order update billing url
+    # Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email. 
+    # @param order_id [String] The order id to generate the update billing url for.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderAutoOrderUpdateBillingUrlResponse]
+    def get_update_billing_url(order_id, opts = {})
+      data, _status_code, _headers = get_update_billing_url_with_http_info(order_id, opts)
+      data
+    end
+
+    # Generate an auto order update billing url
+    # Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email. 
+    # @param order_id [String] The order id to generate the update billing url for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderAutoOrderUpdateBillingUrlResponse, Integer, Hash)>] OrderAutoOrderUpdateBillingUrlResponse data, response status code and response headers
+    def get_update_billing_url_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_update_billing_url ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_update_billing_url"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/auto_order_update_billing_url'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderAutoOrderUpdateBillingUrlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_update_billing_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#get_update_billing_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add items and release a held order
     # This method adds items to an order in the hold stage and releases it 
     # @param order_id [String] The order id to release.

data/lib/ultracart_api/api/sfvb_api.rb

@@ -3076,6 +3076,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get the storefront's screen recording settings
+    # Whether real shoppers' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbRecordingSettingsResponse]
+    def get_sfvb_recording_settings(storefront_oid, opts = {})
+      data, _status_code, _headers = get_sfvb_recording_settings_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Get the storefront's screen recording settings
+    # Whether real shoppers' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbRecordingSettingsResponse, Integer, Hash)>] SfvbRecordingSettingsResponse data, response status code and response headers
+    def get_sfvb_recording_settings_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording_settings ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_recording_settings"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/recording_settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbRecordingSettingsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_recording_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get one storefront render log
     # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
     # @param storefront_oid [Integer] 
@@ -6237,6 +6301,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Turn the storefront's screen recording on or off
+    # Turning it on records real shoppers' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day. 
+    # @param storefront_oid [Integer] 
+    # @param recording_settings_request [SfvbRecordingSettingsRequest] Whether to record
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbRecordingSettingsResponse]
+    def put_sfvb_recording_settings(storefront_oid, recording_settings_request, opts = {})
+      data, _status_code, _headers = put_sfvb_recording_settings_with_http_info(storefront_oid, recording_settings_request, opts)
+      data
+    end
+
+    # Turn the storefront&#39;s screen recording on or off
+    # Turning it on records real shoppers&#39; sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day. 
+    # @param storefront_oid [Integer] 
+    # @param recording_settings_request [SfvbRecordingSettingsRequest] Whether to record
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbRecordingSettingsResponse, Integer, Hash)>] SfvbRecordingSettingsResponse data, response status code and response headers
+    def put_sfvb_recording_settings_with_http_info(storefront_oid, recording_settings_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_recording_settings ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_recording_settings"
+      end
+      # verify the required parameter 'recording_settings_request' is set
+      if @api_client.config.client_side_validation && recording_settings_request.nil?
+        fail ArgumentError, "Missing the required parameter 'recording_settings_request' when calling SfvbApi.put_sfvb_recording_settings"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/recording_settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(recording_settings_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbRecordingSettingsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_recording_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Change a storefront's site attributes
     # A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here. 
     # @param storefront_oid [Integer]