ultracart_api 3.10.18 → 3.10.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f37680929be7f700802faf7c672a24debc1194e6c4541025e158f38a84048fa9
-  data.tar.gz: 5e83ffd30822f714eda188689478e0e3e32f91e993add0eb7b287cbe6b2c5431
+  metadata.gz: 78041697c0613ab2caadfefb31ad7a5ed74ef26b644376b2c07d3d737ba32308
+  data.tar.gz: 87082c912aed8bece9e24491980059f8b6485d33b11ec69fdf923619c7313899
 SHA512:
-  metadata.gz: 8a7ad9001ea6e6bed8ffae58a7ea2ad07d7b4b479f8bb2e7c8ce78209c00d94135a5f0886221126ece44383e6626cdcfcbd8051207b8798ebecf42fdff6ae311
-  data.tar.gz: 55b3decb2da6580d62fccb1c064a98f0910b50a4b4ed3e88bf61a8b558eade9b5a5977ee6f198a42d64887f6dd8198ee6d20e7dba9eb8a17045e3432d890cf30
+  metadata.gz: 2cdfd1a35882a63c43116c799cd4a2e2329dd13d4292796d67e85467fbfa027e245e589dd51a8ee991e9e170f02c66ed413e0e30a19827bf802f9192ca522561
+  data.tar.gz: 5ae21465d11beda5648a6b3363b671d671303ab5802d6f2709eee2411e4b2a42b67a1640ca20633daca5484e61207c8592e2c6a3325ff966b0fe9cfd209582ba

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.10.18
+- Package version: 3.10.19
 - 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.10.18.gem
+gem install ./ultracart_api-3.10.19.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.18.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.19.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.10.18'
+    gem 'ultracart_api', '~> 3.10.19'
 
 ### Install from Git
 
@@ -157,6 +157,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
 *UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
 *UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
+*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 *UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
 *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
@@ -625,6 +626,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
+ - [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
  - [UltracartClient::CustomerPrivacy](docs/CustomerPrivacy.md)
@@ -1132,6 +1134,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
 | 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
 | 3.10.17 | 06/23/2022 | automation test |
 | 3.10.16 | 06/23/2022 | automation test |

data/docs/CustomerActivity.md

@@ -4,8 +4,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **activities** | [**Array<Activity>**](Activity.md) |  | [optional] 
+**global_unsubscribed** | **BOOLEAN** |  | [optional] 
+**global_unsubscribed_dts** | **String** |  | [optional] 
 **memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) |  | [optional] 
 **metrics** | [**Array<Metric>**](Metric.md) |  | [optional] 
 **properties_list** | [**Array<Property>**](Property.md) |  | [optional] 
+**spam_complaint** | **BOOLEAN** |  | [optional] 
+**spam_complaint_dts** | **String** |  | [optional] 
 
 

data/docs/CustomerApi.md

@@ -17,6 +17,7 @@ Method | HTTP request | Description
 [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
 [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
 [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
+[**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
 [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
@@ -756,6 +757,62 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_customer**
+> merge_customer(customer, customer_profile_oid, opts)
+
+Merge customer into this customer
+
+Merge customer into this customer. 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+customer = UltracartClient::CustomerMergeRequest.new # CustomerMergeRequest | Customer to merge into this profile.
+
+customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Merge customer into this customer
+  api_instance.merge_customer(customer, customer_profile_oid, opts)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->merge_customer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer** | [**CustomerMergeRequest**](CustomerMergeRequest.md)| Customer to merge into this profile. | 
+ **customer_profile_oid** | **Integer**| The customer_profile_oid to update. | 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **search_customer_profile_values**
 > LookupResponse search_customer_profile_values(lookup_request)
 

data/docs/CustomerMergeRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::CustomerMergeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_profile_oid** | **Integer** | Customer profile oid to merge | [optional] 
+**email** | **String** | Email of the customer profile to merge | [optional] 
+
+

data/lib/ultracart_api/api/customer_api.rb

@@ -857,6 +857,69 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Merge customer into this customer
+    # Merge customer into this customer. 
+    # @param customer Customer to merge into this profile.
+    # @param customer_profile_oid The customer_profile_oid to update.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [nil]
+    def merge_customer(customer, customer_profile_oid, opts = {})
+      merge_customer_with_http_info(customer, customer_profile_oid, opts)
+      nil
+    end
+
+    # Merge customer into this customer
+    # Merge customer into this customer. 
+    # @param customer Customer to merge into this profile.
+    # @param customer_profile_oid The customer_profile_oid to update.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def merge_customer_with_http_info(customer, customer_profile_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.merge_customer ...'
+      end
+      # verify the required parameter 'customer' is set
+      if @api_client.config.client_side_validation && customer.nil?
+        fail ArgumentError, "Missing the required parameter 'customer' when calling CustomerApi.merge_customer"
+      end
+      # verify the required parameter 'customer_profile_oid' is set
+      if @api_client.config.client_side_validation && customer_profile_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.merge_customer"
+      end
+      # resource path
+      local_var_path = '/customer/customers/{customer_profile_oid}/merge'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(customer)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, 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: CustomerApi#merge_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Searches for all matching values (using POST)
     # @param lookup_request LookupRequest
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/customer_activity.rb

@@ -16,19 +16,31 @@ module UltracartClient
   class CustomerActivity
     attr_accessor :activities
 
+    attr_accessor :global_unsubscribed
+
+    attr_accessor :global_unsubscribed_dts
+
     attr_accessor :memberships
 
     attr_accessor :metrics
 
     attr_accessor :properties_list
 
+    attr_accessor :spam_complaint
+
+    attr_accessor :spam_complaint_dts
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'activities' => :'activities',
+        :'global_unsubscribed' => :'global_unsubscribed',
+        :'global_unsubscribed_dts' => :'global_unsubscribed_dts',
         :'memberships' => :'memberships',
         :'metrics' => :'metrics',
-        :'properties_list' => :'properties_list'
+        :'properties_list' => :'properties_list',
+        :'spam_complaint' => :'spam_complaint',
+        :'spam_complaint_dts' => :'spam_complaint_dts'
       }
     end
 
@@ -36,9 +48,13 @@ module UltracartClient
     def self.swagger_types
       {
         :'activities' => :'Array<Activity>',
+        :'global_unsubscribed' => :'BOOLEAN',
+        :'global_unsubscribed_dts' => :'String',
         :'memberships' => :'Array<ListSegmentMembership>',
         :'metrics' => :'Array<Metric>',
-        :'properties_list' => :'Array<Property>'
+        :'properties_list' => :'Array<Property>',
+        :'spam_complaint' => :'BOOLEAN',
+        :'spam_complaint_dts' => :'String'
       }
     end
 
@@ -56,6 +72,14 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'global_unsubscribed')
+        self.global_unsubscribed = attributes[:'global_unsubscribed']
+      end
+
+      if attributes.has_key?(:'global_unsubscribed_dts')
+        self.global_unsubscribed_dts = attributes[:'global_unsubscribed_dts']
+      end
+
       if attributes.has_key?(:'memberships')
         if (value = attributes[:'memberships']).is_a?(Array)
           self.memberships = value
@@ -73,6 +97,14 @@ module UltracartClient
           self.properties_list = value
         end
       end
+
+      if attributes.has_key?(:'spam_complaint')
+        self.spam_complaint = attributes[:'spam_complaint']
+      end
+
+      if attributes.has_key?(:'spam_complaint_dts')
+        self.spam_complaint_dts = attributes[:'spam_complaint_dts']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,9 +126,13 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           activities == o.activities &&
+          global_unsubscribed == o.global_unsubscribed &&
+          global_unsubscribed_dts == o.global_unsubscribed_dts &&
           memberships == o.memberships &&
           metrics == o.metrics &&
-          properties_list == o.properties_list
+          properties_list == o.properties_list &&
+          spam_complaint == o.spam_complaint &&
+          spam_complaint_dts == o.spam_complaint_dts
     end
 
     # @see the `==` method
@@ -108,7 +144,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activities, memberships, metrics, properties_list].hash
+      [activities, global_unsubscribed, global_unsubscribed_dts, memberships, metrics, properties_list, spam_complaint, spam_complaint_dts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_merge_request.rb

@@ -0,0 +1,195 @@
+=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 CustomerMergeRequest
+    # Customer profile oid to merge
+    attr_accessor :customer_profile_oid
+
+    # Email of the customer profile to merge
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_profile_oid' => :'customer_profile_oid',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'customer_profile_oid' => :'Integer',
+        :'email' => :'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?(:'customer_profile_oid')
+        self.customer_profile_oid = attributes[:'customer_profile_oid']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      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 &&
+          customer_profile_oid == o.customer_profile_oid &&
+          email == o.email
+    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
+      [customer_profile_oid, email].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.10.18'
+  VERSION = '3.10.19'
 end

data/lib/ultracart_api.rb

@@ -211,6 +211,7 @@ require 'ultracart_api/models/customer_email_list_changes'
 require 'ultracart_api/models/customer_loyalty'
 require 'ultracart_api/models/customer_loyalty_ledger'
 require 'ultracart_api/models/customer_loyalty_redemption'
+require 'ultracart_api/models/customer_merge_request'
 require 'ultracart_api/models/customer_orders_summary'
 require 'ultracart_api/models/customer_pricing_tier'
 require 'ultracart_api/models/customer_privacy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.18
+  version: 3.10.19
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -422,6 +422,7 @@ files:
 - docs/CustomerLoyalty.md
 - docs/CustomerLoyaltyLedger.md
 - docs/CustomerLoyaltyRedemption.md
+- docs/CustomerMergeRequest.md
 - docs/CustomerOrdersSummary.md
 - docs/CustomerPricingTier.md
 - docs/CustomerPrivacy.md
@@ -1089,6 +1090,7 @@ files:
 - lib/ultracart_api/models/customer_loyalty.rb
 - lib/ultracart_api/models/customer_loyalty_ledger.rb
 - lib/ultracart_api/models/customer_loyalty_redemption.rb
+- lib/ultracart_api/models/customer_merge_request.rb
 - lib/ultracart_api/models/customer_orders_summary.rb
 - lib/ultracart_api/models/customer_pricing_tier.rb
 - lib/ultracart_api/models/customer_privacy.rb