ultracart_api 3.10.175 → 3.10.177

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 384f2abf4964cff46e802b7dae7d6b07a0290ce8b2113c1f4e3e7a2c10108e56
-  data.tar.gz: 80b75b74c97d498f027804114c37789950a305ba6c55af59155113cdaef30010
+  metadata.gz: d48b225c4ce3b20a653433c433d178492b45afe0fc5d32ab08f7cc17f68b42c2
+  data.tar.gz: ddbb534ce4ff00479e1dec95198483a6ac869bc2552e030bcc51fdbf96e31d87
 SHA512:
-  metadata.gz: 86f4daf782b854684ff2cda62675da345d903dee9a89de60a40aa956cb29c06814f1d0fe924bd2a087f1dc0f50627c807dee75b772f7a16dc8e2a0a5abc93f49
-  data.tar.gz: 8fda788f6a937e6b4210e24d11bf8fb3fc25afcc8d05d2e328ec9093ade66efed8b9cfede17970f3c670aecdf5932e9500f3a23fe0d3f1e09361491479bf24d4
+  metadata.gz: f80dfcc8c2f632b27cba07d49bd8628303a250e22ac02d1a273ed5b45febc88c35fb994351ce446b846391bad68bb519ef8b6193474ce163013d173c5c6d2845
+  data.tar.gz: 5aeb3a8f88a362ed40c5210c3476a486f0a7c68f72047ac6ca2c333c41b99849205b8605384dd813ccf8566026e46a175085cc78c28faee6baa33880c5e4e25a

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.175
+- Package version: 3.10.177
 - 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.175.gem
+gem install ./ultracart_api-3.10.177.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.175.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.177.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.175'
+    gem 'ultracart_api', '~> 3.10.177'
 
 ### Install from Git
 
@@ -514,6 +514,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_groups**](docs/WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
 *UltracartClient::WorkflowApi* | [**get_workflow_assignment_users**](docs/WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
+*UltracartClient::WorkflowApi* | [**get_workflow_me**](docs/WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
 *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
@@ -1323,6 +1324,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
  - [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
  - [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
+ - [UltracartClient::WorkflowUserResponse](docs/WorkflowUserResponse.md)
  - [UltracartClient::WorkflowUsersResponse](docs/WorkflowUsersResponse.md)
 
 
@@ -1396,6 +1398,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 3.10.174 | 11/20/2023 | coupon - add item tag support to percent off items and free shipping |
 | 3.10.173 | 11/20/2023 | item.google_product_search.color bugfix for bad length validation: 20 to 100 |

data/docs/WebhookEventSubscription.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **discontinued_flag** | **BOOLEAN** | True if the event is discontinued.  See the API change log for details on migration details. | [optional] 
 **event_description** | **String** | Description of the event | [optional] 
 **event_name** | **String** | Event name | [optional] 
+**event_ruler** | **String** | Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook. | [optional] 
 **expansion** | **String** | The expand string for the notification object.  See the individual resource _expand documentation for valid values. | [optional] 
 **subscribed** | **BOOLEAN** | True if this is event is subscribed to | [optional] 
 **supports_reflow** | **BOOLEAN** | True if the event can be triggered to reflow existing records | [optional] 

data/docs/WorkflowApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to
 [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to
+[**get_workflow_me**](WorkflowApi.md#get_workflow_me) | **GET** /workflow/me | Retrieve a user object for myself
 [**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
@@ -120,6 +121,51 @@ Name | Type | Description  | Notes
 
 
 
+# **get_workflow_me**
+> WorkflowUserResponse get_workflow_me
+
+Retrieve a user object for myself
+
+Retrieve a user object for myself 
+
+### 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 a user object for myself
+  result = api_instance.get_workflow_me
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling WorkflowApi->get_workflow_me: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkflowUserResponse**](WorkflowUserResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_workflow_task**
 > WorkflowTaskResponse get_workflow_task(task_uuid)
 

data/docs/WorkflowUserResponse.md

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

data/lib/ultracart_api/api/workflow_api.rb

@@ -142,6 +142,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve a user object for myself
+    # Retrieve a user object for myself 
+    # @param [Hash] opts the optional parameters
+    # @return [WorkflowUserResponse]
+    def get_workflow_me(opts = {})
+      data, _status_code, _headers = get_workflow_me_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a user object for myself
+    # Retrieve a user object for myself 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WorkflowUserResponse, Fixnum, Hash)>] WorkflowUserResponse data, response status code and response headers
+    def get_workflow_me_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowApi.get_workflow_me ...'
+      end
+      # resource path
+      local_var_path = '/workflow/me'
+
+      # 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 => 'WorkflowUserResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowApi#get_workflow_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve a workflow task
     # Retrieve a workflow task 
     # @param task_uuid 

data/lib/ultracart_api/models/webhook_event_subscription.rb

@@ -29,6 +29,9 @@ module UltracartClient
     # Event name
     attr_accessor :event_name
 
+    # Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook.
+    attr_accessor :event_ruler
+
     # The expand string for the notification object.  See the individual resource _expand documentation for valid values.
     attr_accessor :expansion
 
@@ -49,6 +52,7 @@ module UltracartClient
         :'discontinued_flag' => :'discontinued_flag',
         :'event_description' => :'event_description',
         :'event_name' => :'event_name',
+        :'event_ruler' => :'event_ruler',
         :'expansion' => :'expansion',
         :'subscribed' => :'subscribed',
         :'supports_reflow' => :'supports_reflow',
@@ -64,6 +68,7 @@ module UltracartClient
         :'discontinued_flag' => :'BOOLEAN',
         :'event_description' => :'String',
         :'event_name' => :'String',
+        :'event_ruler' => :'String',
         :'expansion' => :'String',
         :'subscribed' => :'BOOLEAN',
         :'supports_reflow' => :'BOOLEAN',
@@ -99,6 +104,10 @@ module UltracartClient
         self.event_name = attributes[:'event_name']
       end
 
+      if attributes.has_key?(:'event_ruler')
+        self.event_ruler = attributes[:'event_ruler']
+      end
+
       if attributes.has_key?(:'expansion')
         self.expansion = attributes[:'expansion']
       end
@@ -139,6 +148,7 @@ module UltracartClient
           discontinued_flag == o.discontinued_flag &&
           event_description == o.event_description &&
           event_name == o.event_name &&
+          event_ruler == o.event_ruler &&
           expansion == o.expansion &&
           subscribed == o.subscribed &&
           supports_reflow == o.supports_reflow &&
@@ -154,7 +164,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [comments, deprecated_flag, discontinued_flag, event_description, event_name, expansion, subscribed, supports_reflow, webhook_event_oid].hash
+      [comments, deprecated_flag, discontinued_flag, event_description, event_name, event_ruler, expansion, subscribed, supports_reflow, webhook_event_oid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/workflow_user_response.rb

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

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

data/lib/ultracart_api.rb

@@ -816,6 +816,7 @@ require 'ultracart_api/models/workflow_task_response'
 require 'ultracart_api/models/workflow_tasks_request'
 require 'ultracart_api/models/workflow_tasks_response'
 require 'ultracart_api/models/workflow_user'
+require 'ultracart_api/models/workflow_user_response'
 require 'ultracart_api/models/workflow_users_response'
 
 # APIs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.175
+  version: 3.10.177
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1041,6 +1041,7 @@ files:
 - docs/WorkflowTasksRequest.md
 - docs/WorkflowTasksResponse.md
 - docs/WorkflowUser.md
+- docs/WorkflowUserResponse.md
 - docs/WorkflowUsersResponse.md
 - git_push.sh
 - lib/ultracart_api.rb
@@ -1867,6 +1868,7 @@ files:
 - lib/ultracart_api/models/workflow_tasks_request.rb
 - lib/ultracart_api/models/workflow_tasks_response.rb
 - lib/ultracart_api/models/workflow_user.rb
+- lib/ultracart_api/models/workflow_user_response.rb
 - lib/ultracart_api/models/workflow_users_response.rb
 - lib/ultracart_api/version.rb
 - spec/api_client_spec.rb