ultracart_api 3.10.136 → 3.10.138

data/lib/ultracart_api/api/item_api.rb

@@ -140,6 +140,66 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Delete a review
+    # Delete an item review. 
+    # @param review_oid The review oid to delete.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_review(review_oid, merchant_item_oid, opts = {})
+      delete_review_with_http_info(review_oid, merchant_item_oid, opts)
+      nil
+    end
+
+    # Delete a review
+    # Delete an item review. 
+    # @param review_oid The review oid to delete.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_review_with_http_info(review_oid, merchant_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.delete_review ...'
+      end
+      # verify the required parameter 'review_oid' is set
+      if @api_client.config.client_side_validation && review_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.delete_review"
+      end
+      # verify the required parameter 'merchant_item_oid' is set
+      if @api_client.config.client_side_validation && merchant_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.delete_review"
+      end
+      # resource path
+      local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#delete_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
     # Retrieves a digital item (file information) from the account.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. 
     # @param digital_item_oid The digital item oid to retrieve.
@@ -564,6 +624,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get a review
+    # Retrieve an item review. 
+    # @param review_oid The review oid to retrieve.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [ItemReviewResponse]
+    def get_review(review_oid, merchant_item_oid, opts = {})
+      data, _status_code, _headers = get_review_with_http_info(review_oid, merchant_item_oid, opts)
+      data
+    end
+
+    # Get a review
+    # Retrieve an item review. 
+    # @param review_oid The review oid to retrieve.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemReviewResponse, Fixnum, Hash)>] ItemReviewResponse data, response status code and response headers
+    def get_review_with_http_info(review_oid, merchant_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_review ...'
+      end
+      # verify the required parameter 'review_oid' is set
+      if @api_client.config.client_side_validation && review_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.get_review"
+      end
+      # verify the required parameter 'merchant_item_oid' is set
+      if @api_client.config.client_side_validation && merchant_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_review"
+      end
+      # resource path
+      local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemReviewResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get reviews for an item
+    # Retrieve item reviews. 
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [ItemReviewsResponse]
+    def get_reviews(merchant_item_oid, opts = {})
+      data, _status_code, _headers = get_reviews_with_http_info(merchant_item_oid, opts)
+      data
+    end
+
+    # Get reviews for an item
+    # Retrieve item reviews. 
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemReviewsResponse, Fixnum, Hash)>] ItemReviewsResponse data, response status code and response headers
+    def get_reviews_with_http_info(merchant_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_reviews ...'
+      end
+      # verify the required parameter 'merchant_item_oid' is set
+      if @api_client.config.client_side_validation && merchant_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_reviews"
+      end
+      # resource path
+      local_var_path = '/item/items/{merchant_item_oid}/reviews'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemReviewsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_reviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
     # Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items.  If no parameters are specified, all digital items will be returned.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters
@@ -747,6 +923,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Insert a review
+    # Insert a item review. 
+    # @param review Review to insert
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [ItemReviewResponse]
+    def insert_review(review, merchant_item_oid, opts = {})
+      data, _status_code, _headers = insert_review_with_http_info(review, merchant_item_oid, opts)
+      data
+    end
+
+    # Insert a review
+    # Insert a item review. 
+    # @param review Review to insert
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemReviewResponse, Fixnum, Hash)>] ItemReviewResponse data, response status code and response headers
+    def insert_review_with_http_info(review, merchant_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.insert_review ...'
+      end
+      # verify the required parameter 'review' is set
+      if @api_client.config.client_side_validation && review.nil?
+        fail ArgumentError, "Missing the required parameter 'review' when calling ItemApi.insert_review"
+      end
+      # verify the required parameter 'merchant_item_oid' is set
+      if @api_client.config.client_side_validation && merchant_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.insert_review"
+      end
+      # resource path
+      local_var_path = '/item/items/{merchant_item_oid}/reviews'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(review)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemReviewResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#insert_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Updates a file within the digital library
     # Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
     # @param digital_item_oid The digital item oid to update.
@@ -939,6 +1176,73 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a review
+    # Update an item review. 
+    # @param review Review to update
+    # @param review_oid The review oid to update.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [ItemReviewResponse]
+    def update_review(review, review_oid, merchant_item_oid, opts = {})
+      data, _status_code, _headers = update_review_with_http_info(review, review_oid, merchant_item_oid, opts)
+      data
+    end
+
+    # Update a review
+    # Update an item review. 
+    # @param review Review to update
+    # @param review_oid The review oid to update.
+    # @param merchant_item_oid The item oid the review is associated with.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemReviewResponse, Fixnum, Hash)>] ItemReviewResponse data, response status code and response headers
+    def update_review_with_http_info(review, review_oid, merchant_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.update_review ...'
+      end
+      # verify the required parameter 'review' is set
+      if @api_client.config.client_side_validation && review.nil?
+        fail ArgumentError, "Missing the required parameter 'review' when calling ItemApi.update_review"
+      end
+      # verify the required parameter 'review_oid' is set
+      if @api_client.config.client_side_validation && review_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.update_review"
+      end
+      # verify the required parameter 'merchant_item_oid' is set
+      if @api_client.config.client_side_validation && merchant_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_review"
+      end
+      # resource path
+      local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(review)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemReviewResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#update_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Upload an image to the temporary multimedia.
     # Uploads an image and returns back meta information about the image as well as the identifier needed for the item update. 
     # @param file File to upload

data/lib/ultracart_api/models/auto_order_item.rb

@@ -35,6 +35,9 @@ module UltracartClient
     # Primary key of AutoOrderItem
     attr_accessor :auto_order_item_oid
 
+    # Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet.
+    attr_accessor :first_order_dts
+
     # Frequency of the rebill if not a fixed schedule
     attr_accessor :frequency
 
@@ -68,6 +71,9 @@ module UltracartClient
     # The original quantity purchased
     attr_accessor :original_quantity
 
+    # True if paused.  This field is an object instead of a primitive for backwards compatibility.
+    attr_accessor :paused
+
     # The PayPal Payer ID tied to this item
     attr_accessor :paypal_payer_id
 
@@ -117,6 +123,7 @@ module UltracartClient
         :'arbitrary_unit_cost' => :'arbitrary_unit_cost',
         :'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
         :'auto_order_item_oid' => :'auto_order_item_oid',
+        :'first_order_dts' => :'first_order_dts',
         :'frequency' => :'frequency',
         :'future_schedules' => :'future_schedules',
         :'last_order_dts' => :'last_order_dts',
@@ -128,6 +135,7 @@ module UltracartClient
         :'options' => :'options',
         :'original_item_id' => :'original_item_id',
         :'original_quantity' => :'original_quantity',
+        :'paused' => :'paused',
         :'paypal_payer_id' => :'paypal_payer_id',
         :'paypal_recurring_payment_profile_id' => :'paypal_recurring_payment_profile_id',
         :'preshipment_notice_sent' => :'preshipment_notice_sent',
@@ -147,6 +155,7 @@ module UltracartClient
         :'arbitrary_unit_cost' => :'Float',
         :'arbitrary_unit_cost_remaining_orders' => :'Integer',
         :'auto_order_item_oid' => :'Integer',
+        :'first_order_dts' => :'String',
         :'frequency' => :'String',
         :'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
         :'last_order_dts' => :'String',
@@ -158,6 +167,7 @@ module UltracartClient
         :'options' => :'Array<AutoOrderItemOption>',
         :'original_item_id' => :'String',
         :'original_quantity' => :'Float',
+        :'paused' => :'BOOLEAN',
         :'paypal_payer_id' => :'String',
         :'paypal_recurring_payment_profile_id' => :'String',
         :'preshipment_notice_sent' => :'BOOLEAN',
@@ -203,6 +213,10 @@ module UltracartClient
         self.auto_order_item_oid = attributes[:'auto_order_item_oid']
       end
 
+      if attributes.has_key?(:'first_order_dts')
+        self.first_order_dts = attributes[:'first_order_dts']
+      end
+
       if attributes.has_key?(:'frequency')
         self.frequency = attributes[:'frequency']
       end
@@ -251,6 +265,10 @@ module UltracartClient
         self.original_quantity = attributes[:'original_quantity']
       end
 
+      if attributes.has_key?(:'paused')
+        self.paused = attributes[:'paused']
+      end
+
       if attributes.has_key?(:'paypal_payer_id')
         self.paypal_payer_id = attributes[:'paypal_payer_id']
       end
@@ -313,6 +331,7 @@ module UltracartClient
           arbitrary_unit_cost == o.arbitrary_unit_cost &&
           arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
           auto_order_item_oid == o.auto_order_item_oid &&
+          first_order_dts == o.first_order_dts &&
           frequency == o.frequency &&
           future_schedules == o.future_schedules &&
           last_order_dts == o.last_order_dts &&
@@ -324,6 +343,7 @@ module UltracartClient
           options == o.options &&
           original_item_id == o.original_item_id &&
           original_quantity == o.original_quantity &&
+          paused == o.paused &&
           paypal_payer_id == o.paypal_payer_id &&
           paypal_recurring_payment_profile_id == o.paypal_recurring_payment_profile_id &&
           preshipment_notice_sent == o.preshipment_notice_sent &&
@@ -341,7 +361,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
+      [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_pricing_tier_limit.rb

@@ -26,13 +26,17 @@ module UltracartClient
     # Multiple quantity
     attr_accessor :multiple_quantity
 
+    # Payment method validity
+    attr_accessor :payment_method_validity
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'cumulative_order_limit' => :'cumulative_order_limit',
         :'exempt_from_minimum_item_count' => :'exempt_from_minimum_item_count',
         :'individual_order_limit' => :'individual_order_limit',
-        :'multiple_quantity' => :'multiple_quantity'
+        :'multiple_quantity' => :'multiple_quantity',
+        :'payment_method_validity' => :'payment_method_validity'
       }
     end
 
@@ -42,7 +46,8 @@ module UltracartClient
         :'cumulative_order_limit' => :'Integer',
         :'exempt_from_minimum_item_count' => :'BOOLEAN',
         :'individual_order_limit' => :'Integer',
-        :'multiple_quantity' => :'Integer'
+        :'multiple_quantity' => :'Integer',
+        :'payment_method_validity' => :'Array<String>'
       }
     end
 
@@ -69,6 +74,12 @@ module UltracartClient
       if attributes.has_key?(:'multiple_quantity')
         self.multiple_quantity = attributes[:'multiple_quantity']
       end
+
+      if attributes.has_key?(:'payment_method_validity')
+        if (value = attributes[:'payment_method_validity']).is_a?(Array)
+          self.payment_method_validity = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -92,7 +103,8 @@ module UltracartClient
           cumulative_order_limit == o.cumulative_order_limit &&
           exempt_from_minimum_item_count == o.exempt_from_minimum_item_count &&
           individual_order_limit == o.individual_order_limit &&
-          multiple_quantity == o.multiple_quantity
+          multiple_quantity == o.multiple_quantity &&
+          payment_method_validity == o.payment_method_validity
     end
 
     # @see the `==` method
@@ -104,7 +116,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cumulative_order_limit, exempt_from_minimum_item_count, individual_order_limit, multiple_quantity].hash
+      [cumulative_order_limit, exempt_from_minimum_item_count, individual_order_limit, multiple_quantity, payment_method_validity].hash
     end
 
     # Builds the object from hash