ultracart_api 4.1.220 → 4.1.221

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f468a5a838e0757e3d1c52895907d01171a84e8c78886210c10a23ef59c2d4
-  data.tar.gz: 585ebaf78936ba8ca36c7f42737e08825d35bc06eeeaa85dfe32e8fdcd79ce06
+  metadata.gz: 4267bcfb9ff75c959b4bcb691612a889458a32f1bb98c34f2930c02f591ab493
+  data.tar.gz: 8350f1778b128b70b8fe74fe40513082f5eab243ef11ce7f701b6849e6a61892
 SHA512:
-  metadata.gz: c49285cea1818a391a316891abf1916c0a9aedfd1b936c9b49df28f261743607c742d9e249b25577fdf7dfdf6fc5dc2b1eb8f0c36eb91e434101d2e059a5ef03
-  data.tar.gz: 36ce759345a12d073a59301cc2dbbfea1f2ac943842b42c41c51967d0f0f82832a9a457c910b6c187ee9e9fb308d2638ab0d159f0dfb513fa932aa76f442aeb2
+  metadata.gz: a1aea1e4700ef49b020d24e0ba38ccc8172b37d4f8d87eba25070c0823323f61b9e075ca777a75ee74171471bbb52c390a37d01d2667186e23287328d5c3f8f3
+  data.tar.gz: b587b333770e47e1d8e7b0018b3c025f560c7e952d22b43ca0c58cf875834d9b7d6cce4b57d99908cd85a05a40713c7ab607797f7de87c648a255b03790443e2

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.220
+- Package version: 4.1.221
 - 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.220'
+gem 'ultracart_api', '4.1.221'
 ```
 
 install:
@@ -623,6 +623,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**list_sfvb_upsell_paths**](docs/SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths
 *UltracartClient::SfvbApi* | [**move_sfvb_sequence_step**](docs/SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step
 *UltracartClient::SfvbApi* | [**move_sfvb_upsell_path**](docs/SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path
+*UltracartClient::SfvbApi* | [**proof_sfvb_sequence_postcard**](docs/SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it
 *UltracartClient::SfvbApi* | [**publish_sfvb_library_entry**](docs/SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft
 *UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
 *UltracartClient::SfvbApi* | [**put_sfvb_experiment_variation**](docs/SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation
@@ -2084,6 +2085,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
  - [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
  - [UltracartClient::SfvbPageSummary](docs/SfvbPageSummary.md)
+ - [UltracartClient::SfvbPostcardProofRequest](docs/SfvbPostcardProofRequest.md)
+ - [UltracartClient::SfvbPostcardProofResponse](docs/SfvbPostcardProofResponse.md)
  - [UltracartClient::SfvbPreviewAccessRequest](docs/SfvbPreviewAccessRequest.md)
  - [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
@@ -2349,6 +2352,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.221 | 11/02/2026 | sfvb internal testing |
 | 4.1.220 | 11/02/2026 | sfvb internal testing |
 | 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
 | 4.1.218 | 10/30/2026 | svfb internal testing |

data/docs/SfvbApi.md

@@ -151,6 +151,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**list_sfvb_upsell_paths**](SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths |
 | [**move_sfvb_sequence_step**](SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step |
 | [**move_sfvb_upsell_path**](SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path |
+| [**proof_sfvb_sequence_postcard**](SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it |
 | [**publish_sfvb_library_entry**](SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft |
 | [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
 | [**put_sfvb_experiment_variation**](SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation |
@@ -8214,6 +8215,62 @@ end
 - **Accept**: application/json
 
 
+## proof_sfvb_sequence_postcard
+
+> <SfvbPostcardProofResponse> proof_sfvb_sequence_postcard(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
+
+Proof a postcard step without mailing it
+
+Renders both sides of the step's postcard as a send renders them, then has the print vendor render the card as a dry run.  Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor's thumbnails and its proof PDF.  The QR code is the short link a send prints.  No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created.  A unique coupon code shows as PREVIEW-UNIQUE.  The image urls are public.  html_only returns the HTML alone, with no vendor render.  An order must be a test order.  cart_item_ids fills the cart a cart flow card shows.  Works whether the step is on or off. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the proof_sfvb_sequence_postcard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPostcardProofResponse>, Integer, Hash)> proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
+
+```ruby
+begin
+  # Proof a postcard step without mailing it
+  data, status_code, headers = api_instance.proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPostcardProofResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->proof_sfvb_sequence_postcard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **sequence_uuid** | **String** |  |  |
+| **step_uuid** | **String** |  |  |
+| **postcard_proof_request** | [**SfvbPostcardProofRequest**](SfvbPostcardProofRequest.md) | Who the card is addressed to, and the order or cart it shows |  |
+
+### Return type
+
+[**SfvbPostcardProofResponse**](SfvbPostcardProofResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## publish_sfvb_library_entry
 
 > <SfvbLibraryEntry> publish_sfvb_library_entry(storefront_oid, library_oid, if_match, publish_request)

data/docs/SfvbPostcardProofRequest.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbPostcardProofRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | The recipient street address.  Without address1, city, state and postal_code, a sample address is used. | [optional] |
+| **address2** | **String** | The recipient second address line. | [optional] |
+| **cart_item_ids** | **Array<String>** | Item ids for the cart a cart flow card renders with.  The cart is made for the proof and deleted after it. | [optional] |
+| **city** | **String** | The recipient city. | [optional] |
+| **customer_name** | **String** | The recipient name the card greets and is addressed to.  Defaults to the signed in user. | [optional] |
+| **html_only** | **Boolean** | True to return only the rendered HTML of both sides, with no print vendor render.  The default, false, also returns the images that would print and the vendor proof PDF. | [optional] |
+| **order_id** | **String** | A test order for an order flow card.  Real orders are refused.  Without one, an order flow card renders with a made up order. | [optional] |
+| **postal_code** | **String** | The recipient postal code. | [optional] |
+| **state** | **String** | The recipient state. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardProofRequest.new(
+  address1: null,
+  address2: null,
+  cart_item_ids: null,
+  city: null,
+  customer_name: null,
+  html_only: null,
+  order_id: null,
+  postal_code: null,
+  state: null
+)
+```
+

data/docs/SfvbPostcardProofResponse.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbPostcardProofResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **back_html** | **String** | The back as the send renders it, after the name tokens are filled. | [optional] |
+| **back_image_url** | **String** | The back as the PNG image the print vendor prints from.  A public url. | [optional] |
+| **back_thumbnail_url** | **String** | The print vendor thumbnail of the back. | [optional] |
+| **front_html** | **String** | The front as the send renders it, after the name tokens are filled. | [optional] |
+| **front_image_url** | **String** | The front as the PNG image the print vendor prints from.  A public url. | [optional] |
+| **front_thumbnail_url** | **String** | The print vendor thumbnail of the front. | [optional] |
+| **order_source** | **String** | Where the order came from.  test for the order_id given, dummy for a made up one, none for no order. | [optional] |
+| **postcard_uuid** | **String** | The postcard the step mails. | [optional] |
+| **rendered_pdf_url** | **String** | The print vendor proof PDF of both sides. | [optional] |
+| **vendor_rendered** | **Boolean** | True when the print vendor rendered the card, so the image and PDF urls are set. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardProofResponse.new(
+  back_html: null,
+  back_image_url: null,
+  back_thumbnail_url: null,
+  front_html: null,
+  front_image_url: null,
+  front_thumbnail_url: null,
+  order_source: null,
+  postcard_uuid: null,
+  rendered_pdf_url: null,
+  vendor_rendered: null,
+  warnings: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -10583,6 +10583,93 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Proof a postcard step without mailing it
+    # Renders both sides of the step's postcard as a send renders them, then has the print vendor render the card as a dry run.  Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor's thumbnails and its proof PDF.  The QR code is the short link a send prints.  No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created.  A unique coupon code shows as PREVIEW-UNIQUE.  The image urls are public.  html_only returns the HTML alone, with no vendor render.  An order must be a test order.  cart_item_ids fills the cart a cart flow card shows.  Works whether the step is on or off. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param step_uuid [String] 
+    # @param postcard_proof_request [SfvbPostcardProofRequest] Who the card is addressed to, and the order or cart it shows
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbPostcardProofResponse]
+    def proof_sfvb_sequence_postcard(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request, opts = {})
+      data, _status_code, _headers = proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request, opts)
+      data
+    end
+
+    # Proof a postcard step without mailing it
+    # Renders both sides of the step's postcard as a send renders them, then has the print vendor render the card as a dry run.  Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor's thumbnails and its proof PDF.  The QR code is the short link a send prints.  No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created.  A unique coupon code shows as PREVIEW-UNIQUE.  The image urls are public.  html_only returns the HTML alone, with no vendor render.  An order must be a test order.  cart_item_ids fills the cart a cart flow card shows.  Works whether the step is on or off. 
+    # @param storefront_oid [Integer] 
+    # @param sequence_uuid [String] 
+    # @param step_uuid [String] 
+    # @param postcard_proof_request [SfvbPostcardProofRequest] Who the card is addressed to, and the order or cart it shows
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbPostcardProofResponse, Integer, Hash)>] SfvbPostcardProofResponse data, response status code and response headers
+    def proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.proof_sfvb_sequence_postcard ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.proof_sfvb_sequence_postcard"
+      end
+      # verify the required parameter 'sequence_uuid' is set
+      if @api_client.config.client_side_validation && sequence_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.proof_sfvb_sequence_postcard"
+      end
+      # verify the required parameter 'step_uuid' is set
+      if @api_client.config.client_side_validation && step_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.proof_sfvb_sequence_postcard"
+      end
+      # verify the required parameter 'postcard_proof_request' is set
+      if @api_client.config.client_side_validation && postcard_proof_request.nil?
+        fail ArgumentError, "Missing the required parameter 'postcard_proof_request' when calling SfvbApi.proof_sfvb_sequence_postcard"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(postcard_proof_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbPostcardProofResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.proof_sfvb_sequence_postcard",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#proof_sfvb_sequence_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Publish a library entry's draft
     # Freezes the draft as a published revision at its revision_number and sets who can see it.  Owner only, with the draft's hash_sha256 as If-Match.  Always needs sfvb_publish, because it changes what other merchants can install.  Images, fonts, stylesheets and media must be relative paths, and credential shaped strings are refused.  Public also needs the library publisher property on the account and no executable content at all - no script, html, embed, css or velocity elements.  After those checks an automated AI review reads the fragment, which can take up to about a minute.  A clear violation both of its models agree on refuses any publish with sfvb.library_ai_review_blocked.  A public publish also needs its approval, otherwise sfvb.library_ai_review_inconclusive.  The result is in content_manifest.ai_review. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_postcard_proof_request.rb

@@ -0,0 +1,302 @@
+=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 SfvbPostcardProofRequest
+    # The recipient street address.  Without address1, city, state and postal_code, a sample address is used.
+    attr_accessor :address1
+
+    # The recipient second address line.
+    attr_accessor :address2
+
+    # Item ids for the cart a cart flow card renders with.  The cart is made for the proof and deleted after it.
+    attr_accessor :cart_item_ids
+
+    # The recipient city.
+    attr_accessor :city
+
+    # The recipient name the card greets and is addressed to.  Defaults to the signed in user.
+    attr_accessor :customer_name
+
+    # True to return only the rendered HTML of both sides, with no print vendor render.  The default, false, also returns the images that would print and the vendor proof PDF.
+    attr_accessor :html_only
+
+    # A test order for an order flow card.  Real orders are refused.  Without one, an order flow card renders with a made up order.
+    attr_accessor :order_id
+
+    # The recipient postal code.
+    attr_accessor :postal_code
+
+    # The recipient state.
+    attr_accessor :state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'cart_item_ids' => :'cart_item_ids',
+        :'city' => :'city',
+        :'customer_name' => :'customer_name',
+        :'html_only' => :'html_only',
+        :'order_id' => :'order_id',
+        :'postal_code' => :'postal_code',
+        :'state' => :'state'
+      }
+    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
+      {
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'cart_item_ids' => :'Array<String>',
+        :'city' => :'String',
+        :'customer_name' => :'String',
+        :'html_only' => :'Boolean',
+        :'order_id' => :'String',
+        :'postal_code' => :'String',
+        :'state' => :'String'
+      }
+    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::SfvbPostcardProofRequest` 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::SfvbPostcardProofRequest`. 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?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.key?(:'cart_item_ids')
+        if (value = attributes[:'cart_item_ids']).is_a?(Array)
+          self.cart_item_ids = value
+        end
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'customer_name')
+        self.customer_name = attributes[:'customer_name']
+      end
+
+      if attributes.key?(:'html_only')
+        self.html_only = attributes[:'html_only']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      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 &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          cart_item_ids == o.cart_item_ids &&
+          city == o.city &&
+          customer_name == o.customer_name &&
+          html_only == o.html_only &&
+          order_id == o.order_id &&
+          postal_code == o.postal_code &&
+          state == o.state
+    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
+      [address1, address2, cart_item_ids, city, customer_name, html_only, order_id, postal_code, state].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/models/sfvb_postcard_proof_response.rb

@@ -0,0 +1,356 @@
+=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 SfvbPostcardProofResponse
+    # The back as the send renders it, after the name tokens are filled.
+    attr_accessor :back_html
+
+    # The back as the PNG image the print vendor prints from.  A public url.
+    attr_accessor :back_image_url
+
+    # The print vendor thumbnail of the back.
+    attr_accessor :back_thumbnail_url
+
+    # The front as the send renders it, after the name tokens are filled.
+    attr_accessor :front_html
+
+    # The front as the PNG image the print vendor prints from.  A public url.
+    attr_accessor :front_image_url
+
+    # The print vendor thumbnail of the front.
+    attr_accessor :front_thumbnail_url
+
+    # Where the order came from.  test for the order_id given, dummy for a made up one, none for no order.
+    attr_accessor :order_source
+
+    # The postcard the step mails.
+    attr_accessor :postcard_uuid
+
+    # The print vendor proof PDF of both sides.
+    attr_accessor :rendered_pdf_url
+
+    # True when the print vendor rendered the card, so the image and PDF urls are set.
+    attr_accessor :vendor_rendered
+
+    # Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card.
+    attr_accessor :warnings
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'back_html' => :'back_html',
+        :'back_image_url' => :'back_image_url',
+        :'back_thumbnail_url' => :'back_thumbnail_url',
+        :'front_html' => :'front_html',
+        :'front_image_url' => :'front_image_url',
+        :'front_thumbnail_url' => :'front_thumbnail_url',
+        :'order_source' => :'order_source',
+        :'postcard_uuid' => :'postcard_uuid',
+        :'rendered_pdf_url' => :'rendered_pdf_url',
+        :'vendor_rendered' => :'vendor_rendered',
+        :'warnings' => :'warnings'
+      }
+    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
+      {
+        :'back_html' => :'String',
+        :'back_image_url' => :'String',
+        :'back_thumbnail_url' => :'String',
+        :'front_html' => :'String',
+        :'front_image_url' => :'String',
+        :'front_thumbnail_url' => :'String',
+        :'order_source' => :'String',
+        :'postcard_uuid' => :'String',
+        :'rendered_pdf_url' => :'String',
+        :'vendor_rendered' => :'Boolean',
+        :'warnings' => :'Array<SfvbErrorDetail>'
+      }
+    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::SfvbPostcardProofResponse` 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::SfvbPostcardProofResponse`. 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?(:'back_html')
+        self.back_html = attributes[:'back_html']
+      end
+
+      if attributes.key?(:'back_image_url')
+        self.back_image_url = attributes[:'back_image_url']
+      end
+
+      if attributes.key?(:'back_thumbnail_url')
+        self.back_thumbnail_url = attributes[:'back_thumbnail_url']
+      end
+
+      if attributes.key?(:'front_html')
+        self.front_html = attributes[:'front_html']
+      end
+
+      if attributes.key?(:'front_image_url')
+        self.front_image_url = attributes[:'front_image_url']
+      end
+
+      if attributes.key?(:'front_thumbnail_url')
+        self.front_thumbnail_url = attributes[:'front_thumbnail_url']
+      end
+
+      if attributes.key?(:'order_source')
+        self.order_source = attributes[:'order_source']
+      end
+
+      if attributes.key?(:'postcard_uuid')
+        self.postcard_uuid = attributes[:'postcard_uuid']
+      end
+
+      if attributes.key?(:'rendered_pdf_url')
+        self.rendered_pdf_url = attributes[:'rendered_pdf_url']
+      end
+
+      if attributes.key?(:'vendor_rendered')
+        self.vendor_rendered = attributes[:'vendor_rendered']
+      end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      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?
+      order_source_validator = EnumAttributeValidator.new('String', ["test", "dummy", "none"])
+      return false unless order_source_validator.valid?(@order_source)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] order_source Object to be assigned
+    def order_source=(order_source)
+      validator = EnumAttributeValidator.new('String', ["test", "dummy", "none"])
+      unless validator.valid?(order_source)
+        fail ArgumentError, "invalid value for \"order_source\", must be one of #{validator.allowable_values}."
+      end
+      @order_source = order_source
+    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 &&
+          back_html == o.back_html &&
+          back_image_url == o.back_image_url &&
+          back_thumbnail_url == o.back_thumbnail_url &&
+          front_html == o.front_html &&
+          front_image_url == o.front_image_url &&
+          front_thumbnail_url == o.front_thumbnail_url &&
+          order_source == o.order_source &&
+          postcard_uuid == o.postcard_uuid &&
+          rendered_pdf_url == o.rendered_pdf_url &&
+          vendor_rendered == o.vendor_rendered &&
+          warnings == o.warnings
+    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
+      [back_html, back_image_url, back_thumbnail_url, front_html, front_image_url, front_thumbnail_url, order_source, postcard_uuid, rendered_pdf_url, vendor_rendered, warnings].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.220'
+  VERSION = '4.1.221'
 end

data/lib/ultracart_api.rb

@@ -1154,6 +1154,8 @@ require 'ultracart_api/models/sfvb_page_response'
 require 'ultracart_api/models/sfvb_page_selectors'
 require 'ultracart_api/models/sfvb_page_settings_request'
 require 'ultracart_api/models/sfvb_page_summary'
+require 'ultracart_api/models/sfvb_postcard_proof_request'
+require 'ultracart_api/models/sfvb_postcard_proof_response'
 require 'ultracart_api/models/sfvb_preview_access_request'
 require 'ultracart_api/models/sfvb_preview_access_response'
 require 'ultracart_api/models/sfvb_preview_session_request'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.220
+  version: 4.1.221
 platform: ruby
 authors:
 - UltraCart
@@ -1216,6 +1216,8 @@ files:
 - docs/SfvbPageSelectors.md
 - docs/SfvbPageSettingsRequest.md
 - docs/SfvbPageSummary.md
+- docs/SfvbPostcardProofRequest.md
+- docs/SfvbPostcardProofResponse.md
 - docs/SfvbPreviewAccessRequest.md
 - docs/SfvbPreviewAccessResponse.md
 - docs/SfvbPreviewSessionRequest.md
@@ -2576,6 +2578,8 @@ files:
 - lib/ultracart_api/models/sfvb_page_selectors.rb
 - lib/ultracart_api/models/sfvb_page_settings_request.rb
 - lib/ultracart_api/models/sfvb_page_summary.rb
+- lib/ultracart_api/models/sfvb_postcard_proof_request.rb
+- lib/ultracart_api/models/sfvb_postcard_proof_response.rb
 - lib/ultracart_api/models/sfvb_preview_access_request.rb
 - lib/ultracart_api/models/sfvb_preview_access_response.rb
 - lib/ultracart_api/models/sfvb_preview_session_request.rb