ultracart_api 4.1.89 → 4.1.90

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b6991a67934dd99f63439e96ded2e8e1d37fb71b4699ae0e2a37dd072e4967
-  data.tar.gz: 82a3228ca2931b8c43d8cb86fc41c30c091acc31081246ac2f68e05507749103
+  metadata.gz: dba53dc1e52b08b39127b7aa9b45e382a32bec2b388b43d577487c0924808c57
+  data.tar.gz: 0330eb32faad3a8a53bada0c4bea5bc15474dd49913ba936805b716b9e08729f
 SHA512:
-  metadata.gz: 40336593e1215053be3a4df0f2428cd09100e860a491d362272ae8a174a73e3bdefe2d97b624da3f346adaa3526d3b61271f2cce86580de0c79b86a784987f95
-  data.tar.gz: 95861ae6d6ea13d2725edab507b25b03d6e701b21ef71f41f4c355e55c2eb3cb93991e065b408d1740521630530edc8c0fd26613ebc335903fabc6b406802b33
+  metadata.gz: 59eb083611de44ce5e14d1bc5610af6a14ca650f94c00ad3903fa489eddf67273ce0ce2a4c50e2a14507ebac21c7ee8270fed3d771202d890480d4e4e04dcb6a
+  data.tar.gz: 2f7b01bf050c2459ad976e4a170556a99edffcc9f38b05fbac76ae2027765cb943b3a286b966d0ef445a44657639d1f5cd594369b39d77cfbd69b47567950591

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.89
+- Package version: 4.1.90
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.89'
+gem 'ultracart_api', '4.1.90'
 ```
 
 install:
@@ -665,6 +665,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/users/{user_id} | Update a user
 *UltracartClient::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /webhook/webhooks/{webhookOid} | Delete a webhook
 *UltracartClient::WebhookApi* | [**delete_webhook_by_url**](docs/WebhookApi.md#delete_webhook_by_url) | **DELETE** /webhook/webhooks | Delete a webhook by URL
+*UltracartClient::WebhookApi* | [**get_webhook_event_categories**](docs/WebhookApi.md#get_webhook_event_categories) | **GET** /webhook/webhook_event_categories | Retrieve webhook event categories
 *UltracartClient::WebhookApi* | [**get_webhook_log**](docs/WebhookApi.md#get_webhook_log) | **GET** /webhook/webhooks/{webhookOid}/logs/{requestId} | Retrieve an individual log
 *UltracartClient::WebhookApi* | [**get_webhook_log_summaries**](docs/WebhookApi.md#get_webhook_log_summaries) | **GET** /webhook/webhooks/{webhookOid}/logs | Retrieve the log summaries
 *UltracartClient::WebhookApi* | [**get_webhooks**](docs/WebhookApi.md#get_webhooks) | **GET** /webhook/webhooks | Retrieve webhooks
@@ -1642,6 +1643,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::VerificationRecord](docs/VerificationRecord.md)
  - [UltracartClient::Warning](docs/Warning.md)
  - [UltracartClient::Webhook](docs/Webhook.md)
+ - [UltracartClient::WebhookEventCategoriesResponse](docs/WebhookEventCategoriesResponse.md)
  - [UltracartClient::WebhookEventCategory](docs/WebhookEventCategory.md)
  - [UltracartClient::WebhookEventSubscription](docs/WebhookEventSubscription.md)
  - [UltracartClient::WebhookLog](docs/WebhookLog.md)
@@ -1746,6 +1748,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.90 | 05/13/2026 | webhook rest api - new method getWebhookEventCategories |
 | 4.1.89 | 05/11/2026 | auto order item level webhooks - cancel scheduled, cancel, pause, reactive, and unpause |
 | 4.1.88 | 05/08/2026 | order page view history |
 | 4.1.87 | 05/08/2026 | order and auto order emails |

data/docs/WebhookApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | ------ | ------------ | ----------- |
 | [**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhook/webhooks/{webhookOid} | Delete a webhook |
 | [**delete_webhook_by_url**](WebhookApi.md#delete_webhook_by_url) | **DELETE** /webhook/webhooks | Delete a webhook by URL |
+| [**get_webhook_event_categories**](WebhookApi.md#get_webhook_event_categories) | **GET** /webhook/webhook_event_categories | Retrieve webhook event categories |
 | [**get_webhook_log**](WebhookApi.md#get_webhook_log) | **GET** /webhook/webhooks/{webhookOid}/logs/{requestId} | Retrieve an individual log |
 | [**get_webhook_log_summaries**](WebhookApi.md#get_webhook_log_summaries) | **GET** /webhook/webhooks/{webhookOid}/logs | Retrieve the log summaries |
 | [**get_webhooks**](WebhookApi.md#get_webhooks) | **GET** /webhook/webhooks | Retrieve webhooks |
@@ -153,6 +154,57 @@ end
 - **Accept**: application/json
 
 
+## get_webhook_event_categories
+
+> <WebhookEventCategoriesResponse> get_webhook_event_categories
+
+Retrieve webhook event categories
+
+Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved.  Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_webhook_event_categories_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookEventCategoriesResponse>, Integer, Hash)> get_webhook_event_categories_with_http_info
+
+```ruby
+begin
+  # Retrieve webhook event categories
+  data, status_code, headers = api_instance.get_webhook_event_categories_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookEventCategoriesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling WebhookApi->get_webhook_event_categories_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebhookEventCategoriesResponse**](WebhookEventCategoriesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_webhook_log
 
 > <WebhookLogResponse> get_webhook_log(webhook_oid, request_id)

data/docs/WebhookEventCategoriesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::WebhookEventCategoriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **event_categories** | [**Array<WebhookEventCategory>**](WebhookEventCategory.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::WebhookEventCategoriesResponse.new(
+  error: null,
+  event_categories: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/lib/ultracart_api/api/webhook_api.rb

@@ -165,6 +165,64 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve webhook event categories
+    # Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved.  Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog. 
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookEventCategoriesResponse]
+    def get_webhook_event_categories(opts = {})
+      data, _status_code, _headers = get_webhook_event_categories_with_http_info(opts)
+      data
+    end
+
+    # Retrieve webhook event categories
+    # Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved.  Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookEventCategoriesResponse, Integer, Hash)>] WebhookEventCategoriesResponse data, response status code and response headers
+    def get_webhook_event_categories_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookApi.get_webhook_event_categories ...'
+      end
+      # resource path
+      local_var_path = '/webhook/webhook_event_categories'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookEventCategoriesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"WebhookApi.get_webhook_event_categories",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookApi#get_webhook_event_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve an individual log
     # Retrieves an individual log for a webhook given the webhook oid the request id. 
     # @param webhook_oid [Integer] The webhook oid that owns the log.

data/lib/ultracart_api/models/webhook_event_categories_response.rb

@@ -0,0 +1,258 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class WebhookEventCategoriesResponse
+    attr_accessor :error
+
+    attr_accessor :event_categories
+
+    attr_accessor :metadata
+
+    # 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',
+        :'event_categories' => :'event_categories',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Error',
+        :'event_categories' => :'Array<WebhookEventCategory>',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::WebhookEventCategoriesResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::WebhookEventCategoriesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'event_categories')
+        if (value = attributes[:'event_categories']).is_a?(Array)
+          self.event_categories = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.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 &&
+          event_categories == o.event_categories &&
+          metadata == o.metadata &&
+          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 [Integer] Hash code
+    def hash
+      [error, event_categories, metadata, 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 self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.89'
+  VERSION = '4.1.90'
 end

data/lib/ultracart_api.rb

@@ -972,6 +972,7 @@ require 'ultracart_api/models/users_response'
 require 'ultracart_api/models/verification_record'
 require 'ultracart_api/models/warning'
 require 'ultracart_api/models/webhook'
+require 'ultracart_api/models/webhook_event_categories_response'
 require 'ultracart_api/models/webhook_event_category'
 require 'ultracart_api/models/webhook_event_subscription'
 require 'ultracart_api/models/webhook_log'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.89
+  version: 4.1.90
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-11 00:00:00.000000000 Z
+date: 2026-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1036,6 +1036,7 @@ files:
 - docs/Warning.md
 - docs/Webhook.md
 - docs/WebhookApi.md
+- docs/WebhookEventCategoriesResponse.md
 - docs/WebhookEventCategory.md
 - docs/WebhookEventSubscription.md
 - docs/WebhookLog.md
@@ -2047,6 +2048,7 @@ files:
 - lib/ultracart_api/models/verification_record.rb
 - lib/ultracart_api/models/warning.rb
 - lib/ultracart_api/models/webhook.rb
+- lib/ultracart_api/models/webhook_event_categories_response.rb
 - lib/ultracart_api/models/webhook_event_category.rb
 - lib/ultracart_api/models/webhook_event_subscription.rb
 - lib/ultracart_api/models/webhook_log.rb