ultracart_api 4.1.166 → 4.1.168

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 266c6007956d258a4240b14379ada7f14eaa2353428b8dba0e517e9447137b21
-  data.tar.gz: c70906cfe8fc4cc482e4262912f479df7ff51fe718eddb8e124c0cd2067e4e07
+  metadata.gz: a7f4754f78264cf68898eaf7dad3421dcbe656b37b7c4fd52d60854451eb2f58
+  data.tar.gz: 1fc1ed8254ed10d546cec9fa666d2354ab6cd13440420de25eb48f7188e4693e
 SHA512:
-  metadata.gz: 2b5d76248013766630fb40ce05c9f9fe81eb09ab1ae75a02e640cda002c8f872136c0ffef8bcc28a3fa0c0fe5f51a8a43ee9d59c4d8cb7cc72fc853d41766059
-  data.tar.gz: 59b3956e2c8e68b8f917f20c155a8aa48c38d4e5e3056e568b28cf42c29db1a091e9e0cba611a5ffb9d228dbb77701b0e832a4f0a12c809ca5e338d5c691b160
+  metadata.gz: 6c8666281be3c9e01602e209fb58eb0e310e02a4e195e9a92fe03d03a91e26e35430b8c13081c005f75887cedf52d1ba02661db2889bb04c1148dfd1e518c931
+  data.tar.gz: b68167847cce043ede4207626630e8b4c8d7fcb75bb2c93a4eb044dc541b39ba48f9d4480dfe568a5ac2663637f40846ced659e877c3ce972556460e9c9b2196

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.166
+- Package version: 4.1.168
 - 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.166'
+gem 'ultracart_api', '4.1.168'
 ```
 
 install:
@@ -2015,12 +2015,15 @@ Class | Method | HTTP request | Description
 
 
 
+
+
 # CHANGE LOG
 Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
-| 4.1.166 | 09/21/2026 | sfvb internal testing |
+| 4.1.168 | 09/21/2026 | further automation testing |
+| 4.1.167 | 09/21/2026 | automation test |
 | 4.1.165 | 09/21/2026 | automation testing |
 | 4.1.164 | 09/20/2026 | automation testing |
 | 4.1.163 | 09/20/2026 | automation testing |

data/docs/AutoOrderApi.md

@@ -90,8 +90,28 @@ Cancels a single item on an auto order identified by the original order id and t
 
 ### Examples
 
+```ruby
+# Cancel a single item on an auto order, identified by the reference (original) order id
+# that placed the auto order and the original item id on that order. This is useful when
+# you know the original UltraCart order id rather than the auto_order_oid.
 
-(No example for this operation).
+require_relative '../constants'
+require 'ultracart_api'
+
+auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY)
+
+reference_order_id = "DEMO-12345678" # the UltraCart order id that placed the auto order
+original_item_id   = "ITEM001"       # the merchant item id on that original order
+expand             = "items"         # see https://www.ultracart.com/api/#resource_auto_order.html for list
+
+response = auto_order_api.cancel_auto_order_item_by_reference_order_id(
+  reference_order_id,
+  original_item_id,
+  { _expand: expand }
+)
+auto_order = response.auto_order
+puts auto_order.inspect
+```
 
 
 #### Using the cancel_auto_order_item_by_reference_order_id_with_http_info variant
@@ -163,7 +183,7 @@ target_auto_order_oid = 123456789 # set getAutoOrdersByQuery for retrieving auto
 consolidate_request = UltracartClient::AutoOrderConsolidate.new
 consolidate_request.source_auto_order_oids = [23456789, 3456789] # these are the autoorder_oids you wish to consolidate into the target.
 
-api_response = auto_order_api.consolidate_auto_orders(target_auto_order_oid, consolidate_request, { '_expand' => expand })
+api_response = auto_order_api.consolidate_auto_orders(target_auto_order_oid, consolidate_request, { :'_expand' => expand })
 
 consolidated_auto_order = api_response.auto_order
 
@@ -237,7 +257,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
 expand = "items,items.future_schedules,original_order,rebill_orders"
 
 original_order_id = "DEMO-123457"
-api_response = auto_order_api.establish_auto_order_by_reference_order_id(original_order_id, { '_expand' => expand })
+api_response = auto_order_api.establish_auto_order_by_reference_order_id(original_order_id, { :'_expand' => expand })
 
 empty_auto_order = api_response.auto_order
 auto_order_oid = empty_auto_order.auto_order_oid
@@ -255,7 +275,7 @@ items << item
 empty_auto_order.items = items
 
 validate_original_order = 'No'
-api_response = auto_order_api.update_auto_order(auto_order_oid, empty_auto_order,  { '_expand' => expand, validate_original_order: validate_original_order })
+api_response = auto_order_api.update_auto_order(auto_order_oid, empty_auto_order,  { :'_expand' => expand, :'validate_original_order' => validate_original_order })
 updated_auto_order = api_response.auto_order
 puts updated_auto_order.inspect
 ```
@@ -322,7 +342,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
 # see https://www.ultracart.com/api/#resource_auto_order.html for list
 expand = "items,items.future_schedules,original_order,rebill_orders"
 auto_order_oid = 123456789 # If you don't know the oid, use getAutoOrdersByQuery for retrieving auto orders
-api_response = auto_order_api.get_auto_order(auto_order_oid, { '_expand' => expand })
+api_response = auto_order_api.get_auto_order(auto_order_oid, { :'_expand' => expand })
 auto_order = api_response.auto_order
 puts auto_order.inspect
 ```
@@ -451,7 +471,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
 
 expand = "items,items.future_schedules,original_order,rebill_orders" # contact us if you're unsure what you need
 code = "RT2A9CBSX9"
-api_response = auto_order_api.get_auto_order_by_code(code, { '_expand' => expand })
+api_response = auto_order_api.get_auto_order_by_code(code, { :'_expand' => expand })
 auto_order = api_response.auto_order
 
 # this will be verbose...
@@ -577,7 +597,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
 
 expand = "items,items.future_schedules,original_order,rebill_orders" # contact us if you're unsure what you need
 original_order_id = "DEMO-12345678"
-api_response = auto_order_api.get_auto_order_by_reference_order_id(original_order_id, { '_expand' => expand })
+api_response = auto_order_api.get_auto_order_by_reference_order_id(original_order_id, { :'_expand' => expand })
 auto_order = api_response.auto_order
 
 # this will be verbose...
@@ -635,8 +655,23 @@ Retrieves auto order cancel reasons.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# Retrieves the list of cancel reasons that can be presented to customers when
+# cancelling an auto order (e.g., in MyAccount). Each reason includes the reason
+# text, an optional MyAccount alternate description, and whether the reason is
+# visible in MyAccount.
+
+auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY)
+
+api_response = auto_order_api.get_auto_order_cancel_reasons
+
+api_response.cancel_reasons.each do |cancel_reason|
+  puts cancel_reason.inspect
+end
+```
 
 
 #### Using the get_auto_order_cancel_reasons_with_http_info variant
@@ -797,10 +832,31 @@ def get_auto_order_chunk(auto_order_api, offset, limit)
   sort = nil
 
   # see all these parameters?  that is why you should use getAutoOrdersByQuery() instead of getAutoOrders()
-  api_response = auto_order_api.get_auto_orders(auto_order_code, original_order_id, first_name, last_name,
-    company, city, state, postal_code, country_code, phone, email, original_order_date_begin,
-    original_order_date_end, next_shipment_date_begin, next_shipment_date_end, card_type, item_id, status,
-    limit, offset, since, sort, { '_expand' => expand })
+  api_response = auto_order_api.get_auto_orders(
+    {
+      :'auto_order_code' => auto_order_code,
+      :'original_order_id' => original_order_id,
+      :'first_name' =>  first_name,
+      :'last_name' => last_name,
+      :'company' =>  company,
+      :'city' =>  city,
+      :'state' =>  state,
+      :'postal_code' =>  postal_code,
+      :'country_code' =>  country_code,
+      :'phone' =>  phone,
+      :'email' =>  email,
+      :'original_order_date_begin' =>  original_order_date_begin,
+      :'original_order_date_end' =>  original_order_date_end,
+      :'next_shipment_date_begin' =>  next_shipment_date_begin,
+      :'next_shipment_date_end' =>  next_shipment_date_end,
+      :'card_type' =>  card_type,
+      :'item_id' =>  item_id,
+      :'status' =>  status,
+      :'_limit' =>  limit,
+      :'_offset' =>  offset,
+      :'_since' =>  since,
+      :'_sort' =>  sort,
+      :'_expand' => expand })
 
   api_response.auto_orders || []
 end
@@ -954,7 +1010,7 @@ expand = "items,items.future_schedules,original_order,rebill_orders" # contact u
 auto_order_oids = [123456, 234567, 345678, 456789]
 batch_request = UltracartClient::AutoOrderQueryBatch.new
 batch_request.auto_order_oids = auto_order_oids
-api_response = auto_order_api.get_auto_orders_batch(batch_request, { '_expand' => expand })
+api_response = auto_order_api.get_auto_orders_batch(batch_request, { :'_expand' => expand })
 auto_orders = api_response.auto_orders
 
 # this will be verbose...
@@ -1112,10 +1168,10 @@ def get_auto_order_chunk(auto_order_api, offset, limit)
   query.email = "support@ultracart.com"
 
   opts = {
-    _limit: limit,
-    _offset: offset,
-    _sort: "next_shipment_dts",
-    _expand: expand
+    :'_limit' => limit,
+    :'_offset' => offset,
+    :'_sort' => "next_shipment_dts",
+    :'_expand' => expand
   }
 
   api_response = auto_order_api.get_auto_orders_by_query(query, opts)
@@ -1225,7 +1281,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
 
 expand = "items" # see https://www.ultracart.com/api/#resource_auto_order.html for list
 auto_order_oid = 123456789 # get an auto order and update it. There are many ways to retrieve an auto order.
-get_response = auto_order_api.get_auto_order(auto_order_oid, {_expand: expand})
+get_response = auto_order_api.get_auto_order(auto_order_oid, {:'_expand' => expand})
 auto_order = get_response.auto_order
 
 pause_response = auto_order_api.pause_auto_order(auto_order_oid, auto_order)
@@ -1309,7 +1365,7 @@ email = 'test@test.com'
 query = UltracartClient::AutoOrderQuery.new
 query.email = email
 expansion = 'items,items.future_schedules,items.simple_schedule,rebill_orders'
-ao_response = ao_api.get_auto_orders_by_query(query, { _expand: expansion })
+ao_response = ao_api.get_auto_orders_by_query(query, { :'_expand' => expansion })
 
 # there should only be one auto order for a customer.  that's typical.
 # If you are marketing more than one, than you must loop through the result set
@@ -1325,7 +1381,7 @@ auto_order.items.each do |auto_order_item|
 end
 
 # save the auto order with the updated item.
-ao_api.update_auto_order(auto_order, auto_order.auto_order_oid, { _expand: expansion })
+ao_api.update_auto_order(auto_order, auto_order.auto_order_oid, { :'_expand' => expansion })
 
 
 
@@ -1640,9 +1696,9 @@ auto_orders_request = UltracartClient::AutoOrdersRequest.new
 auto_orders_request.auto_orders = auto_orders
 
 opts = {
-  _expand: expand,
-  _placeholders: placeholders,
-  _async: async
+  :'_expand' => expand,
+  :'_placeholders' => placeholders,
+  :'_async' => async
 }
 
 api_response = auto_order_api.update_auto_orders_batch(auto_orders_request, opts)

data/docs/ChannelPartnerApi.md

@@ -592,7 +592,7 @@ _expand = "item,summary,shipping"
 
 # This order MUST be an order associated with this channel partner or you will receive a 400 Bad Request.
 order_id = 'DEMO-0009110366'
-api_response = channel_partner_api.get_channel_partner_order(order_id, { '_expand' => _expand })
+api_response = channel_partner_api.get_channel_partner_order(order_id, { :'_expand' => _expand })
 
 if api_response.error
   STDERR.puts api_response.error.developer_message
@@ -690,7 +690,7 @@ _expand = "item,summary,shipping"
 
 # This order MUST be an order associated with this channel partner or you will receive a 400 Bad Request.
 channel_partner_order_id = 'MY-CALL-CENTER-BLAH-BLAH'
-api_response = channel_partner_api.get_channel_partner_order_by_channel_partner_order_id(channel_partner_order_id, { '_expand' => _expand })
+api_response = channel_partner_api.get_channel_partner_order_by_channel_partner_order_id(channel_partner_order_id, { :'_expand' => _expand })
 
 if api_response.error
   STDERR.puts api_response.error.developer_message
@@ -1482,7 +1482,7 @@ expansion = "item,summary,shipping"
 
 # This order MUST be an order associated with this channel partner, or you will receive a 400 Bad Request.
 order_id = 'DEMO-0009106820'
-api_response = channel_partner_api.get_channel_partner_order(order_id, _expand: expansion)
+api_response = channel_partner_api.get_channel_partner_order(order_id, {:'_expand' => expansion})
 
 if api_response.error
   STDERR.puts api_response.error.developer_message
@@ -1517,15 +1517,15 @@ reverse_affiliate_transactions = true # for a full refund, the affiliate should
 issue_store_credit = false  # if true, the customer would receive store credit instead of a return on their credit card.
 auto_order_cancel_reason = nil
 
-api_response = channel_partner_api.refund_channel_partner_order(order_id, order,
-  reject_after_refund: reject_after_refund,
-  skip_customer_notifications: skip_customer_notifications,
-  auto_order_cancel: auto_order_cancel,
-  manual_refund: manual_refund,
-  reverse_affiliate_transactions: reverse_affiliate_transactions,
-  issue_store_credit: issue_store_credit,
-  auto_order_cancel_reason: auto_order_cancel_reason,
-  _expand: expansion)
+api_response = channel_partner_api.refund_channel_partner_order(order_id, order, {
+  :'reject_after_refund' => reject_after_refund,
+  :'skip_customer_notifications' => skip_customer_notifications,
+  :'auto_order_cancel' => auto_order_cancel,
+  :'manual_refund' => manual_refund,
+  :'reverse_affiliate_transactions' => reverse_affiliate_transactions,
+  :'issue_store_credit' => issue_store_credit,
+  :'auto_order_cancel_reason' => auto_order_cancel_reason,
+  :'_expand' => expansion })
 
 error = api_response.error
 updated_order = api_response.order

data/docs/CheckoutApi.md

@@ -136,7 +136,7 @@ cart_id = cookies[Constants::CART_ID_COOKIE_NAME] if cookies[Constants::CART_ID_
 
 cart = nil
 if cart_id.nil?
-  api_response = checkout_api.get_cart(_expand: expansion)
+  api_response = checkout_api.get_cart({:'_expand' => expansion})
 else
   api_response = checkout_api.get_cart_by_cart_id(cart_id, _expand: expansion)
 end
@@ -537,7 +537,7 @@ expansion = "items,billing,shipping,coupons,checkout,payment,summary,taxes"
 # summary	                    upsell_after
 
 return_code = '1234567890'  # usually retrieved from a query parameter
-api_response = checkout_api.get_cart_by_return_code(return_code, _expand: expansion)
+api_response = checkout_api.get_cart_by_return_code(return_code, {:'_expand' => expansion})
 cart = api_response.cart
 
 # TODO: set or re-set the cart cookie if this is part of a multi-page process. two weeks is a generous cart id time.
@@ -622,7 +622,7 @@ expansion = "items,billing,shipping,coupons,checkout,payment,summary,taxes"
 # summary	                    upsell_after
 
 cart_token = '1234567890'  # usually retrieved from a query parameter
-api_response = checkout_api.get_cart_by_return_token(cart_token, _expand: expansion)
+api_response = checkout_api.get_cart_by_return_token({:'return_token' => cart_token, :'_expand' => expansion})
 cart = api_response.cart
 
 # TODO: set or re-set the cart cookie if this is part of a multi-page process. two weeks is a generous cart id time.
@@ -1220,9 +1220,9 @@ expansion = 'customer_profile,items,billing,shipping,coupons,checkout,payment,su
 cart_id = ENV['HTTP_ULTRACARTSHOPPINGCARTID']
 
 cart = if cart_id.nil?
-          checkout_api.get_cart({_expand: expansion}).cart
+          checkout_api.get_cart({:'_expand' => expansion}).cart
        else
-          checkout_api.get_cart_by_cart_id(cart_id, {_expand: expansion}).cart
+          checkout_api.get_cart_by_cart_id(cart_id, {:'_expand' => expansion}).cart
        end
 
 # TODO - add some items to the cart and update.
@@ -1235,7 +1235,7 @@ items << cart_item
 cart.items = items
 
 # Update the cart
-cart = checkout_api.update_cart(cart, { '_expand' => expansion }).cart
+cart = checkout_api.update_cart(cart, { :'_expand' => expansion }).cart
 
 api_response = checkout_api.related_items_for_cart(cart)
 related_items = api_response.items
@@ -1310,9 +1310,9 @@ expansion = 'customer_profile,items,billing,shipping,coupons,checkout,payment,su
 cart_id = ENV['HTTP_ULTRACARTSHOPPINGCARTID']
 
 cart = if cart_id.nil?
-          checkout_api.get_cart({_expand: expansion}).cart
+          checkout_api.get_cart({:'_expand' => expansion}).cart
        else
-          checkout_api.get_cart_by_cart_id(cart_id, {_expand: expansion}).cart
+          checkout_api.get_cart_by_cart_id(cart_id, {:'_expand' => expansion}).cart
        end
 
 # TODO - add some items to the cart and update.
@@ -1325,11 +1325,11 @@ items << cart_item
 cart.items = items
 
 # Update the cart
-cart = checkout_api.update_cart(cart, { '_expand' => expansion }).cart
+cart = checkout_api.update_cart(cart, {:'_expand' => expansion }).cart
 
 another_item_id = 'ITEM_ZZZ'
 
-api_response = checkout_api.related_items_for_item(another_item_id, cart, { '_expand' => expansion })
+api_response = checkout_api.related_items_for_item(another_item_id, cart, {:'_expand' => expansion })
 related_items = api_response.items
 
 puts related_items.inspect
@@ -1466,11 +1466,11 @@ expansion = 'items' # For this example, we're just getting a cart to insert some
 
 cart_id = nil
 cart_id = ENV['HTTP_COOKIE'].to_s[/#{Constants::CART_ID_COOKIE_NAME}=([^;]+)/, 1] if ENV['HTTP_COOKIE']
-
+opts = { :'_expand' => expansion }
 cart = if cart_id.nil?
-         checkout_api.get_cart({_expand: expansion}).cart
+         checkout_api.get_cart(opts).cart
        else
-         checkout_api.get_cart_by_cart_id(cart_id, {_expand: expansion}).cart
+         checkout_api.get_cart_by_cart_id(cart_id, opts).cart
        end
 
 # Get the items array on the cart, creating it if it doesn't exist.
@@ -1492,7 +1492,7 @@ items << item
 cart.items = items
 
 # Push the cart up to save the item
-cart_response = checkout_api.update_cart(cart, {_expand: expansion})
+cart_response = checkout_api.update_cart(cart, opts)
 
 # Extract the updated cart from the response
 cart = cart_response.cart
@@ -1565,8 +1565,9 @@ checkout_api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY
 cart_id = '123456789123456789123456789123456789' # Usually this would be retrieved from a session variable or cookie.
 
 expansion = 'items,billing,shipping,coupons,checkout,payment,summary,taxes'
+opts = {:'_expand' => expansion}
 
-cart = checkout_api.get_cart_by_cart_id(cart_id, {_expand: expansion}).cart
+cart = checkout_api.get_cart_by_cart_id(cart_id, opts).cart
 
 validation_request = UltracartClient::CartValidationRequest.new
 validation_request.cart = cart
@@ -1574,7 +1575,7 @@ validation_request.cart = cart
 # Possible Checks (you can set these as needed, or leave as default):
 # validation_request.set_checks(["All", "Item Quantity Valid", "Payment Information Validate"])
 
-api_response = checkout_api.validate_cart(validation_request, {_expand: expansion})
+api_response = checkout_api.validate_cart(validation_request, opts)
 cart = api_response.cart
 
 puts "Validation Errors:"

data/docs/CouponApi.md

@@ -499,7 +499,7 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
 coupon_oid = 123456789
 
 # coupons do not have expansions
-api_response = coupon_api.get_coupon(coupon_oid, { _expand: nil })
+api_response = coupon_api.get_coupon(coupon_oid, {})
 
 puts api_response.inspect
 ```
@@ -646,19 +646,19 @@ def get_coupons_chunk(coupon_api, offset = 0, limit = 200)
 
   # getCoupons doesn't have any expansions. full record is always returned.
   opts = {
-    merchant_code: merchant_code,
-    description: description,
-    coupon_type: coupon_type,
-    start_date_begin: start_date_begin,
-    start_date_end: start_date_end,
-    expiration_date_begin: expiration_date_begin,
-    expiration_date_end: expiration_date_end,
-    affiliate_oid: affiliate_oid,
-    exclude_expired: exclude_expired,
-    _limit: limit,
-    _offset: offset,
-    _sort: nil,
-    _expand: nil
+    :'merchant_code' => merchant_code,
+    :'description' => description,
+    :'coupon_type' => coupon_type,
+    :'start_date_begin' => start_date_begin,
+    :'start_date_end' => start_date_end,
+    :'expiration_date_begin' => expiration_date_begin,
+    :'expiration_date_end' => expiration_date_end,
+    :'affiliate_oid' => affiliate_oid,
+    :'exclude_expired' => exclude_expired,
+    :'_limit' => limit,
+    :'_offset' => offset,
+    :'_sort' => nil,
+    :'_expand' => nil
   }
 
   get_response = coupon_api.get_coupons(opts)
@@ -834,8 +834,8 @@ def get_coupon_chunk(coupon_api, offset, limit)
   # coupons do not have expansions
   # Possible sorts: "coupon_type", "merchant_code", "description", "start_dts", "expiration_dts", "quickbooks_code"
   opts = {
-    _expand: nil,
-    _sort: 'merchant_code'
+    :'_expand' => nil,
+    :'_sort' => 'merchant_code'
   }
 
   api_response = coupon_api.get_coupons_by_query(query, limit, offset, opts)
@@ -1042,7 +1042,7 @@ coupon.amount_off_subtotal.discount_amount = 11
 #CouponTierQuantityPercent
 
 # coupons do not have expansions
-api_response = coupon_api.insert_coupon(coupon, {_expand: nil})
+api_response = coupon_api.insert_coupon(coupon, {})
 puts api_response
 ```
 
@@ -1113,7 +1113,7 @@ coupons = []
 coupons_request.coupons = coupons
 
 # coupons do not have expansions or placeholders
-api_response = coupon_api.insert_coupons(coupons_request, {_expand: nil, _placeholders: nil})
+api_response = coupon_api.insert_coupons(coupons_request, {})
 puts api_response
 ```
 
@@ -1316,13 +1316,13 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
 coupon_oid = 123456789
 
 # coupons do not have expansions
-api_response = coupon_api.get_coupon(coupon_oid, {_expand: nil})
+api_response = coupon_api.get_coupon(coupon_oid, {})
 coupon = api_response.coupon
 
 # update the coupon.  this can be difficult given the complexity of coupons.  see insertCoupon sample for details.
 coupon.expiration_dts = (Date.today + 90).strftime('%Y-%m-%d') + 'T00:00:00+00:00'
 
-api_response = coupon_api.update_coupon(coupon_oid, coupon, {_expand: nil})
+api_response = coupon_api.update_coupon(coupon_oid, coupon, {})
 updated_coupon = api_response.coupon
 puts updated_coupon
 ```
@@ -1388,7 +1388,7 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
 coupon_oid = 123456789
 
 # coupons do not have expansions or placeholders
-api_response = coupon_api.get_coupon(coupon_oid, {_expand: nil})
+api_response = coupon_api.get_coupon(coupon_oid, {})
 coupon = api_response.coupon
 
 # update the coupon.  this can be difficult given the complexity of coupons.  see insertCoupon sample for details.
@@ -1398,7 +1398,7 @@ coupon.expiration_dts = (Date.today + 90).strftime('%Y-%m-%d') + 'T00:00:00+00:0
 coupons_request = UltracartClient::CouponsRequest.new
 coupons_request.coupons = [coupon]
 
-api_response = coupon_api.update_coupons(coupons_request, {_expand: nil, _placeholders: nil})
+api_response = coupon_api.update_coupons(coupons_request, {})
 updated_coupons = api_response.coupons
 puts updated_coupons
 ```

data/docs/CustomerApi.md

@@ -555,7 +555,7 @@ begin
   api_response = customer_api.get_customer(
     customer_oid,
     opts: {
-      '_expand' => 'billing,shipping'
+      :'_expand' => 'billing,shipping'
     }
   )
 
@@ -653,7 +653,7 @@ begin
   api_response = customer_api.get_customer_by_email(
     email,
     opts: {
-      '_expand' => 'billing,shipping'
+      :'_expand' => 'billing,shipping'
     }
   )
 
@@ -1991,7 +1991,7 @@ customer.billing = [billing] # notice this is an array of one shipping address (
 #   tags
 #   loyalty
 
-opts = {_expand: 'shipping,billing'}
+opts = {:'_expand' => 'shipping,billing'}
 begin
   customer_response = customer_api.insert_customer(customer, opts)
   puts customer_response.to_json

data/docs/FraudApi.md

@@ -23,8 +23,25 @@ Adds one email address to the fraud decline list for this merchant account.
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# decline_email is a shortcut for telling UltraCart to decline orders from a specific email
+# address.  It is the quick alternative to building a full "address email" fraud rule by hand.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+decline_request = UltracartClient::FraudDeclineEmailRequest.new(
+  email: 'chargeback-charlie@example.com'
+)
 
-(No example for this operation).
+fraud_api.decline_email(decline_request)
+
+puts "Declined email: #{decline_request.email}"
+```
 
 
 #### Using the decline_email_with_http_info variant
@@ -76,8 +93,36 @@ Deletes a fraud rule for this merchant account.
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# delete_fraud_rule removes a fraud rule by its oid.
+#
+# To keep this sample self-contained it first inserts a throwaway rule, then deletes it using
+# the oid returned from the insert.  In your own code you would already have the oid of the rule
+# you want to remove (for example from search_fraud_rules).
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+# Insert a rule so we have something to delete.
+rule = UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card single transaction exceeds',
+  amount_threshold: 2500.00,
+  failure_action: 'Flag For Review',
+  auto_note: 'Temporary rule created by the delete_fraud_rule sample'
+)
+
+insert_response = fraud_api.insert_fraud_rule(rule)
+fraud_rule_oid = insert_response.fraud_rule.fraud_rule_oid
+puts "Inserted temporary rule, oid = #{fraud_rule_oid}"
+
+# Now delete it.
+fraud_api.delete_fraud_rule(fraud_rule_oid)
+puts "Deleted fraud rule oid = #{fraud_rule_oid}"
+```
 
 
 #### Using the delete_fraud_rule_with_http_info variant
@@ -129,8 +174,42 @@ Creates one or more fraud rules for this merchant account derived from an existi
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# establish_fraud_rules_from_order is a shortcut that derives fraud rules from an existing order.
+# Point it at an order you have identified as fraudulent and tell it which attributes of that
+# order to turn into rules: the email, the credit card, the ip address, and/or the address.
+# It creates the matching rules and returns them. This is the fast way to "block everything
+# associated with this bad order" instead of building each rule by hand.
+#
+# Not every filter produces a rule; the order must actually have that attribute. For example an
+# order with no stored card data will not produce a credit card rule.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+request = UltracartClient::FraudRuleFromOrderRequest.new(
+  order_id: 'DEMO-0009104434',
+  establish_email_filter: true,
+  establish_card_filter: true,
+  establish_ip_filter: true,
+  establish_address_filter: true,
+  failure_action: 'Flag For Review',
+  auto_note: 'Established from fraudulent order DEMO-0009104434'
+)
+
+api_response = fraud_api.establish_fraud_rules_from_order(request)
+
+fraud_rules = api_response.fraud_rules
+puts "Established #{fraud_rules.length} rule(s) from the order:"
+
+fraud_rules.each do |fraud_rule|
+  puts "  oid #{fraud_rule.fraud_rule_oid} - #{fraud_rule.rule_type} - #{fraud_rule.auto_note}"
+end
+```
 
 
 #### Using the establish_fraud_rules_from_order_with_http_info variant
@@ -182,8 +261,34 @@ Returns the dropdown values required to build valid fraud rule insert and search
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# get_fraud_lookup_values returns the lookup values used when building fraud rules:
+# the allowed countries, affiliates, ip range types, rule groups, and rule types.
+# Call this first when constructing a rule so you supply valid values.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+api_response = fraud_api.get_fraud_lookup_values
 
-(No example for this operation).
+lookup_values = api_response.fraud_lookup_values
+
+puts 'Rule types:'
+puts lookup_values.rule_types.inspect
+
+puts 'Rule groups:'
+puts lookup_values.rule_groups.inspect
+
+puts 'IP range types:'
+puts lookup_values.ip_range_types.inspect
+
+puts 'Countries:'
+puts lookup_values.countries.inspect
+```
 
 
 #### Using the get_fraud_lookup_values_with_http_info variant
@@ -233,8 +338,79 @@ Creates a fraud rule for this merchant account. Field names in the request body
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# insert_fraud_rule creates a single fraud rule.  Each rule has a rule_type (what it inspects),
+# a failure_action (what happens when it matches), and type-specific fields such as an amount
+# threshold, country code, ip address, or email.
+#
+# This sample has some fun and inserts several rules of different types in one run.  Call
+# get_fraud_lookup_values.rb to see every valid rule_type and the other lookup values.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+rules = []
+
+# 1. Decline any order placed with a known-bad email address.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'address email',
+  email: 'chargeback-charlie@example.com',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Known chargeback email - decline on sight'
+)
+
+# 2. Flag large single credit card transactions over $1,000 for manual review.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card single transaction exceeds',
+  amount_threshold: 1000.00,
+  failure_action: 'Flag For Review',
+  auto_note: 'Large single transaction - review before shipping'
+)
+
+# 3. Decline orders that ship outside the United States.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'address not in country',
+  country_code: 'US',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Domestic shipping only'
+)
+
+# 4. Decline transactions originating from a specific bad IP address.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'ip matches',
+  ip_address: '203.0.113.66',
+  ip_range_type: 'address',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Blocked IP address'
+)
+
+# 5. Flag prepaid credit cards for review.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card block prepaid',
+  failure_action: 'Flag For Review',
+  auto_note: 'Prepaid card - take a closer look'
+)
+
+# 6. Flag a customer IP making more than 10 transactions in a single day.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'ip daily transaction count exceeds',
+  count_threshold: 10,
+  ip_range_type: 'address',
+  user_action: 'Attempted',
+  failure_action: 'Flag For Review',
+  auto_note: 'IP velocity - more than 10 orders in a day'
+)
+
+rules.each do |rule|
+  api_response = fraud_api.insert_fraud_rule(rule)
+  created = api_response.fraud_rule
+  puts "Inserted '#{rule.rule_type}' rule, oid = #{created.fraud_rule_oid}"
+end
+```
 
 
 #### Using the insert_fraud_rule_with_http_info variant
@@ -286,8 +462,33 @@ Searches fraud rules for this merchant account using semantic filter fields. Pag
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# search_fraud_rules returns the fraud rules that match the supplied criteria.  Every field on the
+# FraudRuleSearchRequest is optional; supply only the ones you want to filter on.  Pagination and
+# sort are passed as options (_limit, _offset, _sort).
+#
+# This sample searches for every rule whose action is "Decline Transaction".
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+search_request = UltracartClient::FraudRuleSearchRequest.new(
+  failure_action: 'Decline Transaction'
+)
 
-(No example for this operation).
+api_response = fraud_api.search_fraud_rules(search_request, { _limit: 200, _offset: 0 })
+
+fraud_rules = api_response.fraud_rules
+puts "Found #{fraud_rules.length} rule(s) with action 'Decline Transaction'"
+
+fraud_rules.each do |fraud_rule|
+  puts "  oid #{fraud_rule.fraud_rule_oid} - #{fraud_rule.rule_type} - #{fraud_rule.auto_note}"
+end
+```
 
 
 #### Using the search_fraud_rules_with_http_info variant

data/docs/GiftCertificateApi.md

@@ -470,10 +470,8 @@ api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY,
 def get_gift_certificates_chuck(api, offset, limit)
   expansion = 'ledger'.freeze
   query = UltracartClient::GiftCertificateQuery.new # leaving this empty, so no filtering, and I should get all records returned.
-  api_response = api.get_gift_certificates_by_query(query, { _limit: limit, _offset: offset, _expand: expansion })
-  return api_response.gift_certificates unless api_response.gift_certificates.nil?
-
-  []
+  api_response = api.get_gift_certificates_by_query(query, { :'_limit' => limit, :'_offset' => offset, :'_expand' => expansion })
+  api_response.gift_certificates unless api_response.gift_certificates.nil? []
 end
 
 

data/docs/OrderApi.md

@@ -1300,8 +1300,48 @@ Retrieves the customer activity associated with the email address on this order.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderCustomerActivity returns the customer activity associated with the email address on an order.
+# This includes email engagement history, email list and segment membership, lifetime metrics and email
+# suppression status.
+#
+# A customer profile is NOT required and is not consulted.  The activity is keyed off the email address on
+# the order, so this works for guest orders that have never had a customer profile established.  For the
+# page views captured during the session that placed the order, use get_order_page_view_history instead.
+#
+# If the order has no valid email address, email and customer_activity both come back nil.  That is a
+# successful response rather than an error - without an email there is no activity record to find.
+#
+# Note: activity.ts is a unix timestamp in milliseconds, not an ISO 8601 string like most dates in this API.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_customer_activity(order_id)
+  customer_activity = api_response.customer_activity
+
+  puts "Customer activity for: #{api_response.email}"
+
+  if customer_activity.nil?
+    puts 'No customer activity found for this order.'
+  else
+    puts "Globally unsubscribed: #{customer_activity.global_unsubscribed}"
+    puts "Spam complaint: #{customer_activity.spam_complaint}"
+
+    # Using inspect instead of var_dump for Ruby-style object representation
+    puts customer_activity.activities.inspect
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_customer_activity_with_http_info variant
@@ -1426,8 +1466,52 @@ Retrieves email delivery records associated with the specified order id.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderEmails returns the delivery records for every email UltraCart sent regarding an order, oldest
+# first.  Each record carries the subject and send time plus delivery, open, click and bounce status,
+# which makes this useful evidence that a customer was notified about their order.
+#
+# A customer profile is NOT required.  These records are tied to the order id itself.
+#
+# An order with no email history, or one whose emails were all suppressed, comes back with an empty emails
+# array.  That is a successful response rather than an error.
+#
+# The internal flag marks messages sent to merchant staff rather than to the customer.  Filter those out
+# if you only want what the customer actually received.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_emails(order_id)
+  emails = api_response.emails || []
+
+  if emails.empty?
+    puts 'No emails were sent for this order.'
+  else
+    emails.each do |email|
+      puts "#{email.send_dts} - #{email.email} - #{email.subject}"
+
+      status = []
+      status << "delivered #{email.delivery_dts}" if email.delivered
+      status << "opened #{email.opened_dts}" if email.opened
+      status << "clicked #{email.clicked_dts}" if email.clicked
+      status << "skipped: #{email.skip_reason}" if email.skipped
+      status << "bounced #{email.bounce_type}/#{email.bounce_sub_type}" if email.bounce_type
+
+      puts "    #{status.empty? ? 'no delivery events recorded' : status.join(', ')}"
+    end
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_emails_with_http_info variant
@@ -1479,8 +1563,51 @@ Retrieves the page views captured during the session that placed this order.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderPageViewHistory returns the page views captured during the session that placed an order, along
+# with the referrer that started that session.
+#
+# A customer profile is NOT required.  These page views are keyed off an analytics client id stored on the
+# order itself, so this works for guest orders.  For the email engagement side of customer activity, use
+# get_order_customer_activity instead.
+#
+# An order placed outside the storefront, such as a phone order or an order imported from a channel
+# partner, will have no analytics session attached.  In that case page_views comes back empty.  That is a
+# successful response rather than an error.
+#
+# Note: view_dts is an ISO 8601 string here.  Be aware that the ts field on get_order_customer_activity is
+# unix milliseconds instead, so do not assume the two methods format dates the same way.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_page_view_history(order_id)
+  page_views = api_response.page_views || []
+
+  puts "Session referrer: #{api_response.referrer || '(none captured)'}"
+
+  if page_views.empty?
+    puts 'No page views were captured for this order.'
+  else
+    page_views.each do |page_view|
+      time_on_page = page_view.time_on_page ? " (#{page_view.time_on_page}s on page)" : ''
+      puts "#{page_view.view_dts} - #{page_view.url}#{time_on_page}"
+    end
+
+    # Using inspect instead of var_dump for Ruby-style object representation
+    puts page_views.inspect
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_page_view_history_with_http_info variant
@@ -2283,7 +2410,7 @@ begin
   cc_token = 'F893C8CBAE34830177F9EA9D97205400'
   cvv_token = '3FA7577E42F7580177F9EAA2FF1F5900'
 
-  get_response = checkout_api.get_cart(_expand: expansion)
+  get_response = checkout_api.get_cart({:'_expand' => expansion})
   if get_response.errors&.length&.positive?
     # handle errors here.
     abort('System error.  Could not retrieve shopping cart.')
@@ -2308,7 +2435,7 @@ begin
 
   # If the customer already has a customer profile, then load that profile and pull the shipping/billing from there.
   # otherwise populate it manually.
-  customer_response = customer_api.get_customer_by_email(email, { _expand: 'shipping,billing,cards' })
+  customer_response = customer_api.get_customer_by_email(email, { :'_expand' => 'shipping,billing,cards' })
   if customer_response&.customer
 
     cp = customer_response.customer # cp is short for 'customer profile'
@@ -2378,7 +2505,7 @@ begin
   # the optimal shipping method estimates and ensure that you don't error
   # by selecting a shipping method that is somehow excluded from the possible
   # list for whatever reason (restrictions, locations, item-level constraints, etc)
-  update_response = checkout_api.update_cart(cart, _expand: expansion)
+  update_response = checkout_api.update_cart(cart, {:'_expand' => expansion})
   cart = update_response.cart
 
   # for shipping, check the estimates and select one.  for a completely non-interactive checkout such as this,
@@ -2392,7 +2519,7 @@ begin
     end
   end
 
-  update_response = checkout_api.update_cart(cart, _expand: expansion)
+  update_response = checkout_api.update_cart(cart, {:'_expand' => expansion})
   cart = update_response.cart
 
   # validate the cart to ensure everything is in order.
@@ -2577,7 +2704,7 @@ expansion = "items"   # for this example, we're going to change the items after
 
 # Step 1. Duplicate the order
 order_id_to_duplicate = 'DEMO-0009104436'
-api_response = order_api.duplicate_order(order_id_to_duplicate, opts = { _expand: expansion })
+api_response = order_api.duplicate_order(order_id_to_duplicate, opts = { :'_expand' => expansion })
 new_order = api_response.order
 
 # Step 2. Update the items. I will create a new items array and assign it to the order to remove the old ones completely.
@@ -2600,7 +2727,7 @@ item.weight = weight
 
 items << item
 new_order.items = items
-update_response = order_api.update_order(new_order.order_id, new_order, opts = { _expand: expansion })
+update_response = order_api.update_order(new_order.order_id, new_order, opts = { :'_expand' => expansion })
 
 updated_order = update_response.order
 
@@ -2697,7 +2824,7 @@ expansion = "items"
 
 # Step 1. Retrieve the order
 order_id = 'DEMO-0009104436'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 order.items.each do |item|
   item.quantity_refunded = item.quantity
@@ -3221,13 +3348,13 @@ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
 expansion = "checkout" # see the get_order sample for expansion discussion
 
 order_id = 'DEMO-0009104976'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 p order
 
 # TODO: do some updates to the order.
 
-api_response = order_api.update_order(order_id, order, opts = { _expand: expansion })
+api_response = order_api.update_order(order_id, order, opts = { :'_expand' => expansion })
 
 if api_response.error
   puts api_response.error.developer_message
@@ -3330,7 +3457,7 @@ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
 expansion = "checkout" # see the get_order sample for expansion discussion
 
 order_id = 'DEMO-0009104976'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 p order
 

data/docs/StorefrontApi.md

@@ -1314,8 +1314,9 @@ Delete file manager directory
 
 ### Examples
 
+```ruby
 
-(No example for this operation).
+```
 
 
 #### Using the delete_fs_file_with_http_info variant
@@ -9506,8 +9507,9 @@ Update email sending domain
 
 ### Examples
 
+```ruby
 
-(No example for this operation).
+```
 
 
 #### Using the update_email_sending_domain_with_http_info variant

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.166
+  version: 4.1.168
 platform: ruby
 authors:
 - UltraCart