ultracart_api 4.0.194 → 4.0.196

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cb34154ee2c02d4fed8962fb74ed0823b03e343c1acaebea18ad44bc59ddc8
-  data.tar.gz: 9925e0891e2c77605d2eeee39fa4579b8021a1f59426e6685e70648ca48610b5
+  metadata.gz: 3c55f53122912472b5f1486d5873c6e8855d3f77e9c36266b389b4e185845b44
+  data.tar.gz: 8f2918ed1962e0d4783034f8608fb7cd00b12bd043ce0b0f66a3f95dfdd9df7b
 SHA512:
-  metadata.gz: 5d53b4d9864069679cc278a9fa0a3ebe8ee4729e9ce1b3ac718f95c284302a87a3d6fb177abb91f926ff3e048fa42f126b71cd412817dba651056afb9ae1b426
-  data.tar.gz: dfee6303b751ce955b07784ac7b1ff53974d2ad926f14ce1bc8819759bd915db4ab6dd318bf47cd530104e9efa4d41cfcca9794eb5c9298e57669394b931937b
+  metadata.gz: a91867ba183e2426b47ca233a47c1499cd7108a39aa42a223d6daec7f9b7a05506a5209d273c48cf70fbcbb1eac3f2a0649c261adaa967663229e3586a755f10
+  data.tar.gz: 23a19c9840ebf972664d36bf7fa0ac8cad3c6be3f8132cd47495f43ceadad8dc9e61171bfd0ed3acc2068d87d5fb81f11725429c83a2b53abfdc0f50e425fa7a

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.194
+- Package version: 4.0.196
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.194.gem
+gem install ./ultracart_api-4.0.196.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.194.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.196.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', '~> 4.0.194'
+    gem 'ultracart_api', '~> 4.0.196'
 
 ### Install from Git
 
@@ -1406,6 +1406,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.196 | 01/10/2024 | workflow task - add uuids of related tasks and tags |
+| 4.0.195 | 01/03/2024 | workflow - add task_context field to task obj |
 | 4.0.194 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
 | 4.0.193 | 12/12/2023 | webhook - added event ruler property |
 | 4.0.192 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |

data/docs/CartSummary.md

@@ -9,6 +9,8 @@
 | **arbitrary_tax_rate** | [**Currency**](Currency.md) |  | [optional] |
 | **arbitrary_taxable_subtotal** | [**Currency**](Currency.md) |  | [optional] |
 | **health_benefit_card_amount** | [**Currency**](Currency.md) |  | [optional] |
+| **health_benefit_card_balance** | [**Currency**](Currency.md) |  | [optional] |
+| **health_benefit_card_requirements** | **String** | Health benefit card requirements | [optional] |
 | **internal_gift_certificate_amount** | [**Currency**](Currency.md) |  | [optional] |
 | **shipping_handling** | [**Currency**](Currency.md) |  | [optional] |
 | **shipping_handling_discount** | [**Currency**](Currency.md) |  | [optional] |
@@ -34,6 +36,8 @@ instance = UltracartClient::CartSummary.new(
   arbitrary_tax_rate: null,
   arbitrary_taxable_subtotal: null,
   health_benefit_card_amount: null,
+  health_benefit_card_balance: null,
+  health_benefit_card_requirements: null,
   internal_gift_certificate_amount: null,
   shipping_handling: null,
   shipping_handling_discount: null,

data/docs/OrderApi.md

@@ -1565,7 +1565,7 @@ end
 
 Refund an order
 
-Perform a refund operation on an order and then update the order if successful 
+Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
 
 ### Examples
 

data/docs/WorkflowTask.md

@@ -12,6 +12,7 @@
 | **created_by** | [**WorkflowUser**](WorkflowUser.md) |  | [optional] |
 | **created_dts** | **String** | Date/time that the workflow task was created | [optional] |
 | **delay_until_dts** | **String** | Date/time that the workflow task should delay until | [optional] |
+| **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] |
 | **due_dts** | **String** | Date/time that the workflow task is due | [optional] |
 | **histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] |
 | **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] |
@@ -22,7 +23,10 @@
 | **object_type** | **String** | Object Type | [optional] |
 | **object_url** | **String** | Object URL | [optional] |
 | **priority** | **String** | Priority | [optional] |
+| **related_workflow_task_uuid** | **String** | Related Workflow Task UUID | [optional] |
 | **status** | **String** | Status of the workflow task | [optional] |
+| **tags** | **Array<String>** | Tags | [optional] |
+| **task_context** | **String** | User friendly string of the task context | [optional] |
 | **task_details** | **String** | Task Details | [optional] |
 | **task_name** | **String** | Task Name | [optional] |
 | **workflow_task_uuid** | **String** | Workflow Task UUID | [optional] |
@@ -41,6 +45,7 @@ instance = UltracartClient::WorkflowTask.new(
   created_by: null,
   created_dts: null,
   delay_until_dts: null,
+  dependant_workflow_task_uuid: null,
   due_dts: null,
   histories: null,
   last_update_dts: null,
@@ -51,7 +56,10 @@ instance = UltracartClient::WorkflowTask.new(
   object_type: null,
   object_url: null,
   priority: null,
+  related_workflow_task_uuid: null,
   status: null,
+  tags: null,
+  task_context: null,
   task_details: null,
   task_name: null,
   workflow_task_uuid: null

data/docs/WorkflowTasksResponse.md

@@ -7,6 +7,7 @@
 | **error** | [**Error**](Error.md) |  | [optional] |
 | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
 | **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **task_context** | **String** | User friendly string of the task context if querying for a specific object type/id | [optional] |
 | **tasks** | [**Array<WorkflowTask>**](WorkflowTask.md) | tasks | [optional] |
 | **warning** | [**Warning**](Warning.md) |  | [optional] |
 
@@ -19,6 +20,7 @@ instance = UltracartClient::WorkflowTasksResponse.new(
   error: null,
   metadata: null,
   success: null,
+  task_context: null,
   tasks: null,
   warning: null
 )

data/lib/ultracart_api/api/order_api.rb

@@ -1481,7 +1481,7 @@ module UltracartClient
     end
 
     # Refund an order
-    # Perform a refund operation on an order and then update the order if successful 
+    # Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
     # @param order_id [String] The order id to refund.
     # @param order [Order] Order to refund
     # @param [Hash] opts the optional parameters
@@ -1499,7 +1499,7 @@ module UltracartClient
     end
 
     # Refund an order
-    # Perform a refund operation on an order and then update the order if successful 
+    # Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
     # @param order_id [String] The order id to refund.
     # @param order [Order] Order to refund
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/cart_summary.rb

@@ -25,6 +25,11 @@ module UltracartClient
 
     attr_accessor :health_benefit_card_amount
 
+    attr_accessor :health_benefit_card_balance
+
+    # Health benefit card requirements
+    attr_accessor :health_benefit_card_requirements
+
     attr_accessor :internal_gift_certificate_amount
 
     attr_accessor :shipping_handling
@@ -59,6 +64,8 @@ module UltracartClient
         :'arbitrary_tax_rate' => :'arbitrary_tax_rate',
         :'arbitrary_taxable_subtotal' => :'arbitrary_taxable_subtotal',
         :'health_benefit_card_amount' => :'health_benefit_card_amount',
+        :'health_benefit_card_balance' => :'health_benefit_card_balance',
+        :'health_benefit_card_requirements' => :'health_benefit_card_requirements',
         :'internal_gift_certificate_amount' => :'internal_gift_certificate_amount',
         :'shipping_handling' => :'shipping_handling',
         :'shipping_handling_discount' => :'shipping_handling_discount',
@@ -88,6 +95,8 @@ module UltracartClient
         :'arbitrary_tax_rate' => :'Currency',
         :'arbitrary_taxable_subtotal' => :'Currency',
         :'health_benefit_card_amount' => :'Currency',
+        :'health_benefit_card_balance' => :'Currency',
+        :'health_benefit_card_requirements' => :'String',
         :'internal_gift_certificate_amount' => :'Currency',
         :'shipping_handling' => :'Currency',
         :'shipping_handling_discount' => :'Currency',
@@ -145,6 +154,14 @@ module UltracartClient
         self.health_benefit_card_amount = attributes[:'health_benefit_card_amount']
       end
 
+      if attributes.key?(:'health_benefit_card_balance')
+        self.health_benefit_card_balance = attributes[:'health_benefit_card_balance']
+      end
+
+      if attributes.key?(:'health_benefit_card_requirements')
+        self.health_benefit_card_requirements = attributes[:'health_benefit_card_requirements']
+      end
+
       if attributes.key?(:'internal_gift_certificate_amount')
         self.internal_gift_certificate_amount = attributes[:'internal_gift_certificate_amount']
       end
@@ -221,6 +238,8 @@ module UltracartClient
           arbitrary_tax_rate == o.arbitrary_tax_rate &&
           arbitrary_taxable_subtotal == o.arbitrary_taxable_subtotal &&
           health_benefit_card_amount == o.health_benefit_card_amount &&
+          health_benefit_card_balance == o.health_benefit_card_balance &&
+          health_benefit_card_requirements == o.health_benefit_card_requirements &&
           internal_gift_certificate_amount == o.internal_gift_certificate_amount &&
           shipping_handling == o.shipping_handling &&
           shipping_handling_discount == o.shipping_handling_discount &&
@@ -245,7 +264,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, health_benefit_card_amount, internal_gift_certificate_amount, shipping_handling, shipping_handling_discount, shipping_handling_with_discount, subtotal, subtotal_discount, subtotal_with_discount, surcharge, tax, taxable_subtotal, taxable_subtotal_discount, taxable_subtotal_with_discount, total].hash
+      [arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, health_benefit_card_amount, health_benefit_card_balance, health_benefit_card_requirements, internal_gift_certificate_amount, shipping_handling, shipping_handling_discount, shipping_handling_with_discount, subtotal, subtotal_discount, subtotal_with_discount, surcharge, tax, taxable_subtotal, taxable_subtotal_discount, taxable_subtotal_with_discount, total].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/workflow_task.rb

@@ -38,6 +38,9 @@ module UltracartClient
     # Date/time that the workflow task should delay until
     attr_accessor :delay_until_dts
 
+    # Dependant Workflow Task UUID (must be completed before this task can be completed)
+    attr_accessor :dependant_workflow_task_uuid
+
     # Date/time that the workflow task is due
     attr_accessor :due_dts
 
@@ -68,9 +71,18 @@ module UltracartClient
     # Priority
     attr_accessor :priority
 
+    # Related Workflow Task UUID
+    attr_accessor :related_workflow_task_uuid
+
     # Status of the workflow task
     attr_accessor :status
 
+    # Tags
+    attr_accessor :tags
+
+    # User friendly string of the task context
+    attr_accessor :task_context
+
     # Task Details
     attr_accessor :task_details
 
@@ -113,6 +125,7 @@ module UltracartClient
         :'created_by' => :'created_by',
         :'created_dts' => :'created_dts',
         :'delay_until_dts' => :'delay_until_dts',
+        :'dependant_workflow_task_uuid' => :'dependant_workflow_task_uuid',
         :'due_dts' => :'due_dts',
         :'histories' => :'histories',
         :'last_update_dts' => :'last_update_dts',
@@ -123,7 +136,10 @@ module UltracartClient
         :'object_type' => :'object_type',
         :'object_url' => :'object_url',
         :'priority' => :'priority',
+        :'related_workflow_task_uuid' => :'related_workflow_task_uuid',
         :'status' => :'status',
+        :'tags' => :'tags',
+        :'task_context' => :'task_context',
         :'task_details' => :'task_details',
         :'task_name' => :'task_name',
         :'workflow_task_uuid' => :'workflow_task_uuid'
@@ -146,6 +162,7 @@ module UltracartClient
         :'created_by' => :'WorkflowUser',
         :'created_dts' => :'String',
         :'delay_until_dts' => :'String',
+        :'dependant_workflow_task_uuid' => :'String',
         :'due_dts' => :'String',
         :'histories' => :'Array<WorkflowTaskHistory>',
         :'last_update_dts' => :'String',
@@ -156,7 +173,10 @@ module UltracartClient
         :'object_type' => :'String',
         :'object_url' => :'String',
         :'priority' => :'String',
+        :'related_workflow_task_uuid' => :'String',
         :'status' => :'String',
+        :'tags' => :'Array<String>',
+        :'task_context' => :'String',
         :'task_details' => :'String',
         :'task_name' => :'String',
         :'workflow_task_uuid' => :'String'
@@ -218,6 +238,10 @@ module UltracartClient
         self.delay_until_dts = attributes[:'delay_until_dts']
       end
 
+      if attributes.key?(:'dependant_workflow_task_uuid')
+        self.dependant_workflow_task_uuid = attributes[:'dependant_workflow_task_uuid']
+      end
+
       if attributes.key?(:'due_dts')
         self.due_dts = attributes[:'due_dts']
       end
@@ -262,10 +286,24 @@ module UltracartClient
         self.priority = attributes[:'priority']
       end
 
+      if attributes.key?(:'related_workflow_task_uuid')
+        self.related_workflow_task_uuid = attributes[:'related_workflow_task_uuid']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'task_context')
+        self.task_context = attributes[:'task_context']
+      end
+
       if attributes.key?(:'task_details')
         self.task_details = attributes[:'task_details']
       end
@@ -289,7 +327,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      object_type_validator = EnumAttributeValidator.new('String', ["order", "auto order", "item", "customer profile"])
+      object_type_validator = EnumAttributeValidator.new('String', ["order", "auto order", "item", "customer profile", "storefront"])
       return false unless object_type_validator.valid?(@object_type)
       priority_validator = EnumAttributeValidator.new('String', ["1 - low", "2 - medium", "3 - high", "4 - critical"])
       return false unless priority_validator.valid?(@priority)
@@ -301,7 +339,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] object_type Object to be assigned
     def object_type=(object_type)
-      validator = EnumAttributeValidator.new('String', ["order", "auto order", "item", "customer profile"])
+      validator = EnumAttributeValidator.new('String', ["order", "auto order", "item", "customer profile", "storefront"])
       unless validator.valid?(object_type)
         fail ArgumentError, "invalid value for \"object_type\", must be one of #{validator.allowable_values}."
       end
@@ -341,6 +379,7 @@ module UltracartClient
           created_by == o.created_by &&
           created_dts == o.created_dts &&
           delay_until_dts == o.delay_until_dts &&
+          dependant_workflow_task_uuid == o.dependant_workflow_task_uuid &&
           due_dts == o.due_dts &&
           histories == o.histories &&
           last_update_dts == o.last_update_dts &&
@@ -351,7 +390,10 @@ module UltracartClient
           object_type == o.object_type &&
           object_url == o.object_url &&
           priority == o.priority &&
+          related_workflow_task_uuid == o.related_workflow_task_uuid &&
           status == o.status &&
+          tags == o.tags &&
+          task_context == o.task_context &&
           task_details == o.task_details &&
           task_name == o.task_name &&
           workflow_task_uuid == o.workflow_task_uuid
@@ -366,7 +408,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, due_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, status, task_details, task_name, workflow_task_uuid].hash
+      [assigned_to_group, assigned_to_group_id, assigned_to_user, assigned_to_user_id, attachments, created_by, created_dts, delay_until_dts, dependant_workflow_task_uuid, due_dts, histories, last_update_dts, merchant_id, notes, object_email, object_id, object_type, object_url, priority, related_workflow_task_uuid, status, tags, task_context, task_details, task_name, workflow_task_uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/workflow_tasks_response.rb

@@ -22,6 +22,9 @@ module UltracartClient
     # Indicates if API call was successful
     attr_accessor :success
 
+    # User friendly string of the task context if querying for a specific object type/id
+    attr_accessor :task_context
+
     # tasks
     attr_accessor :tasks
 
@@ -33,6 +36,7 @@ module UltracartClient
         :'error' => :'error',
         :'metadata' => :'metadata',
         :'success' => :'success',
+        :'task_context' => :'task_context',
         :'tasks' => :'tasks',
         :'warning' => :'warning'
       }
@@ -49,6 +53,7 @@ module UltracartClient
         :'error' => :'Error',
         :'metadata' => :'ResponseMetadata',
         :'success' => :'Boolean',
+        :'task_context' => :'String',
         :'tasks' => :'Array<WorkflowTask>',
         :'warning' => :'Warning'
       }
@@ -87,6 +92,10 @@ module UltracartClient
         self.success = attributes[:'success']
       end
 
+      if attributes.key?(:'task_context')
+        self.task_context = attributes[:'task_context']
+      end
+
       if attributes.key?(:'tasks')
         if (value = attributes[:'tasks']).is_a?(Array)
           self.tasks = value
@@ -119,6 +128,7 @@ module UltracartClient
           error == o.error &&
           metadata == o.metadata &&
           success == o.success &&
+          task_context == o.task_context &&
           tasks == o.tasks &&
           warning == o.warning
     end
@@ -132,7 +142,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, metadata, success, tasks, warning].hash
+      [error, metadata, success, task_context, tasks, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.194'
+  VERSION = '4.0.196'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.194
+  version: 4.0.196
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus