ultracart_api 3.10.187 → 3.10.188

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17cdf0aa137f414487fec5c4da52010db9191af8fe8bde623fb046dab7201ca
-  data.tar.gz: 4c006506465353652a478aba76972ddb75014be2a4f8d732e4ec7bd84284cc0a
+  metadata.gz: c68d035cefd3446cda8e0ed93df690e80959496e7449c269fa38739ffc8df1a9
+  data.tar.gz: d2c1cfe5336259b5b0dbc01cf0633dc43b7050d3a911fc3863b83f936f57200f
 SHA512:
-  metadata.gz: '00488bd9b47fec1d11db5447f1c28d9aa7ca2aac01dc983cfcae5e2f8588d165d8e9d245bab308408979037c3984a2e904d3f89afe4b54955f275b2137fcbf4b'
-  data.tar.gz: 81127e64bdff43f2852c9bed27461702e1bd4683e26edb651469028057860a666399098b8ea21900ce10552c9a61df1a486f7c2116c6df599c153a329275ef80
+  metadata.gz: 8dba4ea1b5e1bbf150e3c47ad83585d9496a9ef4ddd4103e4c6940fde3d7b0839621cba882f2ace6620d671627d060c126ed8d0ab2ff0558c97cd01cd209994f
+  data.tar.gz: f2d3b55697983f3ce9399e6385d8001c9c6072526640da93290f8b63a5a0c6fc6d28b513e99408b3150bc85a14d51402fc217ceea558239dbd9d885190e48b96

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.187
+- Package version: 3.10.188
 - 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.187.gem
+gem install ./ultracart_api-3.10.188.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.187.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.188.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.187'
+    gem 'ultracart_api', '~> 3.10.188'
 
 ### Install from Git
 
@@ -564,6 +564,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::WorkflowApi* | [**get_workflow_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
 *UltracartClient::WorkflowApi* | [**get_workflow_task_attachment_upload_url**](docs/WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL
 *UltracartClient::WorkflowApi* | [**get_workflow_task_by_object_type**](docs/WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id
+*UltracartClient::WorkflowApi* | [**get_workflow_task_open_count**](docs/WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count
 *UltracartClient::WorkflowApi* | [**get_workflow_task_tags**](docs/WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags
 *UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
 *UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
@@ -1405,6 +1406,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::WorkflowNote](docs/WorkflowNote.md)
  - [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
  - [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
+ - [UltracartClient::WorkflowTaskOpenCountResponse](docs/WorkflowTaskOpenCountResponse.md)
  - [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
  - [UltracartClient::WorkflowTaskTagsResponse](docs/WorkflowTaskTagsResponse.md)
  - [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
@@ -1484,6 +1486,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.188 | 03/19/2024 | workflow task - method to obtain open task count |
 | 3.10.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
 | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |

data/docs/WorkflowApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
 [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL
 [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id
+[**get_workflow_task_open_count**](WorkflowApi.md#get_workflow_task_open_count) | **GET** /workflow/tasks/open_count | Retrieve workflow task open count
 [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags
 [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
 [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
@@ -366,6 +367,51 @@ Name | Type | Description  | Notes
 
 
 
+# **get_workflow_task_open_count**
+> WorkflowTaskOpenCountResponse get_workflow_task_open_count
+
+Retrieve workflow task open count
+
+Retrieve workflow task open count 
+
+### 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::WorkflowApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Retrieve workflow task open count
+  result = api_instance.get_workflow_task_open_count
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_task_open_count: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkflowTaskOpenCountResponse**](WorkflowTaskOpenCountResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_workflow_task_tags**
 > WorkflowTaskTagsResponse get_workflow_task_tags
 

data/docs/WorkflowTaskOpenCountResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::WorkflowTaskOpenCountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**open_count** | **Integer** | Open Task Count | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/WorkflowUsersResponse.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **error** | [**Error**](Error.md) |  | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**my_user_id** | **Integer** | User ID of myself | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
 **users** | [**Array<WorkflowUser>**](WorkflowUser.md) | users | [optional] 
 **warning** | [**Warning**](Warning.md) |  | [optional] 

data/lib/ultracart_api/api/workflow_api.rb

@@ -411,6 +411,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve workflow task open count
+    # Retrieve workflow task open count 
+    # @param [Hash] opts the optional parameters
+    # @return [WorkflowTaskOpenCountResponse]
+    def get_workflow_task_open_count(opts = {})
+      data, _status_code, _headers = get_workflow_task_open_count_with_http_info(opts)
+      data
+    end
+
+    # Retrieve workflow task open count
+    # Retrieve workflow task open count 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WorkflowTaskOpenCountResponse, Fixnum, Hash)>] WorkflowTaskOpenCountResponse data, response status code and response headers
+    def get_workflow_task_open_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_task_open_count ...'
+      end
+      # resource path
+      local_var_path = '/workflow/tasks/open_count'
+
+      # 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 = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'WorkflowTaskOpenCountResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_task_open_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a list of existing workflow task tags
     # Retrieves a unique list of all the existing workflow task tags. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/workflow_task_open_count_response.rb

@@ -0,0 +1,222 @@
+=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 WorkflowTaskOpenCountResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Open Task Count
+    attr_accessor :open_count
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'open_count' => :'open_count',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'open_count' => :'Integer',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'open_count')
+        self.open_count = attributes[:'open_count']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          error == o.error &&
+          metadata == o.metadata &&
+          open_count == o.open_count &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [error, metadata, open_count, success, warning].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/models/workflow_users_response.rb

@@ -18,6 +18,9 @@ module UltracartClient
 
     attr_accessor :metadata
 
+    # User ID of myself
+    attr_accessor :my_user_id
+
     # Indicates if API call was successful
     attr_accessor :success
 
@@ -31,6 +34,7 @@ module UltracartClient
       {
         :'error' => :'error',
         :'metadata' => :'metadata',
+        :'my_user_id' => :'my_user_id',
         :'success' => :'success',
         :'users' => :'users',
         :'warning' => :'warning'
@@ -42,6 +46,7 @@ module UltracartClient
       {
         :'error' => :'Error',
         :'metadata' => :'ResponseMetadata',
+        :'my_user_id' => :'Integer',
         :'success' => :'BOOLEAN',
         :'users' => :'Array<WorkflowUser>',
         :'warning' => :'Warning'
@@ -64,6 +69,10 @@ module UltracartClient
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'my_user_id')
+        self.my_user_id = attributes[:'my_user_id']
+      end
+
       if attributes.has_key?(:'success')
         self.success = attributes[:'success']
       end
@@ -99,6 +108,7 @@ module UltracartClient
       self.class == o.class &&
           error == o.error &&
           metadata == o.metadata &&
+          my_user_id == o.my_user_id &&
           success == o.success &&
           users == o.users &&
           warning == o.warning
@@ -113,7 +123,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [error, metadata, success, users, warning].hash
+      [error, metadata, my_user_id, success, users, 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.187'
+  VERSION = '3.10.188'
 end

data/lib/ultracart_api.rb

@@ -850,6 +850,7 @@ require 'ultracart_api/models/workflow_groups_response'
 require 'ultracart_api/models/workflow_note'
 require 'ultracart_api/models/workflow_task'
 require 'ultracart_api/models/workflow_task_history'
+require 'ultracart_api/models/workflow_task_open_count_response'
 require 'ultracart_api/models/workflow_task_response'
 require 'ultracart_api/models/workflow_task_tags_response'
 require 'ultracart_api/models/workflow_tasks_request'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.187
+  version: 3.10.188
 platform: ruby
 authors:
 - UltraCart
@@ -1075,6 +1075,7 @@ files:
 - docs/WorkflowNote.md
 - docs/WorkflowTask.md
 - docs/WorkflowTaskHistory.md
+- docs/WorkflowTaskOpenCountResponse.md
 - docs/WorkflowTaskResponse.md
 - docs/WorkflowTaskTagsResponse.md
 - docs/WorkflowTasksRequest.md
@@ -1941,6 +1942,7 @@ files:
 - lib/ultracart_api/models/workflow_note.rb
 - lib/ultracart_api/models/workflow_task.rb
 - lib/ultracart_api/models/workflow_task_history.rb
+- lib/ultracart_api/models/workflow_task_open_count_response.rb
 - lib/ultracart_api/models/workflow_task_response.rb
 - lib/ultracart_api/models/workflow_task_tags_response.rb
 - lib/ultracart_api/models/workflow_tasks_request.rb