ultracart_api 4.1.83 → 4.1.85

data/lib/ultracart_api/api/order_api.rb

@@ -785,6 +785,132 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a value histogram for a given AR transaction-detail name
+    # For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input. 
+    # @param detail [String] The transaction-detail name to histogram.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :gateway The gateway name to scope to (optional).
+    # @return [nil]
+    def get_accounts_receivable_detail_value_histogram(detail, opts = {})
+      get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts)
+      nil
+    end
+
+    # Retrieve a value histogram for a given AR transaction-detail name
+    # For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input. 
+    # @param detail [String] The transaction-detail name to histogram.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :gateway The gateway name to scope to (optional).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_detail_value_histogram ...'
+      end
+      # verify the required parameter 'detail' is set
+      if @api_client.config.client_side_validation && detail.nil?
+        fail ArgumentError, "Missing the required parameter 'detail' when calling OrderApi.get_accounts_receivable_detail_value_histogram"
+      end
+      # resource path
+      local_var_path = '/order/accounts_receivable/detail_value_histogram'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'detail'] = detail
+      query_params[:'gateway'] = opts[:'gateway'] if !opts[:'gateway'].nil?
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_accounts_receivable_detail_value_histogram",
+        :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: OrderApi#get_accounts_receivable_detail_value_histogram\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve gateway / detail-name picker data for the AR filter modal
+    # For the calling merchant's Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_accounts_receivable_gateway_detail_names(opts = {})
+      get_accounts_receivable_gateway_detail_names_with_http_info(opts)
+      nil
+    end
+
+    # Retrieve gateway / detail-name picker data for the AR filter modal
+    # For the calling merchant&#39;s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_accounts_receivable_gateway_detail_names_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_gateway_detail_names ...'
+      end
+      # resource path
+      local_var_path = '/order/accounts_receivable/gateway_detail_names'
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_accounts_receivable_gateway_detail_names",
+        :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: OrderApi#get_accounts_receivable_gateway_detail_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve A/R Retry Configuration
     # Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/item.rb

@@ -52,6 +52,9 @@ module UltracartClient
     # Fulfillment Add-ons
     attr_accessor :fulfillment_addons
 
+    # Gated access codes for this item. Read-only on this object. Use the /items/{merchant_item_oid}/gated_codes endpoints to manage.
+    attr_accessor :gated_codes
+
     attr_accessor :gift_certificate
 
     attr_accessor :google_product_search
@@ -156,6 +159,7 @@ module UltracartClient
         :'email_notifications' => :'email_notifications',
         :'enrollment123' => :'enrollment123',
         :'fulfillment_addons' => :'fulfillment_addons',
+        :'gated_codes' => :'gated_codes',
         :'gift_certificate' => :'gift_certificate',
         :'google_product_search' => :'google_product_search',
         :'identifiers' => :'identifiers',
@@ -218,6 +222,7 @@ module UltracartClient
         :'email_notifications' => :'ItemEmailNotifications',
         :'enrollment123' => :'ItemEnrollment123',
         :'fulfillment_addons' => :'Array<ItemFulfillmentAddon>',
+        :'gated_codes' => :'Array<ItemGatedCode>',
         :'gift_certificate' => :'ItemGiftCertificate',
         :'google_product_search' => :'ItemGoogleProductSearch',
         :'identifiers' => :'ItemIdentifiers',
@@ -345,6 +350,12 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'gated_codes')
+        if (value = attributes[:'gated_codes']).is_a?(Array)
+          self.gated_codes = value
+        end
+      end
+
       if attributes.key?(:'gift_certificate')
         self.gift_certificate = attributes[:'gift_certificate']
       end
@@ -575,6 +586,7 @@ module UltracartClient
           email_notifications == o.email_notifications &&
           enrollment123 == o.enrollment123 &&
           fulfillment_addons == o.fulfillment_addons &&
+          gated_codes == o.gated_codes &&
           gift_certificate == o.gift_certificate &&
           google_product_search == o.google_product_search &&
           identifiers == o.identifiers &&
@@ -621,7 +633,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [accounting, amember, auto_order, ccbill, channel_partner_item_mappings, chargeback, checkout, content, creation_dts, description, description_translated_text_instance_oid, digital_delivery, ebay, email_notifications, enrollment123, fulfillment_addons, gift_certificate, google_product_search, identifiers, inactive, instant_payment_notifications, internal, kit, kit_component_only, kit_definition, last_modified_dts, merchant_id, merchant_item_id, merchant_item_oid, options, parent_category_id, parent_category_path, payment_processing, physical, pricing, properties, realtime_pricing, recommend_replenishment_days, related, reporting, restriction, revguard, reviews, salesforce, shipping, tags, tax, third_party_email_marketing, variant_items, variations, wishlist_member].hash
+      [accounting, amember, auto_order, ccbill, channel_partner_item_mappings, chargeback, checkout, content, creation_dts, description, description_translated_text_instance_oid, digital_delivery, ebay, email_notifications, enrollment123, fulfillment_addons, gated_codes, gift_certificate, google_product_search, identifiers, inactive, instant_payment_notifications, internal, kit, kit_component_only, kit_definition, last_modified_dts, merchant_id, merchant_item_id, merchant_item_oid, options, parent_category_id, parent_category_path, payment_processing, physical, pricing, properties, realtime_pricing, recommend_replenishment_days, related, reporting, restriction, revguard, reviews, salesforce, shipping, tags, tax, third_party_email_marketing, variant_items, variations, wishlist_member].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_gated_code.rb

@@ -0,0 +1,265 @@
+=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 ItemGatedCode
+    # The access code a customer must enter at checkout.
+    attr_accessor :code
+
+    # Date/time the code was added.
+    attr_accessor :created_dts
+
+    # Internal identifier; populated by the server on insert.
+    attr_accessor :merchant_item_gated_code_oid
+
+    # Item this code is associated with.
+    attr_accessor :merchant_item_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'created_dts' => :'created_dts',
+        :'merchant_item_gated_code_oid' => :'merchant_item_gated_code_oid',
+        :'merchant_item_oid' => :'merchant_item_oid'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'created_dts' => :'String',
+        :'merchant_item_gated_code_oid' => :'Integer',
+        :'merchant_item_oid' => :'Integer'
+      }
+    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::ItemGatedCode` 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::ItemGatedCode`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'created_dts')
+        self.created_dts = attributes[:'created_dts']
+      end
+
+      if attributes.key?(:'merchant_item_gated_code_oid')
+        self.merchant_item_gated_code_oid = attributes[:'merchant_item_gated_code_oid']
+      end
+
+      if attributes.key?(:'merchant_item_oid')
+        self.merchant_item_oid = attributes[:'merchant_item_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
+      if !@code.nil? && @code.to_s.length > 255
+        invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 255.')
+      end
+
+      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?
+      return false if !@code.nil? && @code.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if !code.nil? && code.to_s.length > 255
+        fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 255.'
+      end
+
+      @code = code
+    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 &&
+          code == o.code &&
+          created_dts == o.created_dts &&
+          merchant_item_gated_code_oid == o.merchant_item_gated_code_oid &&
+          merchant_item_oid == o.merchant_item_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 [Integer] Hash code
+    def hash
+      [code, created_dts, merchant_item_gated_code_oid, merchant_item_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 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/{item_shipping_distribution_center_response.rb → item_gated_code_response.rb}

@@ -14,10 +14,10 @@ require 'date'
 require 'time'
 
 module UltracartClient
-  class ItemShippingDistributionCenterResponse
+  class ItemGatedCodeResponse
     attr_accessor :error
 
-    attr_accessor :item_shipping_distribution_center
+    attr_accessor :gated_code
 
     attr_accessor :metadata
 
@@ -30,7 +30,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'error' => :'error',
-        :'item_shipping_distribution_center' => :'itemShippingDistributionCenter',
+        :'gated_code' => :'gatedCode',
         :'metadata' => :'metadata',
         :'success' => :'success',
         :'warning' => :'warning'
@@ -46,7 +46,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'error' => :'Error',
-        :'item_shipping_distribution_center' => :'ItemShippingDistributionCenter',
+        :'gated_code' => :'ItemGatedCode',
         :'metadata' => :'ResponseMetadata',
         :'success' => :'Boolean',
         :'warning' => :'Warning'
@@ -63,13 +63,13 @@ module UltracartClient
     # @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::ItemShippingDistributionCenterResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ItemGatedCodeResponse` 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::ItemShippingDistributionCenterResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ItemGatedCodeResponse`. 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
       }
@@ -78,8 +78,8 @@ module UltracartClient
         self.error = attributes[:'error']
       end
 
-      if attributes.key?(:'item_shipping_distribution_center')
-        self.item_shipping_distribution_center = attributes[:'item_shipping_distribution_center']
+      if attributes.key?(:'gated_code')
+        self.gated_code = attributes[:'gated_code']
       end
 
       if attributes.key?(:'metadata')
@@ -114,7 +114,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           error == o.error &&
-          item_shipping_distribution_center == o.item_shipping_distribution_center &&
+          gated_code == o.gated_code &&
           metadata == o.metadata &&
           success == o.success &&
           warning == o.warning
@@ -129,7 +129,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, item_shipping_distribution_center, metadata, success, warning].hash
+      [error, gated_code, metadata, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/{item_inventory_update_request.rb → item_gated_codes_request.rb}

@@ -14,14 +14,14 @@ require 'date'
 require 'time'
 
 module UltracartClient
-  class ItemInventoryUpdateRequest
-    # Inventory updates array
-    attr_accessor :inventory_updates
+  class ItemGatedCodesRequest
+    # gated_codes
+    attr_accessor :gated_codes
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'inventory_updates' => :'inventory_updates'
+        :'gated_codes' => :'gatedCodes'
       }
     end
 
@@ -33,7 +33,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'inventory_updates' => :'Array<ItemInventoryUpdate>'
+        :'gated_codes' => :'Array<ItemGatedCode>'
       }
     end
 
@@ -47,20 +47,20 @@ module UltracartClient
     # @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::ItemInventoryUpdateRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ItemGatedCodesRequest` 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::ItemInventoryUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ItemGatedCodesRequest`. 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?(:'inventory_updates')
-        if (value = attributes[:'inventory_updates']).is_a?(Array)
-          self.inventory_updates = value
+      if attributes.key?(:'gated_codes')
+        if (value = attributes[:'gated_codes']).is_a?(Array)
+          self.gated_codes = value
         end
       end
     end
@@ -83,7 +83,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          inventory_updates == o.inventory_updates
+          gated_codes == o.gated_codes
     end
 
     # @see the `==` method
@@ -95,7 +95,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [inventory_updates].hash
+      [gated_codes].hash
     end
 
     # Builds the object from hash