ultracart_api 4.0.62.rc → 4.0.63.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9e9c20f60990fdd7b6e160a82923a67a4cbabbbf13978693bcace76a29212e
-  data.tar.gz: d35a763274a3507a9d61b8610229b7ee0097e3e517b2f7ec511eb50eed0f8836
+  metadata.gz: 15484cd481220bf96f131fc0acecfeee27a83afa20836d4804198613d206d67b
+  data.tar.gz: 8654390b05267c0e34e5dc43e9c9d49facfa49b5e298a88069a21a62e22cf462
 SHA512:
-  metadata.gz: 2652166dcc0817892b295d70b82caf28a1d735793292cba1e90bf60bcb61cd974c3fb040f70fa161d9588c119ad834efab68b53012ce034daf284f4bdc415117
-  data.tar.gz: 2cf021ff4d5d609f74d386fbafa0dc372cb14f525c9333a3830980df883aab9ce605a10cae6fa3930614a4c716c43d25d760d501007aca9cca5b6e1fe5546226
+  metadata.gz: 9d7cf627cbbca6e6a3b35f08fbaf70701185d9883dff012f3a62d95fa2520b2d5a0e9bfaff8bf1d2800fbf0f6f192399e800694b1225e9a0234cca6ba0ed6a44
+  data.tar.gz: d27642bc84c9af9c1461615825fa390860755f513e69cf9640e43351780bc1d8671cbe94c269f51648c5deff54090ef5cb87efe156417c13edf0616f7250d92a

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.62.rc
+- Package version: 4.0.63.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.62.rc.gem
+gem install ./ultracart_api-4.0.63.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.62.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.63.rc.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.62.rc'
+    gem 'ultracart_api', '~> 4.0.63.rc'
 
 ### Install from Git
 
@@ -275,6 +275,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
 *UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
+*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
 *UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
 *UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
@@ -770,6 +771,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
  - [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
  - [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
+ - [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
+ - [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
  - [UltracartClient::EmailSegment](docs/EmailSegment.md)
  - [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
  - [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
@@ -1191,6 +1194,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
 | 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
 | 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
 | 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |

data/docs/EmailPostcardTracking.md

@@ -0,0 +1,66 @@
+# UltracartClient::EmailPostcardTracking
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **commseq_postcard_uuid** | **String** |  | [optional] |
+| **commseq_step_uuid** | **String** |  | [optional] |
+| **commseq_uuid** | **String** |  | [optional] |
+| **conversion_dts** | **String** | Conversion date time. | [optional] |
+| **cost** | **Float** |  | [optional] |
+| **customer_uuid** | **String** |  | [optional] |
+| **delivered_dts** | **String** | Delivered date time. | [optional] |
+| **from_address_line1** | **String** |  | [optional] |
+| **from_address_line2** | **String** |  | [optional] |
+| **from_city** | **String** |  | [optional] |
+| **from_name** | **String** |  | [optional] |
+| **from_state** | **String** |  | [optional] |
+| **from_zip** | **String** |  | [optional] |
+| **mailed_dts** | **String** | Mailed date time. | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **postcard_tracking_uuid** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **submit_dts** | **String** | Submit date time. | [optional] |
+| **to_address_line1** | **String** |  | [optional] |
+| **to_address_line2** | **String** |  | [optional] |
+| **to_city** | **String** |  | [optional] |
+| **to_name** | **String** |  | [optional] |
+| **to_state** | **String** |  | [optional] |
+| **to_zip** | **String** |  | [optional] |
+| **tracking_description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailPostcardTracking.new(
+  commseq_postcard_uuid: null,
+  commseq_step_uuid: null,
+  commseq_uuid: null,
+  conversion_dts: null,
+  cost: null,
+  customer_uuid: null,
+  delivered_dts: null,
+  from_address_line1: null,
+  from_address_line2: null,
+  from_city: null,
+  from_name: null,
+  from_state: null,
+  from_zip: null,
+  mailed_dts: null,
+  order_id: null,
+  postcard_tracking_uuid: null,
+  status: null,
+  submit_dts: null,
+  to_address_line1: null,
+  to_address_line2: null,
+  to_city: null,
+  to_name: null,
+  to_state: null,
+  to_zip: null,
+  tracking_description: null
+)
+```
+

data/docs/EmailPostcardTrackingResponse.md

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

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq |
 | [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats |
 | [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats |
+| [**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking |
 | [**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall |
 | [**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats |
 | [**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step |
@@ -3000,6 +3001,77 @@ end
 - **Accept**: application/json
 
 
+## get_email_commseq_postcard_tracking
+
+> <EmailPostcardTrackingResponse> get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
+
+Get email communication postcard tracking
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+storefront_oid = 56 # Integer | 
+commseq_postcard_uuid = 'commseq_postcard_uuid_example' # String | 
+
+begin
+  # Get email communication postcard tracking
+  result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
+end
+```
+
+#### Using the get_email_commseq_postcard_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailPostcardTrackingResponse>, Integer, Hash)> get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
+
+```ruby
+begin
+  # Get email communication postcard tracking
+  data, status_code, headers = api_instance.get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailPostcardTrackingResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_postcard_uuid** | **String** |  |  |
+
+### Return type
+
+[**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_email_commseq_stat_overall
 
 > <EmailCommseqStatResponse> get_email_commseq_stat_overall(storefront_oid, commseq_uuid)

data/lib/ultracart_api/api/storefront_api.rb

@@ -2751,6 +2751,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get email communication postcard tracking
+    # @param storefront_oid [Integer] 
+    # @param commseq_postcard_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailPostcardTrackingResponse]
+    def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
+      data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
+      data
+    end
+
+    # Get email communication postcard tracking
+    # @param storefront_oid [Integer] 
+    # @param commseq_postcard_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailPostcardTrackingResponse, Integer, Hash)>] EmailPostcardTrackingResponse data, response status code and response headers
+    def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
+      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 StorefrontApi.get_email_commseq_postcard_tracking"
+      end
+      # verify the required parameter 'commseq_postcard_uuid' is set
+      if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailPostcardTrackingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_commseq_postcard_tracking",
+        :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: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get communication sequence stats overall
     # @param storefront_oid [Integer] 
     # @param commseq_uuid [String] 

data/lib/ultracart_api/models/email_postcard_tracking.rb

@@ -0,0 +1,439 @@
+=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 EmailPostcardTracking
+    attr_accessor :commseq_postcard_uuid
+
+    attr_accessor :commseq_step_uuid
+
+    attr_accessor :commseq_uuid
+
+    # Conversion date time.
+    attr_accessor :conversion_dts
+
+    attr_accessor :cost
+
+    attr_accessor :customer_uuid
+
+    # Delivered date time.
+    attr_accessor :delivered_dts
+
+    attr_accessor :from_address_line1
+
+    attr_accessor :from_address_line2
+
+    attr_accessor :from_city
+
+    attr_accessor :from_name
+
+    attr_accessor :from_state
+
+    attr_accessor :from_zip
+
+    # Mailed date time.
+    attr_accessor :mailed_dts
+
+    attr_accessor :order_id
+
+    attr_accessor :postcard_tracking_uuid
+
+    attr_accessor :status
+
+    # Submit date time.
+    attr_accessor :submit_dts
+
+    attr_accessor :to_address_line1
+
+    attr_accessor :to_address_line2
+
+    attr_accessor :to_city
+
+    attr_accessor :to_name
+
+    attr_accessor :to_state
+
+    attr_accessor :to_zip
+
+    attr_accessor :tracking_description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'commseq_postcard_uuid' => :'commseq_postcard_uuid',
+        :'commseq_step_uuid' => :'commseq_step_uuid',
+        :'commseq_uuid' => :'commseq_uuid',
+        :'conversion_dts' => :'conversion_dts',
+        :'cost' => :'cost',
+        :'customer_uuid' => :'customer_uuid',
+        :'delivered_dts' => :'delivered_dts',
+        :'from_address_line1' => :'from_address_line1',
+        :'from_address_line2' => :'from_address_line2',
+        :'from_city' => :'from_city',
+        :'from_name' => :'from_name',
+        :'from_state' => :'from_state',
+        :'from_zip' => :'from_zip',
+        :'mailed_dts' => :'mailed_dts',
+        :'order_id' => :'order_id',
+        :'postcard_tracking_uuid' => :'postcard_tracking_uuid',
+        :'status' => :'status',
+        :'submit_dts' => :'submit_dts',
+        :'to_address_line1' => :'to_address_line1',
+        :'to_address_line2' => :'to_address_line2',
+        :'to_city' => :'to_city',
+        :'to_name' => :'to_name',
+        :'to_state' => :'to_state',
+        :'to_zip' => :'to_zip',
+        :'tracking_description' => :'tracking_description'
+      }
+    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
+      {
+        :'commseq_postcard_uuid' => :'String',
+        :'commseq_step_uuid' => :'String',
+        :'commseq_uuid' => :'String',
+        :'conversion_dts' => :'String',
+        :'cost' => :'Float',
+        :'customer_uuid' => :'String',
+        :'delivered_dts' => :'String',
+        :'from_address_line1' => :'String',
+        :'from_address_line2' => :'String',
+        :'from_city' => :'String',
+        :'from_name' => :'String',
+        :'from_state' => :'String',
+        :'from_zip' => :'String',
+        :'mailed_dts' => :'String',
+        :'order_id' => :'String',
+        :'postcard_tracking_uuid' => :'String',
+        :'status' => :'String',
+        :'submit_dts' => :'String',
+        :'to_address_line1' => :'String',
+        :'to_address_line2' => :'String',
+        :'to_city' => :'String',
+        :'to_name' => :'String',
+        :'to_state' => :'String',
+        :'to_zip' => :'String',
+        :'tracking_description' => :'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::EmailPostcardTracking` 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::EmailPostcardTracking`. 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?(:'commseq_postcard_uuid')
+        self.commseq_postcard_uuid = attributes[:'commseq_postcard_uuid']
+      end
+
+      if attributes.key?(:'commseq_step_uuid')
+        self.commseq_step_uuid = attributes[:'commseq_step_uuid']
+      end
+
+      if attributes.key?(:'commseq_uuid')
+        self.commseq_uuid = attributes[:'commseq_uuid']
+      end
+
+      if attributes.key?(:'conversion_dts')
+        self.conversion_dts = attributes[:'conversion_dts']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'customer_uuid')
+        self.customer_uuid = attributes[:'customer_uuid']
+      end
+
+      if attributes.key?(:'delivered_dts')
+        self.delivered_dts = attributes[:'delivered_dts']
+      end
+
+      if attributes.key?(:'from_address_line1')
+        self.from_address_line1 = attributes[:'from_address_line1']
+      end
+
+      if attributes.key?(:'from_address_line2')
+        self.from_address_line2 = attributes[:'from_address_line2']
+      end
+
+      if attributes.key?(:'from_city')
+        self.from_city = attributes[:'from_city']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'from_state')
+        self.from_state = attributes[:'from_state']
+      end
+
+      if attributes.key?(:'from_zip')
+        self.from_zip = attributes[:'from_zip']
+      end
+
+      if attributes.key?(:'mailed_dts')
+        self.mailed_dts = attributes[:'mailed_dts']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'postcard_tracking_uuid')
+        self.postcard_tracking_uuid = attributes[:'postcard_tracking_uuid']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'submit_dts')
+        self.submit_dts = attributes[:'submit_dts']
+      end
+
+      if attributes.key?(:'to_address_line1')
+        self.to_address_line1 = attributes[:'to_address_line1']
+      end
+
+      if attributes.key?(:'to_address_line2')
+        self.to_address_line2 = attributes[:'to_address_line2']
+      end
+
+      if attributes.key?(:'to_city')
+        self.to_city = attributes[:'to_city']
+      end
+
+      if attributes.key?(:'to_name')
+        self.to_name = attributes[:'to_name']
+      end
+
+      if attributes.key?(:'to_state')
+        self.to_state = attributes[:'to_state']
+      end
+
+      if attributes.key?(:'to_zip')
+        self.to_zip = attributes[:'to_zip']
+      end
+
+      if attributes.key?(:'tracking_description')
+        self.tracking_description = attributes[:'tracking_description']
+      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 &&
+          commseq_postcard_uuid == o.commseq_postcard_uuid &&
+          commseq_step_uuid == o.commseq_step_uuid &&
+          commseq_uuid == o.commseq_uuid &&
+          conversion_dts == o.conversion_dts &&
+          cost == o.cost &&
+          customer_uuid == o.customer_uuid &&
+          delivered_dts == o.delivered_dts &&
+          from_address_line1 == o.from_address_line1 &&
+          from_address_line2 == o.from_address_line2 &&
+          from_city == o.from_city &&
+          from_name == o.from_name &&
+          from_state == o.from_state &&
+          from_zip == o.from_zip &&
+          mailed_dts == o.mailed_dts &&
+          order_id == o.order_id &&
+          postcard_tracking_uuid == o.postcard_tracking_uuid &&
+          status == o.status &&
+          submit_dts == o.submit_dts &&
+          to_address_line1 == o.to_address_line1 &&
+          to_address_line2 == o.to_address_line2 &&
+          to_city == o.to_city &&
+          to_name == o.to_name &&
+          to_state == o.to_state &&
+          to_zip == o.to_zip &&
+          tracking_description == o.tracking_description
+    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
+      [commseq_postcard_uuid, commseq_step_uuid, commseq_uuid, conversion_dts, cost, customer_uuid, delivered_dts, from_address_line1, from_address_line2, from_city, from_name, from_state, from_zip, mailed_dts, order_id, postcard_tracking_uuid, status, submit_dts, to_address_line1, to_address_line2, to_city, to_name, to_state, to_zip, tracking_description].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/email_postcard_tracking_response.rb

@@ -0,0 +1,256 @@
+=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 EmailPostcardTrackingResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :tracking
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'tracking' => :'tracking',
+        :'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',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'tracking' => :'EmailPostcardTracking',
+        :'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::EmailPostcardTrackingResponse` 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::EmailPostcardTrackingResponse`. 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?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'tracking')
+        self.tracking = attributes[:'tracking']
+      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 &&
+          metadata == o.metadata &&
+          success == o.success &&
+          tracking == o.tracking &&
+          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, metadata, success, tracking, 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.0.62.rc'
+  VERSION = '4.0.63.rc'
 end

data/lib/ultracart_api.rb

@@ -336,6 +336,8 @@ require 'ultracart_api/models/email_plan'
 require 'ultracart_api/models/email_plan_additional'
 require 'ultracart_api/models/email_plan_response'
 require 'ultracart_api/models/email_postcard_stat'
+require 'ultracart_api/models/email_postcard_tracking'
+require 'ultracart_api/models/email_postcard_tracking_response'
 require 'ultracart_api/models/email_segment'
 require 'ultracart_api/models/email_segment_archive_response'
 require 'ultracart_api/models/email_segment_customer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.62.rc
+  version: 4.0.63.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -388,6 +388,8 @@ files:
 - docs/EmailPlanAdditional.md
 - docs/EmailPlanResponse.md
 - docs/EmailPostcardStat.md
+- docs/EmailPostcardTracking.md
+- docs/EmailPostcardTrackingResponse.md
 - docs/EmailSegment.md
 - docs/EmailSegmentArchiveResponse.md
 - docs/EmailSegmentCustomer.md
@@ -1090,6 +1092,8 @@ files:
 - lib/ultracart_api/models/email_plan_additional.rb
 - lib/ultracart_api/models/email_plan_response.rb
 - lib/ultracart_api/models/email_postcard_stat.rb
+- lib/ultracart_api/models/email_postcard_tracking.rb
+- lib/ultracart_api/models/email_postcard_tracking_response.rb
 - lib/ultracart_api/models/email_segment.rb
 - lib/ultracart_api/models/email_segment_archive_response.rb
 - lib/ultracart_api/models/email_segment_customer.rb