ultracart_api 3.10.86 → 3.10.87

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794a929648481e074401588dfb60b5339224224516952ee3bf33fa973be38c0b
-  data.tar.gz: 3a154eefa5642fd9ab279fec2dd2df5eeac795ec93ee330e5f390893ed810d7d
+  metadata.gz: 34f8843c1beeb281a4f4c9931006ce6a8214089360872be5c710c90e3ad60c8d
+  data.tar.gz: e4ee2fbe3e5115209d77c688aec9487ef22e90f1bf93ab99d97bb1b363885a18
 SHA512:
-  metadata.gz: 9761950a499f4c36eb76e16dbe3e2d788f6774836f538e181d9cae690aa242cdcda0e7f88b78a9f2896eeb827aadcf6fe4227f33bdc499967a1c0cbd5a27a1db
-  data.tar.gz: 88cece7949b1d3d266d21c845e8b5ee9221c729074113f0cf640b58ae681e36f56b3644c6c19632b80009e1d597c3b45437729db752afb2953b4d186e554c391
+  metadata.gz: 12eca8ebe0786ef81d787156644f29033810e069a9984a1585921ca00d0dbd84f98663ec1c0d1d86aeeb7bb7968cc5858f28d884447bea7b20fc531d4856a32f
+  data.tar.gz: 58b844c2ac6b81beb6cc393e0f46809510b8abe85f3a5cd5be11abadad6046ed1de9fd17d4becac0605e34151faa32c30a09ad96b514415d3523dd98961b739f

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.86
+- Package version: 3.10.87
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.86.gem
+gem install ./ultracart_api-3.10.87.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.86.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.87.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', '~> 3.10.86'
+    gem 'ultracart_api', '~> 3.10.87'
 
 ### Install from Git
 
@@ -1050,6 +1050,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)
@@ -1071,6 +1072,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)
@@ -1267,6 +1271,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.87 | 01/03/2023 | order point of sale details |
 | 3.10.86 | 12/27/2022 | additional loyalty related coupons |
 | 3.10.85 | 12/21/2022 | conversation development |
 | 3.10.84 | 12/20/2022 | conversation engagement update |

data/docs/Order.md

@@ -28,6 +28,7 @@ Name | Type | Description | Notes
 **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] 

data/docs/OrderPointOfSale.md

@@ -0,0 +1,10 @@
+# UltracartClient::OrderPointOfSale
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | [**PointOfSaleLocation**](PointOfSaleLocation.md) |  | [optional] 
+**reader** | [**PointOfSaleReader**](PointOfSaleReader.md) |  | [optional] 
+**register** | [**PointOfSaleRegister**](PointOfSaleRegister.md) |  | [optional] 
+
+

data/docs/PointOfSaleLocation.md

@@ -0,0 +1,16 @@
+# 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] 
+
+

data/docs/PointOfSaleReader.md

@@ -0,0 +1,16 @@
+# 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] 
+
+

data/docs/PointOfSaleRegister.md

@@ -0,0 +1,11 @@
+# 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] 
+
+

data/lib/ultracart_api/models/order.rb

@@ -74,6 +74,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
 
@@ -146,6 +148,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',
@@ -186,6 +189,7 @@ module UltracartClient
         :'merchant_id' => :'String',
         :'order_id' => :'String',
         :'payment' => :'OrderPayment',
+        :'point_of_sale' => :'OrderPointOfSale',
         :'properties' => :'Array<OrderProperty>',
         :'quote' => :'OrderQuote',
         :'refund_dts' => :'String',
@@ -312,6 +316,10 @@ module UltracartClient
         self.payment = attributes[:'payment']
       end
 
+      if attributes.has_key?(:'point_of_sale')
+        self.point_of_sale = attributes[:'point_of_sale']
+      end
+
       if attributes.has_key?(:'properties')
         if (value = attributes[:'properties']).is_a?(Array)
           self.properties = value
@@ -438,6 +446,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 &&
@@ -458,7 +467,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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,202 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'location' => :'PointOfSaleLocation',
+        :'reader' => :'PointOfSaleReader',
+        :'register' => :'PointOfSaleRegister'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.has_key?(:'reader')
+        self.reader = attributes[:'reader']
+      end
+
+      if attributes.has_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 [Fixnum] 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 build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/point_of_sale_location.rb

@@ -0,0 +1,265 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class PointOfSaleLocation
+    # Address line 2
+    attr_accessor :adddress2
+
+    # Address line 1
+    attr_accessor :address1
+
+    # City
+    attr_accessor :city
+
+    # Country
+    attr_accessor :country
+
+    # The distribution center code where inventory is reduced from for this sale.
+    attr_accessor :distribution_center_code
+
+    # Merchant ID that owns this location
+    attr_accessor :merchant_id
+
+    # Object identifier of the point of sale location.
+    attr_accessor :pos_location_oid
+
+    # Postal code
+    attr_accessor :postal_code
+
+    # State/province
+    attr_accessor :state_province
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'adddress2' => :'adddress2',
+        :'address1' => :'address1',
+        :'city' => :'city',
+        :'country' => :'country',
+        :'distribution_center_code' => :'distribution_center_code',
+        :'merchant_id' => :'merchant_id',
+        :'pos_location_oid' => :'pos_location_oid',
+        :'postal_code' => :'postal_code',
+        :'state_province' => :'state_province'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'adddress2' => :'String',
+        :'address1' => :'String',
+        :'city' => :'String',
+        :'country' => :'String',
+        :'distribution_center_code' => :'String',
+        :'merchant_id' => :'String',
+        :'pos_location_oid' => :'Integer',
+        :'postal_code' => :'String',
+        :'state_province' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'adddress2')
+        self.adddress2 = attributes[:'adddress2']
+      end
+
+      if attributes.has_key?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.has_key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'distribution_center_code')
+        self.distribution_center_code = attributes[:'distribution_center_code']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'pos_location_oid')
+        self.pos_location_oid = attributes[:'pos_location_oid']
+      end
+
+      if attributes.has_key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.has_key?(:'state_province')
+        self.state_province = attributes[:'state_province']
+      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 &&
+          adddress2 == o.adddress2 &&
+          address1 == o.address1 &&
+          city == o.city &&
+          country == o.country &&
+          distribution_center_code == o.distribution_center_code &&
+          merchant_id == o.merchant_id &&
+          pos_location_oid == o.pos_location_oid &&
+          postal_code == o.postal_code &&
+          state_province == o.state_province
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [adddress2, address1, city, country, distribution_center_code, merchant_id, pos_location_oid, postal_code, state_province].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/point_of_sale_reader.rb

@@ -0,0 +1,299 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class PointOfSaleReader
+    # The device type of the reader.
+    attr_accessor :device_type
+
+    # The label of the reader.
+    attr_accessor :label
+
+    # The merchant id that owns this point of sale reader.
+    attr_accessor :merchant_id
+
+    # The payment provider for the card reader.
+    attr_accessor :payment_provider
+
+    # Object identifier of the point of sale reader.
+    attr_accessor :pos_reader_id
+
+    # Object identifier of the point of sale register this reader is assigned to.
+    attr_accessor :pos_register_oid
+
+    # The serial number of the reader.
+    attr_accessor :serial_number
+
+    # If the payment provider is Stripe, this is the Stripe account id
+    attr_accessor :stripe_account_id
+
+    # If the payment provide is Stripe, this is the Stripe terminal reader id
+    attr_accessor :stripe_reader_id
+
+    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
+      {
+        :'device_type' => :'device_type',
+        :'label' => :'label',
+        :'merchant_id' => :'merchant_id',
+        :'payment_provider' => :'payment_provider',
+        :'pos_reader_id' => :'pos_reader_id',
+        :'pos_register_oid' => :'pos_register_oid',
+        :'serial_number' => :'serial_number',
+        :'stripe_account_id' => :'stripe_account_id',
+        :'stripe_reader_id' => :'stripe_reader_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'device_type' => :'String',
+        :'label' => :'String',
+        :'merchant_id' => :'String',
+        :'payment_provider' => :'String',
+        :'pos_reader_id' => :'Integer',
+        :'pos_register_oid' => :'Integer',
+        :'serial_number' => :'String',
+        :'stripe_account_id' => :'String',
+        :'stripe_reader_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'device_type')
+        self.device_type = attributes[:'device_type']
+      end
+
+      if attributes.has_key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'payment_provider')
+        self.payment_provider = attributes[:'payment_provider']
+      end
+
+      if attributes.has_key?(:'pos_reader_id')
+        self.pos_reader_id = attributes[:'pos_reader_id']
+      end
+
+      if attributes.has_key?(:'pos_register_oid')
+        self.pos_register_oid = attributes[:'pos_register_oid']
+      end
+
+      if attributes.has_key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      end
+
+      if attributes.has_key?(:'stripe_account_id')
+        self.stripe_account_id = attributes[:'stripe_account_id']
+      end
+
+      if attributes.has_key?(:'stripe_reader_id')
+        self.stripe_reader_id = attributes[:'stripe_reader_id']
+      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?
+      payment_provider_validator = EnumAttributeValidator.new('String', ['stripe'])
+      return false unless payment_provider_validator.valid?(@payment_provider)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] payment_provider Object to be assigned
+    def payment_provider=(payment_provider)
+      validator = EnumAttributeValidator.new('String', ['stripe'])
+      unless validator.valid?(payment_provider)
+        fail ArgumentError, 'invalid value for "payment_provider", must be one of #{validator.allowable_values}.'
+      end
+      @payment_provider = payment_provider
+    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 &&
+          device_type == o.device_type &&
+          label == o.label &&
+          merchant_id == o.merchant_id &&
+          payment_provider == o.payment_provider &&
+          pos_reader_id == o.pos_reader_id &&
+          pos_register_oid == o.pos_register_oid &&
+          serial_number == o.serial_number &&
+          stripe_account_id == o.stripe_account_id &&
+          stripe_reader_id == o.stripe_reader_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [device_type, label, merchant_id, payment_provider, pos_reader_id, pos_register_oid, serial_number, stripe_account_id, stripe_reader_id].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/point_of_sale_register.rb

@@ -0,0 +1,215 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class PointOfSaleRegister
+    # The merchant id that owns this point of sale register.
+    attr_accessor :merchant_id
+
+    # Name of the register.
+    attr_accessor :name
+
+    # Object identifier of the point of sale location where this register is located.
+    attr_accessor :pos_location_oid
+
+    # Object identifier of the point of sale register.
+    attr_accessor :pos_register_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'merchant_id' => :'merchant_id',
+        :'name' => :'name',
+        :'pos_location_oid' => :'pos_location_oid',
+        :'pos_register_oid' => :'pos_register_oid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'merchant_id' => :'String',
+        :'name' => :'String',
+        :'pos_location_oid' => :'Integer',
+        :'pos_register_oid' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'pos_location_oid')
+        self.pos_location_oid = attributes[:'pos_location_oid']
+      end
+
+      if attributes.has_key?(:'pos_register_oid')
+        self.pos_register_oid = attributes[:'pos_register_oid']
+      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 &&
+          merchant_id == o.merchant_id &&
+          name == o.name &&
+          pos_location_oid == o.pos_location_oid &&
+          pos_register_oid == o.pos_register_oid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [merchant_id, name, pos_location_oid, pos_register_oid].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.86'
+  VERSION = '3.10.87'
 end

data/lib/ultracart_api.rb

@@ -588,6 +588,7 @@ require 'ultracart_api/models/order_payment_insurance'
 require 'ultracart_api/models/order_payment_purchase_order'
 require 'ultracart_api/models/order_payment_transaction'
 require 'ultracart_api/models/order_payment_transaction_detail'
+require 'ultracart_api/models/order_point_of_sale'
 require 'ultracart_api/models/order_process_payment_request'
 require 'ultracart_api/models/order_process_payment_response'
 require 'ultracart_api/models/order_property'
@@ -609,6 +610,9 @@ require 'ultracart_api/models/order_tracking_number_detail'
 require 'ultracart_api/models/order_tracking_number_details'
 require 'ultracart_api/models/orders_response'
 require 'ultracart_api/models/permission'
+require 'ultracart_api/models/point_of_sale_location'
+require 'ultracart_api/models/point_of_sale_reader'
+require 'ultracart_api/models/point_of_sale_register'
 require 'ultracart_api/models/pricing_tier'
 require 'ultracart_api/models/pricing_tier_notification'
 require 'ultracart_api/models/pricing_tiers_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.86
+  version: 3.10.87
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -806,6 +806,7 @@ files:
 - docs/OrderPaymentPurchaseOrder.md
 - docs/OrderPaymentTransaction.md
 - docs/OrderPaymentTransactionDetail.md
+- docs/OrderPointOfSale.md
 - docs/OrderProcessPaymentRequest.md
 - docs/OrderProcessPaymentResponse.md
 - docs/OrderProperty.md
@@ -827,6 +828,9 @@ files:
 - docs/OrderTrackingNumberDetails.md
 - docs/OrdersResponse.md
 - docs/Permission.md
+- docs/PointOfSaleLocation.md
+- docs/PointOfSaleReader.md
+- docs/PointOfSaleRegister.md
 - docs/PricingTier.md
 - docs/PricingTierNotification.md
 - docs/PricingTiersResponse.md
@@ -1553,6 +1557,7 @@ files:
 - lib/ultracart_api/models/order_payment_purchase_order.rb
 - lib/ultracart_api/models/order_payment_transaction.rb
 - lib/ultracart_api/models/order_payment_transaction_detail.rb
+- lib/ultracart_api/models/order_point_of_sale.rb
 - lib/ultracart_api/models/order_process_payment_request.rb
 - lib/ultracart_api/models/order_process_payment_response.rb
 - lib/ultracart_api/models/order_property.rb
@@ -1574,6 +1579,9 @@ files:
 - lib/ultracart_api/models/order_tracking_number_details.rb
 - lib/ultracart_api/models/orders_response.rb
 - lib/ultracart_api/models/permission.rb
+- lib/ultracart_api/models/point_of_sale_location.rb
+- lib/ultracart_api/models/point_of_sale_reader.rb
+- lib/ultracart_api/models/point_of_sale_register.rb
 - lib/ultracart_api/models/pricing_tier.rb
 - lib/ultracart_api/models/pricing_tier_notification.rb
 - lib/ultracart_api/models/pricing_tiers_response.rb