ultracart_api 3.10.177 → 3.10.179

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48b225c4ce3b20a653433c433d178492b45afe0fc5d32ab08f7cc17f68b42c2
-  data.tar.gz: ddbb534ce4ff00479e1dec95198483a6ac869bc2552e030bcc51fdbf96e31d87
+  metadata.gz: a30a8f1c4e6966fbd17f9f047e321d91e646c5cedd5b974def1b09bfe9ac61cf
+  data.tar.gz: 40011cb8de421206f3bb3c41ff13ec4a79a660cd01efb9695dbbd3b2095cc241
 SHA512:
-  metadata.gz: f80dfcc8c2f632b27cba07d49bd8628303a250e22ac02d1a273ed5b45febc88c35fb994351ce446b846391bad68bb519ef8b6193474ce163013d173c5c6d2845
-  data.tar.gz: 5aeb3a8f88a362ed40c5210c3476a486f0a7c68f72047ac6ca2c333c41b99849205b8605384dd813ccf8566026e46a175085cc78c28faee6baa33880c5e4e25a
+  metadata.gz: e141a1f7b9d1b575aa2ba4c08821f92fecd5a7324387a95e5f0cf9a80b443aacb3d4a6dc0ab0caf1af162d1da36f12cbb9133e4a9af32eea5e3059528e3037f1
+  data.tar.gz: c61ed8837006d9fffadf49e5c193866ba4a342a50d21e10bebfda7f843e384566c4c45f90b41b1d473ee83459267951ecd5b8a6ecff18c0e4ca27eeecd9f7915

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.177
+- Package version: 3.10.179
 - 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.177.gem
+gem install ./ultracart_api-3.10.179.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.177.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.179.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.177'
+    gem 'ultracart_api', '~> 3.10.179'
 
 ### Install from Git
 
@@ -1398,6 +1398,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.179 | 01/10/2024 | workflow task - add uuids of related tasks and tags |
+| 3.10.178 | 01/03/2024 | workflow - add task_context field to task obj |
 | 3.10.177 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
 | 3.10.176 | 12/12/2023 | webhook - added event ruler property |
 | 3.10.175 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |

data/docs/CartSummary.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **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] 

data/docs/OrderApi.md

@@ -1144,7 +1144,7 @@ Name | Type | Description  | Notes
 
 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. 
 
 ### Example
 ```ruby

data/docs/WorkflowTask.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **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] 
@@ -21,7 +22,10 @@ Name | Type | Description | Notes
 **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] 

data/docs/WorkflowTasksResponse.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **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] 
 

data/lib/ultracart_api/api/order_api.rb

@@ -1270,7 +1270,7 @@ module UltracartClient
       return data, status_code, headers
     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 Order to refund
     # @param order_id The order id to refund.
     # @param [Hash] opts the optional parameters
@@ -1288,7 +1288,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 Order to refund
     # @param order_id The order id to refund.
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/cart_summary.rb

@@ -24,6 +24,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
@@ -58,6 +63,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',
@@ -82,6 +89,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',
@@ -126,6 +135,14 @@ module UltracartClient
         self.health_benefit_card_amount = attributes[:'health_benefit_card_amount']
       end
 
+      if attributes.has_key?(:'health_benefit_card_balance')
+        self.health_benefit_card_balance = attributes[:'health_benefit_card_balance']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_requirements')
+        self.health_benefit_card_requirements = attributes[:'health_benefit_card_requirements']
+      end
+
       if attributes.has_key?(:'internal_gift_certificate_amount')
         self.internal_gift_certificate_amount = attributes[:'internal_gift_certificate_amount']
       end
@@ -202,6 +219,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 &&
@@ -226,7 +245,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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

@@ -37,6 +37,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
 
@@ -67,9 +70,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
 
@@ -112,6 +124,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',
@@ -122,7 +135,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'
@@ -140,6 +156,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',
@@ -150,7 +167,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'
@@ -199,6 +219,10 @@ module UltracartClient
         self.delay_until_dts = attributes[:'delay_until_dts']
       end
 
+      if attributes.has_key?(:'dependant_workflow_task_uuid')
+        self.dependant_workflow_task_uuid = attributes[:'dependant_workflow_task_uuid']
+      end
+
       if attributes.has_key?(:'due_dts')
         self.due_dts = attributes[:'due_dts']
       end
@@ -243,10 +267,24 @@ module UltracartClient
         self.priority = attributes[:'priority']
       end
 
+      if attributes.has_key?(:'related_workflow_task_uuid')
+        self.related_workflow_task_uuid = attributes[:'related_workflow_task_uuid']
+      end
+
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
 
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.has_key?(:'task_context')
+        self.task_context = attributes[:'task_context']
+      end
+
       if attributes.has_key?(:'task_details')
         self.task_details = attributes[:'task_details']
       end
@@ -270,7 +308,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)
@@ -282,7 +320,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
@@ -322,6 +360,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 &&
@@ -332,7 +371,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
@@ -347,7 +389,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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

@@ -21,6 +21,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
 
@@ -32,6 +35,7 @@ module UltracartClient
         :'error' => :'error',
         :'metadata' => :'metadata',
         :'success' => :'success',
+        :'task_context' => :'task_context',
         :'tasks' => :'tasks',
         :'warning' => :'warning'
       }
@@ -43,6 +47,7 @@ module UltracartClient
         :'error' => :'Error',
         :'metadata' => :'ResponseMetadata',
         :'success' => :'BOOLEAN',
+        :'task_context' => :'String',
         :'tasks' => :'Array<WorkflowTask>',
         :'warning' => :'Warning'
       }
@@ -68,6 +73,10 @@ module UltracartClient
         self.success = attributes[:'success']
       end
 
+      if attributes.has_key?(:'task_context')
+        self.task_context = attributes[:'task_context']
+      end
+
       if attributes.has_key?(:'tasks')
         if (value = attributes[:'tasks']).is_a?(Array)
           self.tasks = value
@@ -100,6 +109,7 @@ module UltracartClient
           error == o.error &&
           metadata == o.metadata &&
           success == o.success &&
+          task_context == o.task_context &&
           tasks == o.tasks &&
           warning == o.warning
     end
@@ -113,7 +123,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.177'
+  VERSION = '3.10.179'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.177
+  version: 3.10.179
 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