late-sdk 0.0.1501 → 0.0.1502

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85bb4156dae150be5ab754baccaee3d0d8a5315c4bdd612c1fac9777bed06b3
-  data.tar.gz: a6069b9fff8fde9f8a4bcd15df71d7a326495486710758ed9ae48b01ed611034
+  metadata.gz: 25481b5b429bb2072fbfa1b87740382de5bee2f2bcf46e0073d72ee893776cdb
+  data.tar.gz: 2650e6bac4b426a7cb6ff38a43d9b69a7b4b4c2e89f6c0c45fcb46457a76fec6
 SHA512:
-  metadata.gz: fa2d68ee989341457171b796dd90358bb001f516abfe586af6fac110f1d4c0b5af94421f602a674b2e15e44ea02c1d8b554741dc850ed1914e18cb560d904a08
-  data.tar.gz: e899c8709d31cbe3ab9b0217bef8ceb41d09ca659d845d8a1b41f1ce9371a33db1e0d98068c93758c10f4cc8eb58b972feb9ff0a9ee263ab2304dddd6a4ec043
+  metadata.gz: 8af57af3e34244b70fee578fd6594ad1ae65bd9beab5f61e3a78ff7e2e71f393b32ff896f35e7137923f90f7814de2eca6ed330a5fb5791bbe7d55e53313ea7f
+  data.tar.gz: 33e46b53973597b8ee7cb2a2be788fea1775687fb36e4996e694336da148c1f782e4d6aa51a9e024e15238310728526133f9bcf2575e482c0adfcb1546c3e82e

data/README.md

@@ -1408,6 +1408,7 @@ Class | Method | HTTP request | Description
  - [Zernio::CommerceMetaobjectFieldsInner](docs/CommerceMetaobjectFieldsInner.md)
  - [Zernio::CommerceMoney](docs/CommerceMoney.md)
  - [Zernio::CommerceOrder](docs/CommerceOrder.md)
+ - [Zernio::CommerceOrderAttribution](docs/CommerceOrderAttribution.md)
  - [Zernio::CommerceOrderChargeLine](docs/CommerceOrderChargeLine.md)
  - [Zernio::CommerceOrderCustomer](docs/CommerceOrderCustomer.md)
  - [Zernio::CommerceOrderFulfillmentsInner](docs/CommerceOrderFulfillmentsInner.md)
@@ -1415,6 +1416,8 @@ Class | Method | HTTP request | Description
  - [Zernio::CommerceOrderRefundsInner](docs/CommerceOrderRefundsInner.md)
  - [Zernio::CommerceOrderRefundsInnerLineItemsInner](docs/CommerceOrderRefundsInnerLineItemsInner.md)
  - [Zernio::CommerceOrderStatus](docs/CommerceOrderStatus.md)
+ - [Zernio::CommerceOrderVisit](docs/CommerceOrderVisit.md)
+ - [Zernio::CommerceOrderVisitUtm](docs/CommerceOrderVisitUtm.md)
  - [Zernio::CommercePage](docs/CommercePage.md)
  - [Zernio::CommercePriceList](docs/CommercePriceList.md)
  - [Zernio::CommerceProduct](docs/CommerceProduct.md)

data/docs/CommerceOrder.md

@@ -31,6 +31,7 @@
 | **billing_address** | [**CommerceAddress**](CommerceAddress.md) |  | [optional] |
 | **shipping_address** | [**CommerceAddress**](CommerceAddress.md) |  | [optional] |
 | **buyer_note** | **String** |  | [optional] |
+| **attribution** | [**CommerceOrderAttribution**](CommerceOrderAttribution.md) |  | [optional] |
 | **line_items** | [**Array<CommerceOrderLineItemsInner>**](CommerceOrderLineItemsInner.md) |  | [optional] |
 | **shipping_lines** | [**Array<CommerceOrderChargeLine>**](CommerceOrderChargeLine.md) |  | [optional] |
 | **fee_lines** | [**Array<CommerceOrderChargeLine>**](CommerceOrderChargeLine.md) | WooCommerce fees. Always empty on Shopify. | [optional] |
@@ -72,6 +73,7 @@ instance = Zernio::CommerceOrder.new(
   billing_address: null,
   shipping_address: null,
   buyer_note: null,
+  attribution: null,
   line_items: null,
   shipping_lines: null,
   fee_lines: null,

data/docs/CommerceOrderAttribution.md

@@ -0,0 +1,24 @@
+# Zernio::CommerceOrderAttribution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ready** | **Boolean** | False while Shopify is still attributing a new order. No webhook fires when it becomes true, so read the order again later. Always true on WooCommerce. | [optional] |
+| **first_visit** | [**CommerceOrderVisit**](CommerceOrderVisit.md) |  | [optional] |
+| **last_visit** | [**CommerceOrderVisit**](CommerceOrderVisit.md) |  | [optional] |
+| **custom_attributes** | [**Array<BoostPostRequestTrackingUrlTagsInner>**](BoostPostRequestTrackingUrlTagsInner.md) | Shopify cart and note attributes, or WooCommerce public order meta. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CommerceOrderAttribution.new(
+  ready: null,
+  first_visit: null,
+  last_visit: null,
+  custom_attributes: null
+)
+```
+

data/docs/CommerceOrderVisit.md

@@ -0,0 +1,28 @@
+# Zernio::CommerceOrderVisit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **occurred_at** | **Time** | Null on WooCommerce, which records the session start without a timezone. | [optional] |
+| **landing_url** | **String** | The first page of the session, with its query string. | [optional] |
+| **referrer_url** | **String** |  | [optional] |
+| **source** | **String** | Where the visit came from, as the platform names it. | [optional] |
+| **source_type** | **String** | Shopify marketing tactic (e.g. SOCIAL, AD, SEARCH) or WooCommerce source type (utm, organic, referral, typein, admin). | [optional] |
+| **utm** | [**CommerceOrderVisitUtm**](CommerceOrderVisitUtm.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CommerceOrderVisit.new(
+  occurred_at: null,
+  landing_url: null,
+  referrer_url: null,
+  source: instagram,
+  source_type: null,
+  utm: null
+)
+```
+

data/docs/CommerceOrderVisitUtm.md

@@ -0,0 +1,26 @@
+# Zernio::CommerceOrderVisitUtm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | **String** |  | [optional] |
+| **medium** | **String** |  | [optional] |
+| **campaign** | **String** |  | [optional] |
+| **term** | **String** |  | [optional] |
+| **content** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CommerceOrderVisitUtm.new(
+  source: null,
+  medium: null,
+  campaign: null,
+  term: null,
+  content: null
+)
+```
+

data/lib/zernio-sdk/models/commerce_order.rb

@@ -77,6 +77,8 @@ module Zernio
 
     attr_accessor :buyer_note
 
+    attr_accessor :attribution
+
     attr_accessor :line_items
 
     attr_accessor :shipping_lines
@@ -146,6 +148,7 @@ module Zernio
         :'billing_address' => :'billingAddress',
         :'shipping_address' => :'shippingAddress',
         :'buyer_note' => :'buyerNote',
+        :'attribution' => :'attribution',
         :'line_items' => :'lineItems',
         :'shipping_lines' => :'shippingLines',
         :'fee_lines' => :'feeLines',
@@ -196,6 +199,7 @@ module Zernio
         :'billing_address' => :'CommerceAddress',
         :'shipping_address' => :'CommerceAddress',
         :'buyer_note' => :'String',
+        :'attribution' => :'CommerceOrderAttribution',
         :'line_items' => :'Array<CommerceOrderLineItemsInner>',
         :'shipping_lines' => :'Array<CommerceOrderChargeLine>',
         :'fee_lines' => :'Array<CommerceOrderChargeLine>',
@@ -349,6 +353,10 @@ module Zernio
         self.buyer_note = attributes[:'buyer_note']
       end
 
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      end
+
       if attributes.key?(:'line_items')
         if (value = attributes[:'line_items']).is_a?(Array)
           self.line_items = value
@@ -463,6 +471,7 @@ module Zernio
           billing_address == o.billing_address &&
           shipping_address == o.shipping_address &&
           buyer_note == o.buyer_note &&
+          attribution == o.attribution &&
           line_items == o.line_items &&
           shipping_lines == o.shipping_lines &&
           fee_lines == o.fee_lines &&
@@ -481,7 +490,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, account_id, platform, number, status, platform_status, payment_status, platform_payment_status, currency, taxes_included, created_at, updated_at, paid_at, cancelled_at, cancel_reason, subtotal, discount_total, shipping_total, tax_total, total, refunded_total, discount_codes, payment_methods, customer, billing_address, shipping_address, buyer_note, line_items, shipping_lines, fee_lines, tax_lines, refunds, fulfillments, platform_data].hash
+      [id, account_id, platform, number, status, platform_status, payment_status, platform_payment_status, currency, taxes_included, created_at, updated_at, paid_at, cancelled_at, cancel_reason, subtotal, discount_total, shipping_total, tax_total, total, refunded_total, discount_codes, payment_methods, customer, billing_address, shipping_address, buyer_note, attribution, line_items, shipping_lines, fee_lines, tax_lines, refunds, fulfillments, platform_data].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/commerce_order_attribution.rb

@@ -0,0 +1,181 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).  Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id. 
+
+The version of the OpenAPI document: 1.332.0
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # Where the order came from. Shopify reads it from the customer journey, WooCommerce from its order attribution (WooCommerce 8.5+ with the feature on, orders placed after it was turned on).
+  class CommerceOrderAttribution < ApiModelBase
+    # False while Shopify is still attributing a new order. No webhook fires when it becomes true, so read the order again later. Always true on WooCommerce.
+    attr_accessor :ready
+
+    attr_accessor :first_visit
+
+    attr_accessor :last_visit
+
+    # Shopify cart and note attributes, or WooCommerce public order meta.
+    attr_accessor :custom_attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ready' => :'ready',
+        :'first_visit' => :'firstVisit',
+        :'last_visit' => :'lastVisit',
+        :'custom_attributes' => :'customAttributes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ready' => :'Boolean',
+        :'first_visit' => :'CommerceOrderVisit',
+        :'last_visit' => :'CommerceOrderVisit',
+        :'custom_attributes' => :'Array<BoostPostRequestTrackingUrlTagsInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'first_visit',
+        :'last_visit',
+      ])
+    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 `Zernio::CommerceOrderAttribution` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CommerceOrderAttribution`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ready')
+        self.ready = attributes[:'ready']
+      end
+
+      if attributes.key?(:'first_visit')
+        self.first_visit = attributes[:'first_visit']
+      end
+
+      if attributes.key?(:'last_visit')
+        self.last_visit = attributes[:'last_visit']
+      end
+
+      if attributes.key?(:'custom_attributes')
+        if (value = attributes[:'custom_attributes']).is_a?(Array)
+          self.custom_attributes = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          ready == o.ready &&
+          first_visit == o.first_visit &&
+          last_visit == o.last_visit &&
+          custom_attributes == o.custom_attributes
+    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
+      [ready, first_visit, last_visit, custom_attributes].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/zernio-sdk/models/commerce_order_visit.rb

@@ -0,0 +1,202 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).  Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id. 
+
+The version of the OpenAPI document: 1.332.0
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # A store session that led to the order.
+  class CommerceOrderVisit < ApiModelBase
+    # Null on WooCommerce, which records the session start without a timezone.
+    attr_accessor :occurred_at
+
+    # The first page of the session, with its query string.
+    attr_accessor :landing_url
+
+    attr_accessor :referrer_url
+
+    # Where the visit came from, as the platform names it.
+    attr_accessor :source
+
+    # Shopify marketing tactic (e.g. SOCIAL, AD, SEARCH) or WooCommerce source type (utm, organic, referral, typein, admin).
+    attr_accessor :source_type
+
+    attr_accessor :utm
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'occurred_at' => :'occurredAt',
+        :'landing_url' => :'landingUrl',
+        :'referrer_url' => :'referrerUrl',
+        :'source' => :'source',
+        :'source_type' => :'sourceType',
+        :'utm' => :'utm'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'occurred_at' => :'Time',
+        :'landing_url' => :'String',
+        :'referrer_url' => :'String',
+        :'source' => :'String',
+        :'source_type' => :'String',
+        :'utm' => :'CommerceOrderVisitUtm'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'occurred_at',
+        :'landing_url',
+        :'referrer_url',
+        :'source',
+        :'source_type',
+      ])
+    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 `Zernio::CommerceOrderVisit` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CommerceOrderVisit`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'occurred_at')
+        self.occurred_at = attributes[:'occurred_at']
+      end
+
+      if attributes.key?(:'landing_url')
+        self.landing_url = attributes[:'landing_url']
+      end
+
+      if attributes.key?(:'referrer_url')
+        self.referrer_url = attributes[:'referrer_url']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'source_type')
+        self.source_type = attributes[:'source_type']
+      end
+
+      if attributes.key?(:'utm')
+        self.utm = attributes[:'utm']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          occurred_at == o.occurred_at &&
+          landing_url == o.landing_url &&
+          referrer_url == o.referrer_url &&
+          source == o.source &&
+          source_type == o.source_type &&
+          utm == o.utm
+    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
+      [occurred_at, landing_url, referrer_url, source, source_type, utm].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end