ultracart_api 3.1.9 → 3.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b0316b68438297efe82bb7880c769fccd55fc3e4091735be9eb3f107f7fa8a
-  data.tar.gz: a1748cd5837ef90e36dea67ebd5f05d2d61922bc8ea1deb2dd4c3852f9da9545
+  metadata.gz: '094c42a7b58e47833d3d3f25b4ecc5842e6aee6f44da37a62919ba820890dbce'
+  data.tar.gz: d1f7de2eb8cbe6dd978b28b0a5f9cfd3811afe28210f7960fd9490d87228fe77
 SHA512:
-  metadata.gz: 8b09fb0044b9ddce75421a77342457491c9c28f185c95e47d46fab428420cbc8b5234e9ffcabf7cac43ad9f854b969bf92043c61ac8e2f68744aa6bce40a4f34
-  data.tar.gz: fa1275d4d472272e4953843d354e5cabaf36aea93276754570cbe507d9aafbb2c6cf9db27e26ac1ad8758b902186de9a3974a74b5fb6f3e458656f1db6cc4cfb
+  metadata.gz: e41253222e1e0168e8d5e9c53d971ee23fdbdc0dd6bf290dd4426df1bc31712bc477849c26a7511a87100f329424bafd96bdee005d16e41a1186bda05f744094
+  data.tar.gz: c10d19ebcc321bbd469fcd339014a2e44580ad1d82b8ce7ebfdef6934724a2bba154b0509e071a33b432e6cab2db92edccd053bfe4318cac40fbe01c3117823b

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.1.9
+- Package version: 3.1.10
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.1.9.gem
+gem install ./ultracart_api-3.1.10.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.9.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.10.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.1.9'
+    gem 'ultracart_api', '~> 3.1.10'
 
 ### Install from Git
 
@@ -327,6 +327,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**update_email_settings**](docs/StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
 *UltracartClient::StorefrontApi* | [**update_experiment**](docs/StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
 *UltracartClient::StorefrontApi* | [**update_library_item**](docs/StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
+*UltracartClient::StorefrontApi* | [**update_screen_recording_merchant_notes**](docs/StorefrontApi.md#update_screen_recording_merchant_notes) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes | Update merchant notes on a screen recording
 *UltracartClient::StorefrontApi* | [**update_screen_recording_segment**](docs/StorefrontApi.md#update_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Update screen recording segment
 *UltracartClient::StorefrontApi* | [**update_screen_recording_settings**](docs/StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
 *UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
@@ -865,6 +866,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenRecordingFilterValues](docs/ScreenRecordingFilterValues.md)
  - [UltracartClient::ScreenRecordingFilterValuesEvent](docs/ScreenRecordingFilterValuesEvent.md)
  - [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
+ - [UltracartClient::ScreenRecordingMerchantNotesRequest](docs/ScreenRecordingMerchantNotesRequest.md)
  - [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
  - [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
  - [UltracartClient::ScreenRecordingPageViewDataResponse](docs/ScreenRecordingPageViewDataResponse.md)
@@ -1004,6 +1006,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.1.10 | 02/24/2021 | Added Screen recording merchant notes |
 | 3.1.9 | 02/24/2021 | Allow coupons to be configured as unique with expiration on cart step within StoreFront Communications |
 | 3.1.8 | 02/24/2021 | Add flag: screen recording missing event boolean |
 | 3.1.5 | 02/12/2021 | Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor |

data/docs/ScreenRecording.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **geolocation_country** | **String** |  | [optional] 
 **geolocation_state** | **String** |  | [optional] 
 **merchant_id** | **String** |  | [optional] 
+**merchant_notes** | **String** |  | [optional] 
 **order_id** | **String** |  | [optional] 
 **page_view_count** | **Integer** |  | [optional] 
 **page_views** | [**Array<ScreenRecordingPageView>**](ScreenRecordingPageView.md) |  | [optional] 

data/docs/ScreenRecordingMerchantNotesRequest.md

@@ -0,0 +1,8 @@
+# UltracartClient::ScreenRecordingMerchantNotesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_notes** | **String** |  | [optional] 
+
+

data/docs/StorefrontApi.md

@@ -143,6 +143,7 @@ Method | HTTP request | Description
 [**update_email_settings**](StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
 [**update_experiment**](StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
 [**update_library_item**](StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
+[**update_screen_recording_merchant_notes**](StorefrontApi.md#update_screen_recording_merchant_notes) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes | Update merchant notes on a screen recording
 [**update_screen_recording_segment**](StorefrontApi.md#update_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Update screen recording segment
 [**update_screen_recording_settings**](StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
 [**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
@@ -7320,6 +7321,61 @@ Name | Type | Description  | Notes
 
 
 
+# **update_screen_recording_merchant_notes**
+> update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request)
+
+Update merchant notes on a screen recording
+
+Update merchant notes on a screen recording 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+screen_recording_uuid = 'screen_recording_uuid_example' # String | 
+
+merchant_notes_request = UltracartClient::ScreenRecordingMerchantNotesRequest.new # ScreenRecordingMerchantNotesRequest | Merchant Notes
+
+
+begin
+  #Update merchant notes on a screen recording
+  api_instance.update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->update_screen_recording_merchant_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **screen_recording_uuid** | **String**|  | 
+ **merchant_notes_request** | [**ScreenRecordingMerchantNotesRequest**](ScreenRecordingMerchantNotesRequest.md)| Merchant Notes | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_screen_recording_segment**
 > ScreenRecordingSegmentResponse update_screen_recording_segment(storefront_oid, screen_recording_segment_oid, segment)
 

data/lib/ultracart_api.rb

@@ -500,6 +500,7 @@ require 'ultracart_api/models/screen_recording_filter_string_search'
 require 'ultracart_api/models/screen_recording_filter_values'
 require 'ultracart_api/models/screen_recording_filter_values_event'
 require 'ultracart_api/models/screen_recording_filter_values_event_params'
+require 'ultracart_api/models/screen_recording_merchant_notes_request'
 require 'ultracart_api/models/screen_recording_multifield'
 require 'ultracart_api/models/screen_recording_page_view'
 require 'ultracart_api/models/screen_recording_page_view_data_response'

data/lib/ultracart_api/api/storefront_api.rb

@@ -8245,6 +8245,72 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update merchant notes on a screen recording
+    # Update merchant notes on a screen recording 
+    # @param storefront_oid 
+    # @param screen_recording_uuid 
+    # @param merchant_notes_request Merchant Notes
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
+      update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts)
+      nil
+    end
+
+    # Update merchant notes on a screen recording
+    # Update merchant notes on a screen recording 
+    # @param storefront_oid 
+    # @param screen_recording_uuid 
+    # @param merchant_notes_request Merchant Notes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_merchant_notes ...'
+      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 StorefrontApi.update_screen_recording_merchant_notes"
+      end
+      # verify the required parameter 'screen_recording_uuid' is set
+      if @api_client.config.client_side_validation && screen_recording_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.update_screen_recording_merchant_notes"
+      end
+      # verify the required parameter 'merchant_notes_request' is set
+      if @api_client.config.client_side_validation && merchant_notes_request.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_notes_request' when calling StorefrontApi.update_screen_recording_merchant_notes"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(merchant_notes_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_merchant_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update screen recording segment
     # @param storefront_oid 
     # @param screen_recording_segment_oid 

data/lib/ultracart_api/models/screen_recording.rb

@@ -45,6 +45,8 @@ module UltracartClient
 
     attr_accessor :merchant_id
 
+    attr_accessor :merchant_notes
+
     attr_accessor :order_id
 
     attr_accessor :page_view_count
@@ -101,6 +103,7 @@ module UltracartClient
         :'geolocation_country' => :'geolocation_country',
         :'geolocation_state' => :'geolocation_state',
         :'merchant_id' => :'merchant_id',
+        :'merchant_notes' => :'merchant_notes',
         :'order_id' => :'order_id',
         :'page_view_count' => :'page_view_count',
         :'page_views' => :'page_views',
@@ -140,6 +143,7 @@ module UltracartClient
         :'geolocation_country' => :'String',
         :'geolocation_state' => :'String',
         :'merchant_id' => :'String',
+        :'merchant_notes' => :'String',
         :'order_id' => :'String',
         :'page_view_count' => :'Integer',
         :'page_views' => :'Array<ScreenRecordingPageView>',
@@ -228,6 +232,10 @@ module UltracartClient
         self.merchant_id = attributes[:'merchant_id']
       end
 
+      if attributes.has_key?(:'merchant_notes')
+        self.merchant_notes = attributes[:'merchant_notes']
+      end
+
       if attributes.has_key?(:'order_id')
         self.order_id = attributes[:'order_id']
       end
@@ -347,6 +355,7 @@ module UltracartClient
           geolocation_country == o.geolocation_country &&
           geolocation_state == o.geolocation_state &&
           merchant_id == o.merchant_id &&
+          merchant_notes == o.merchant_notes &&
           order_id == o.order_id &&
           page_view_count == o.page_view_count &&
           page_views == o.page_views &&
@@ -377,7 +386,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [analytics_client_oid, analytics_session_dts, analytics_session_oid, email, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, merchant_id, order_id, page_view_count, page_views, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, watched, window_height, window_width].hash
+      [analytics_client_oid, analytics_session_dts, analytics_session_oid, email, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, merchant_id, merchant_notes, order_id, page_view_count, page_views, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, watched, window_height, window_width].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb

@@ -0,0 +1,184 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ScreenRecordingMerchantNotesRequest
+    attr_accessor :merchant_notes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'merchant_notes' => :'merchant_notes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'merchant_notes' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'merchant_notes')
+        self.merchant_notes = attributes[:'merchant_notes']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          merchant_notes == o.merchant_notes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [merchant_notes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.1.9'
+  VERSION = '3.1.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.1.9
+  version: 3.1.10
 platform: ruby
 authors:
 - UltraCart
@@ -694,6 +694,7 @@ files:
 - docs/ScreenRecordingFilterValues.md
 - docs/ScreenRecordingFilterValuesEvent.md
 - docs/ScreenRecordingFilterValuesEventParams.md
+- docs/ScreenRecordingMerchantNotesRequest.md
 - docs/ScreenRecordingMultifield.md
 - docs/ScreenRecordingPageView.md
 - docs/ScreenRecordingPageViewDataResponse.md
@@ -1279,6 +1280,7 @@ files:
 - lib/ultracart_api/models/screen_recording_filter_values.rb
 - lib/ultracart_api/models/screen_recording_filter_values_event.rb
 - lib/ultracart_api/models/screen_recording_filter_values_event_params.rb
+- lib/ultracart_api/models/screen_recording_merchant_notes_request.rb
 - lib/ultracart_api/models/screen_recording_multifield.rb
 - lib/ultracart_api/models/screen_recording_page_view.rb
 - lib/ultracart_api/models/screen_recording_page_view_data_response.rb