ultracart_api 4.0.103.rc → 4.0.104.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863c755bc404ed1ae18d8c3c38b32160ae1f4dd4d15c23fbcdd726fc840a27a0
-  data.tar.gz: 50ed92c2b89e35fd855428b123aec0ac7985fee17f8997f71be58c9ce3ded267
+  metadata.gz: f46b8ecfa9f4fa1215427090019e8e29d70fa1b4b1004ab5b86fd7fd8596bf58
+  data.tar.gz: 242bf11f0c10ed247c7a187f4ab2dfc41579d084c22ed2e6876e95ddff627b9e
 SHA512:
-  metadata.gz: 910c7d48bb30def245e60aea214d2da7b696339bccf53b9392d1359b242d98efb7fd07ddb1f2748bcf532ff3759cbaf0f5ddd458ca3d57bd51cf8543570e86f0
-  data.tar.gz: 271d69adb4e1d7c2638a1984685b90b6779e8a63fc8962d6c054f67520e6a3d89735e2919140b5e8d2c4edffd13ae59f6ae920ba2b6cb39caa2b03f91358d917
+  metadata.gz: cdef64baca51718c026f1ae10a54095280989a9ae4a47ea4e0ccbf13e6407da083b5da7f8f9d1138e1e517216c69d846b5a86606f0df5d1cace978162f0346af
+  data.tar.gz: 78938e1c6022e3594402ffaff5d10df088bedda7410e77fd386545ecc377f219b756da6e4bb2645ee7830a1afc35d180e552d742402977ac2a251f91f8584af7

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.103.rc
+- Package version: 4.0.104.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.103.rc.gem
+gem install ./ultracart_api-4.0.104.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.103.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.104.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.103.rc'
+    gem 'ultracart_api', '~> 4.0.104.rc'
 
 ### Install from Git
 
@@ -1055,6 +1055,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderPaymentPurchaseOrder](docs/OrderPaymentPurchaseOrder.md)
  - [UltracartClient::OrderPaymentTransaction](docs/OrderPaymentTransaction.md)
  - [UltracartClient::OrderPaymentTransactionDetail](docs/OrderPaymentTransactionDetail.md)
+ - [UltracartClient::OrderPointOfSale](docs/OrderPointOfSale.md)
  - [UltracartClient::OrderProcessPaymentRequest](docs/OrderProcessPaymentRequest.md)
  - [UltracartClient::OrderProcessPaymentResponse](docs/OrderProcessPaymentResponse.md)
  - [UltracartClient::OrderProperty](docs/OrderProperty.md)
@@ -1076,6 +1077,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
  - [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
  - [UltracartClient::Permission](docs/Permission.md)
+ - [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
+ - [UltracartClient::PointOfSaleReader](docs/PointOfSaleReader.md)
+ - [UltracartClient::PointOfSaleRegister](docs/PointOfSaleRegister.md)
  - [UltracartClient::PricingTier](docs/PricingTier.md)
  - [UltracartClient::PricingTierNotification](docs/PricingTierNotification.md)
  - [UltracartClient::PricingTiersResponse](docs/PricingTiersResponse.md)
@@ -1275,6 +1279,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.104-RC | 01/03/2023 | order point of sale details |
 | 4.0.103-RC | 12/27/2022 | additional loyalty related coupons |
 | 4.0.102-RC | 12/21/2022 | conversation development |
 | 4.0.101-RC | 12/20/2022 | conversation engagement update |

data/docs/Order.md

@@ -29,6 +29,7 @@
 | **merchant_id** | **String** | UltraCart merchant ID owning this order | [optional] |
 | **order_id** | **String** | Order ID | [optional] |
 | **payment** | [**OrderPayment**](OrderPayment.md) |  | [optional] |
+| **point_of_sale** | [**OrderPointOfSale**](OrderPointOfSale.md) |  | [optional] |
 | **properties** | [**Array<OrderProperty>**](OrderProperty.md) | Properties, available only through update, not through insert due to the nature of how properties are handled internally | [optional] |
 | **quote** | [**OrderQuote**](OrderQuote.md) |  | [optional] |
 | **refund_dts** | **String** | If the order was refunded, the date/time that the last refund occurred | [optional] |
@@ -70,6 +71,7 @@ instance = UltracartClient::Order.new(
   merchant_id: null,
   order_id: null,
   payment: null,
+  point_of_sale: null,
   properties: null,
   quote: null,
   refund_dts: null,

data/docs/OrderPointOfSale.md

@@ -0,0 +1,22 @@
+# UltracartClient::OrderPointOfSale
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**PointOfSaleLocation**](PointOfSaleLocation.md) |  | [optional] |
+| **reader** | [**PointOfSaleReader**](PointOfSaleReader.md) |  | [optional] |
+| **register** | [**PointOfSaleRegister**](PointOfSaleRegister.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderPointOfSale.new(
+  location: null,
+  reader: null,
+  register: null
+)
+```
+

data/docs/PointOfSaleLocation.md

@@ -0,0 +1,34 @@
+# UltracartClient::PointOfSaleLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adddress2** | **String** | Address line 2 | [optional] |
+| **address1** | **String** | Address line 1 | [optional] |
+| **city** | **String** | City | [optional] |
+| **country** | **String** | Country | [optional] |
+| **distribution_center_code** | **String** | The distribution center code where inventory is reduced from for this sale. | [optional] |
+| **merchant_id** | **String** | Merchant ID that owns this location | [optional] |
+| **pos_location_oid** | **Integer** | Object identifier of the point of sale location. | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **state_province** | **String** | State/province | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::PointOfSaleLocation.new(
+  adddress2: null,
+  address1: null,
+  city: null,
+  country: null,
+  distribution_center_code: null,
+  merchant_id: null,
+  pos_location_oid: null,
+  postal_code: null,
+  state_province: null
+)
+```
+

data/docs/PointOfSaleReader.md

@@ -0,0 +1,34 @@
+# UltracartClient::PointOfSaleReader
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_type** | **String** | The device type of the reader. | [optional] |
+| **label** | **String** | The label of the reader. | [optional] |
+| **merchant_id** | **String** | The merchant id that owns this point of sale reader. | [optional] |
+| **payment_provider** | **String** | The payment provider for the card reader. | [optional] |
+| **pos_reader_id** | **Integer** | Object identifier of the point of sale reader. | [optional] |
+| **pos_register_oid** | **Integer** | Object identifier of the point of sale register this reader is assigned to. | [optional] |
+| **serial_number** | **String** | The serial number of the reader. | [optional] |
+| **stripe_account_id** | **String** | If the payment provider is Stripe, this is the Stripe account id | [optional] |
+| **stripe_reader_id** | **String** | If the payment provide is Stripe, this is the Stripe terminal reader id | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::PointOfSaleReader.new(
+  device_type: null,
+  label: null,
+  merchant_id: null,
+  payment_provider: null,
+  pos_reader_id: null,
+  pos_register_oid: null,
+  serial_number: null,
+  stripe_account_id: null,
+  stripe_reader_id: null
+)
+```
+

data/docs/PointOfSaleRegister.md

@@ -0,0 +1,24 @@
+# UltracartClient::PointOfSaleRegister
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_id** | **String** | The merchant id that owns this point of sale register. | [optional] |
+| **name** | **String** | Name of the register. | [optional] |
+| **pos_location_oid** | **Integer** | Object identifier of the point of sale location where this register is located. | [optional] |
+| **pos_register_oid** | **Integer** | Object identifier of the point of sale register. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::PointOfSaleRegister.new(
+  merchant_id: null,
+  name: null,
+  pos_location_oid: null,
+  pos_register_oid: null
+)
+```
+

data/lib/ultracart_api/models/order.rb

@@ -75,6 +75,8 @@ module UltracartClient
 
     attr_accessor :payment
 
+    attr_accessor :point_of_sale
+
     # Properties, available only through update, not through insert due to the nature of how properties are handled internally
     attr_accessor :properties
 
@@ -147,6 +149,7 @@ module UltracartClient
         :'merchant_id' => :'merchant_id',
         :'order_id' => :'order_id',
         :'payment' => :'payment',
+        :'point_of_sale' => :'point_of_sale',
         :'properties' => :'properties',
         :'quote' => :'quote',
         :'refund_dts' => :'refund_dts',
@@ -192,6 +195,7 @@ module UltracartClient
         :'merchant_id' => :'String',
         :'order_id' => :'String',
         :'payment' => :'OrderPayment',
+        :'point_of_sale' => :'OrderPointOfSale',
         :'properties' => :'Array<OrderProperty>',
         :'quote' => :'OrderQuote',
         :'refund_dts' => :'String',
@@ -331,6 +335,10 @@ module UltracartClient
         self.payment = attributes[:'payment']
       end
 
+      if attributes.key?(:'point_of_sale')
+        self.point_of_sale = attributes[:'point_of_sale']
+      end
+
       if attributes.key?(:'properties')
         if (value = attributes[:'properties']).is_a?(Array)
           self.properties = value
@@ -457,6 +465,7 @@ module UltracartClient
           merchant_id == o.merchant_id &&
           order_id == o.order_id &&
           payment == o.payment &&
+          point_of_sale == o.point_of_sale &&
           properties == o.properties &&
           quote == o.quote &&
           refund_dts == o.refund_dts &&
@@ -477,7 +486,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes].hash
+      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_point_of_sale.rb

@@ -0,0 +1,237 @@
+=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 OrderPointOfSale
+    attr_accessor :location
+
+    attr_accessor :reader
+
+    attr_accessor :register
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'location' => :'location',
+        :'reader' => :'reader',
+        :'register' => :'register'
+      }
+    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
+      {
+        :'location' => :'PointOfSaleLocation',
+        :'reader' => :'PointOfSaleReader',
+        :'register' => :'PointOfSaleRegister'
+      }
+    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::OrderPointOfSale` 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::OrderPointOfSale`. 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?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'reader')
+        self.reader = attributes[:'reader']
+      end
+
+      if attributes.key?(:'register')
+        self.register = attributes[:'register']
+      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 &&
+          location == o.location &&
+          reader == o.reader &&
+          register == o.register
+    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
+      [location, reader, register].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