ultracart_api 3.9.5 → 3.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d068d27d5807a5494204d0db5a681fb771e5b9fbabb74f59742e7d3ba59fd34
-  data.tar.gz: fff21105856493ae872eebd2fc55135e459aaaee5a7420f14b68e64518dde142
+  metadata.gz: 7b24e98917ef5f54fb712aead6d1f544fe121294afac179e2181e0ef18148612
+  data.tar.gz: 01beb929c534c20da76a204106e9f5b3bd65d24576fc22be521d497356b6e8b6
 SHA512:
-  metadata.gz: 8361715af7f71ab8216227cb0484942c0d0608cfaa941fcfc7e530a020d53d805e4e5ce064316ac36f90c4160850e48991d25fa924da6feefafcba13d052332c
-  data.tar.gz: 0ae1b6160775abc6ef98ac2b2d3be2fc1f3ee46049cc2db8b7019a6e08285c3d5934c9508c6b63842227ca3972a15a4e27a965a700a2eb2224d2c59a161b5590
+  metadata.gz: 15849669dc4c8acd98804036dcdd1f29b657b42aae7ba3986c0671d91e30c1c53d148791ad074e8a6d074d87bc198cefb2d5c38014ff9f97d3ab12cf5529f47e
+  data.tar.gz: 118a3d786da54a1d1954c28c14f4eb2765fdfb65f2d15d7ff18ac7c966fc108bd9467d9dedf46a0cc01c7866e7d60a58f8dd6a6bf2031c38d6206298430b6e9d

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.9.5
+- Package version: 3.9.6
 - 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.9.5.gem
+gem install ./ultracart_api-3.9.6.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.9.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.9.6.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.9.5'
+    gem 'ultracart_api', '~> 3.9.6'
 
 ### Install from Git
 
@@ -1151,6 +1151,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
 | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
 | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
 | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |

data/docs/AutoOrder.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **auto_order_oid** | **Integer** | Auto order object identifier | [optional] 
 **cancel_after_next_x_orders** | **Integer** | Cancel this auto order after X additional rebills | [optional] 
 **cancel_downgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased a downgrade item | [optional] 
+**cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer | [optional] 
 **cancel_upgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased an upgrade item | [optional] 
 **canceled_by_user** | **String** | The user that canceled the auto order | [optional] 
 **canceled_dts** | **String** | The date/time that the auto order was canceled | [optional] 

data/docs/EmailCommseqEmail.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **filter_profile_equation_json** | **String** | Filter profile equation json | [optional] 
 **individually_render** | **BOOLEAN** | Individually render | [optional] 
 **library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before.  This value is used to determine if a library item should be inserted or updated. | [optional] 
+**magic_link** | **BOOLEAN** | True if email links should contain magic link tokens to log the customer in automatically | [optional] 
 **merchant_id** | **String** | Merchant ID | [optional] 
 **pending_review** | **BOOLEAN** | True if the content of this email is pending review by UltraCart | [optional] 
 **preview_text** | **String** | Preview text | [optional] 

data/docs/EmailPerformance.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **customer_histogram** | [**EmailPerformanceCustomerHistogram**](EmailPerformanceCustomerHistogram.md) |  | [optional] 
 **daily_stats** | [**Array<EmailPerformanceDaily>**](EmailPerformanceDaily.md) | Daily statistics used for charting | [optional] 
 **delivered_count** | **Integer** | Delivered count | [optional] 
+**loyalty_program_type** | **String** | Loyalty Program Type | [optional] 
 **max_active_customers** | **Integer** | Maximum active customers allowed under their billing plan | [optional] 
 **max_emails_per_day** | **Integer** | Max emails per day | [optional] 
 **max_emails_per_hour** | **Integer** | Max emails per hour | [optional] 

data/docs/OrderAutoOrder.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **auto_order_oid** | **Integer** | Auto order object identifier | [optional] 
 **cancel_after_next_x_orders** | **Integer** | Cancel this auto order after X additional rebills | [optional] 
 **cancel_downgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased a downgrade item | [optional] 
+**cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer | [optional] 
 **cancel_upgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased an upgrade item | [optional] 
 **canceled_by_user** | **String** | The user that canceled the auto order | [optional] 
 **canceled_dts** | **String** | The date/time that the auto order was canceled | [optional] 

data/lib/ultracart_api/models/auto_order.rb

@@ -26,6 +26,9 @@ module UltracartClient
     # True if the auto order was canceled because the customer purchased a downgrade item
     attr_accessor :cancel_downgrade
 
+    # The reason this auto order was canceled by either merchant or customer
+    attr_accessor :cancel_reason
+
     # True if the auto order was canceled because the customer purchased an upgrade item
     attr_accessor :cancel_upgrade
 
@@ -105,6 +108,7 @@ module UltracartClient
         :'auto_order_oid' => :'auto_order_oid',
         :'cancel_after_next_x_orders' => :'cancel_after_next_x_orders',
         :'cancel_downgrade' => :'cancel_downgrade',
+        :'cancel_reason' => :'cancel_reason',
         :'cancel_upgrade' => :'cancel_upgrade',
         :'canceled_by_user' => :'canceled_by_user',
         :'canceled_dts' => :'canceled_dts',
@@ -132,6 +136,7 @@ module UltracartClient
         :'auto_order_oid' => :'Integer',
         :'cancel_after_next_x_orders' => :'Integer',
         :'cancel_downgrade' => :'BOOLEAN',
+        :'cancel_reason' => :'String',
         :'cancel_upgrade' => :'BOOLEAN',
         :'canceled_by_user' => :'String',
         :'canceled_dts' => :'String',
@@ -176,6 +181,10 @@ module UltracartClient
         self.cancel_downgrade = attributes[:'cancel_downgrade']
       end
 
+      if attributes.has_key?(:'cancel_reason')
+        self.cancel_reason = attributes[:'cancel_reason']
+      end
+
       if attributes.has_key?(:'cancel_upgrade')
         self.cancel_upgrade = attributes[:'cancel_upgrade']
       end
@@ -285,6 +294,7 @@ module UltracartClient
           auto_order_oid == o.auto_order_oid &&
           cancel_after_next_x_orders == o.cancel_after_next_x_orders &&
           cancel_downgrade == o.cancel_downgrade &&
+          cancel_reason == o.cancel_reason &&
           cancel_upgrade == o.cancel_upgrade &&
           canceled_by_user == o.canceled_by_user &&
           canceled_dts == o.canceled_dts &&
@@ -313,7 +323,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_email.rb

@@ -44,6 +44,9 @@ module UltracartClient
     # If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before.  This value is used to determine if a library item should be inserted or updated.
     attr_accessor :library_item_oid
 
+    # True if email links should contain magic link tokens to log the customer in automatically
+    attr_accessor :magic_link
+
     # Merchant ID
     attr_accessor :merchant_id
 
@@ -102,6 +105,7 @@ module UltracartClient
         :'filter_profile_equation_json' => :'filter_profile_equation_json',
         :'individually_render' => :'individually_render',
         :'library_item_oid' => :'library_item_oid',
+        :'magic_link' => :'magic_link',
         :'merchant_id' => :'merchant_id',
         :'pending_review' => :'pending_review',
         :'preview_text' => :'preview_text',
@@ -133,6 +137,7 @@ module UltracartClient
         :'filter_profile_equation_json' => :'String',
         :'individually_render' => :'BOOLEAN',
         :'library_item_oid' => :'Integer',
+        :'magic_link' => :'BOOLEAN',
         :'merchant_id' => :'String',
         :'pending_review' => :'BOOLEAN',
         :'preview_text' => :'String',
@@ -199,6 +204,10 @@ module UltracartClient
         self.library_item_oid = attributes[:'library_item_oid']
       end
 
+      if attributes.has_key?(:'magic_link')
+        self.magic_link = attributes[:'magic_link']
+      end
+
       if attributes.has_key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -288,6 +297,7 @@ module UltracartClient
           filter_profile_equation_json == o.filter_profile_equation_json &&
           individually_render == o.individually_render &&
           library_item_oid == o.library_item_oid &&
+          magic_link == o.magic_link &&
           merchant_id == o.merchant_id &&
           pending_review == o.pending_review &&
           preview_text == o.preview_text &&
@@ -314,7 +324,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
+      [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, magic_link, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_performance.rb

@@ -37,6 +37,9 @@ module UltracartClient
     # Delivered count
     attr_accessor :delivered_count
 
+    # Loyalty Program Type
+    attr_accessor :loyalty_program_type
+
     # Maximum active customers allowed under their billing plan
     attr_accessor :max_active_customers
 
@@ -79,6 +82,28 @@ module UltracartClient
     # Total transactions emails sent
     attr_accessor :transactional_send_count
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -90,6 +115,7 @@ module UltracartClient
         :'customer_histogram' => :'customer_histogram',
         :'daily_stats' => :'daily_stats',
         :'delivered_count' => :'delivered_count',
+        :'loyalty_program_type' => :'loyalty_program_type',
         :'max_active_customers' => :'max_active_customers',
         :'max_emails_per_day' => :'max_emails_per_day',
         :'max_emails_per_hour' => :'max_emails_per_hour',
@@ -118,6 +144,7 @@ module UltracartClient
         :'customer_histogram' => :'EmailPerformanceCustomerHistogram',
         :'daily_stats' => :'Array<EmailPerformanceDaily>',
         :'delivered_count' => :'Integer',
+        :'loyalty_program_type' => :'String',
         :'max_active_customers' => :'Integer',
         :'max_emails_per_day' => :'Integer',
         :'max_emails_per_hour' => :'Integer',
@@ -177,6 +204,10 @@ module UltracartClient
         self.delivered_count = attributes[:'delivered_count']
       end
 
+      if attributes.has_key?(:'loyalty_program_type')
+        self.loyalty_program_type = attributes[:'loyalty_program_type']
+      end
+
       if attributes.has_key?(:'max_active_customers')
         self.max_active_customers = attributes[:'max_active_customers']
       end
@@ -244,9 +275,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      loyalty_program_type_validator = EnumAttributeValidator.new('String', ['disabled', 'points', 'cashback'])
+      return false unless loyalty_program_type_validator.valid?(@loyalty_program_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] loyalty_program_type Object to be assigned
+    def loyalty_program_type=(loyalty_program_type)
+      validator = EnumAttributeValidator.new('String', ['disabled', 'points', 'cashback'])
+      unless validator.valid?(loyalty_program_type)
+        fail ArgumentError, 'invalid value for "loyalty_program_type", must be one of #{validator.allowable_values}.'
+      end
+      @loyalty_program_type = loyalty_program_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -260,6 +303,7 @@ module UltracartClient
           customer_histogram == o.customer_histogram &&
           daily_stats == o.daily_stats &&
           delivered_count == o.delivered_count &&
+          loyalty_program_type == o.loyalty_program_type &&
           max_active_customers == o.max_active_customers &&
           max_emails_per_day == o.max_emails_per_day &&
           max_emails_per_hour == o.max_emails_per_hour &&
@@ -285,7 +329,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [active_customers, actual_customers, bounce_count, bounce_percentage, bounce_percentage_formatted, customer_histogram, daily_stats, delivered_count, max_active_customers, max_emails_per_day, max_emails_per_hour, max_emails_per_month, paused_for_spam, revenue, sent_emails_per_day, sent_emails_per_hour, sent_emails_per_month, sequence_send_count, spam_count, spam_percentage, spam_percentage_formatted, transactional_send_count].hash
+      [active_customers, actual_customers, bounce_count, bounce_percentage, bounce_percentage_formatted, customer_histogram, daily_stats, delivered_count, loyalty_program_type, max_active_customers, max_emails_per_day, max_emails_per_hour, max_emails_per_month, paused_for_spam, revenue, sent_emails_per_day, sent_emails_per_hour, sent_emails_per_month, sequence_send_count, spam_count, spam_percentage, spam_percentage_formatted, transactional_send_count].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_auto_order.rb

@@ -26,6 +26,9 @@ module UltracartClient
     # True if the auto order was canceled because the customer purchased a downgrade item
     attr_accessor :cancel_downgrade
 
+    # The reason this auto order was canceled by either merchant or customer
+    attr_accessor :cancel_reason
+
     # True if the auto order was canceled because the customer purchased an upgrade item
     attr_accessor :cancel_upgrade
 
@@ -100,6 +103,7 @@ module UltracartClient
         :'auto_order_oid' => :'auto_order_oid',
         :'cancel_after_next_x_orders' => :'cancel_after_next_x_orders',
         :'cancel_downgrade' => :'cancel_downgrade',
+        :'cancel_reason' => :'cancel_reason',
         :'cancel_upgrade' => :'cancel_upgrade',
         :'canceled_by_user' => :'canceled_by_user',
         :'canceled_dts' => :'canceled_dts',
@@ -125,6 +129,7 @@ module UltracartClient
         :'auto_order_oid' => :'Integer',
         :'cancel_after_next_x_orders' => :'Integer',
         :'cancel_downgrade' => :'BOOLEAN',
+        :'cancel_reason' => :'String',
         :'cancel_upgrade' => :'BOOLEAN',
         :'canceled_by_user' => :'String',
         :'canceled_dts' => :'String',
@@ -167,6 +172,10 @@ module UltracartClient
         self.cancel_downgrade = attributes[:'cancel_downgrade']
       end
 
+      if attributes.has_key?(:'cancel_reason')
+        self.cancel_reason = attributes[:'cancel_reason']
+      end
+
       if attributes.has_key?(:'cancel_upgrade')
         self.cancel_upgrade = attributes[:'cancel_upgrade']
       end
@@ -266,6 +275,7 @@ module UltracartClient
           auto_order_oid == o.auto_order_oid &&
           cancel_after_next_x_orders == o.cancel_after_next_x_orders &&
           cancel_downgrade == o.cancel_downgrade &&
+          cancel_reason == o.cancel_reason &&
           cancel_upgrade == o.cancel_upgrade &&
           canceled_by_user == o.canceled_by_user &&
           canceled_dts == o.canceled_dts &&
@@ -292,7 +302,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, next_attempt, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, next_attempt, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.9.5
+  version: 3.9.6
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus