ultracart_api 3.10.47 → 3.10.48

data/lib/ultracart_api/api/item_api.rb

@@ -32,6 +32,60 @@ module UltracartClient
       UltracartClient::ItemApi.new(api_client)
     end
 
+    # Delete a digital item, which is a file within the digital library, not an actual merchant item
+    # Delete a digital item on the UltraCart account. 
+    # @param digital_item_oid The digital item oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_digital_item(digital_item_oid, opts = {})
+      delete_digital_item_with_http_info(digital_item_oid, opts)
+      nil
+    end
+
+    # Delete a digital item, which is a file within the digital library, not an actual merchant item
+    # Delete a digital item on the UltraCart account. 
+    # @param digital_item_oid The digital item oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_digital_item_with_http_info(digital_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.delete_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.delete_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_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'])
+
+      # 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_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete an item
     # Delete an item on the UltraCart account. 
     # @param merchant_item_oid The item oid to delete.
@@ -86,6 +140,146 @@ module UltracartClient
       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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [ItemDigitalItemResponse]
+    def get_digital_item(digital_item_oid, opts = {})
+      data, _status_code, _headers = get_digital_item_with_http_info(digital_item_oid, opts)
+      data
+    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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def get_digital_item_with_http_info(digital_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.get_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+      query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
+
+      # 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'])
+
+      # 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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_digital_item\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
+    # Retrieves a group of digital items (file information) from the account.  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
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [ItemDigitalItemsResponse]
+    def get_digital_items(opts = {})
+      data, _status_code, _headers = get_digital_items_with_http_info(opts)
+      data
+    end
+
+    # Retrieve digital items from the digital library which are digital files that may be attached to normal items
+    # Retrieves a group of digital items (file information) from the account.  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
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
+    def get_digital_items_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items ...'
+      end
+      # resource path
+      local_var_path = '/item/digital_library'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+      query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
+
+      # 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'])
+
+      # 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 => 'ItemDigitalItemsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve an item
     # Retrieves a single item using the specified item oid. 
     # @param merchant_item_oid The item oid to retrieve.
@@ -333,6 +527,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a file within the digital library
+    # Create a file within the digital library.  This does not create an item, but makes this digital file available and selectable as part (or all) of an item. 
+    # @param digital_item Digital item to create
+    # @param [Hash] opts the optional parameters
+    # @return [ItemDigitalItemResponse]
+    def insert_digital_item(digital_item, opts = {})
+      data, _status_code, _headers = insert_digital_item_with_http_info(digital_item, opts)
+      data
+    end
+
+    # Create a file within the digital library
+    # Create a file within the digital library.  This does not create an item, but makes this digital file available and selectable as part (or all) of an item. 
+    # @param digital_item Digital item to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def insert_digital_item_with_http_info(digital_item, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.insert_digital_item ...'
+      end
+      # verify the required parameter 'digital_item' is set
+      if @api_client.config.client_side_validation && digital_item.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.insert_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library'
+
+      # 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(digital_item)
+      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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#insert_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create an item
     # Create a new item on the UltraCart account. 
     # @param item Item to create
@@ -394,6 +643,67 @@ module UltracartClient
       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.
+    # @param digital_item Digital item to update
+    # @param [Hash] opts the optional parameters
+    # @return [ItemDigitalItemResponse]
+    def update_digital_item(digital_item_oid, digital_item, opts = {})
+      data, _status_code, _headers = update_digital_item_with_http_info(digital_item_oid, digital_item, opts)
+      data
+    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.
+    # @param digital_item Digital item to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def update_digital_item_with_http_info(digital_item_oid, digital_item, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.update_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.update_digital_item"
+      end
+      # verify the required parameter 'digital_item' is set
+      if @api_client.config.client_side_validation && digital_item.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.update_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_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(digital_item)
+      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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#update_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update an item
     # Update a new item on the UltraCart account. 
     # @param item Item to update

data/lib/ultracart_api/models/item_digital_item.rb

@@ -14,40 +14,59 @@ require 'date'
 
 module UltracartClient
   class ItemDigitalItem
+    # Click wrap agreement is presented to the customer before they can purchase your product.
+    attr_accessor :click_wrap_agreement
+
     # File creation date
     attr_accessor :creation_dts
 
     # Description of the digital item
     attr_accessor :description
 
+    # The Digital item oid is a primary key used internally by UltraCart.  You should not set or change this value.  Doing so will have no effect.
+    attr_accessor :digital_item_oid
+
     # File size
     attr_accessor :file_size
 
+    # This url is sourced to create or update a digital file in your digital library.  It is only considered during an insert or update operation.
+    attr_accessor :import_from_url
+
     # Mime type associated with the file
     attr_accessor :mime_type
 
     # Original filename
     attr_accessor :original_filename
 
+    attr_accessor :pdf_meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'click_wrap_agreement' => :'click_wrap_agreement',
         :'creation_dts' => :'creation_dts',
         :'description' => :'description',
+        :'digital_item_oid' => :'digital_item_oid',
         :'file_size' => :'file_size',
+        :'import_from_url' => :'import_from_url',
         :'mime_type' => :'mime_type',
-        :'original_filename' => :'original_filename'
+        :'original_filename' => :'original_filename',
+        :'pdf_meta' => :'pdf_meta'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'click_wrap_agreement' => :'String',
         :'creation_dts' => :'String',
         :'description' => :'String',
+        :'digital_item_oid' => :'Integer',
         :'file_size' => :'Integer',
+        :'import_from_url' => :'String',
         :'mime_type' => :'String',
-        :'original_filename' => :'String'
+        :'original_filename' => :'String',
+        :'pdf_meta' => :'ItemDigitalItemPdfMeta'
       }
     end
 
@@ -59,6 +78,10 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'click_wrap_agreement')
+        self.click_wrap_agreement = attributes[:'click_wrap_agreement']
+      end
+
       if attributes.has_key?(:'creation_dts')
         self.creation_dts = attributes[:'creation_dts']
       end
@@ -67,10 +90,18 @@ module UltracartClient
         self.description = attributes[:'description']
       end
 
+      if attributes.has_key?(:'digital_item_oid')
+        self.digital_item_oid = attributes[:'digital_item_oid']
+      end
+
       if attributes.has_key?(:'file_size')
         self.file_size = attributes[:'file_size']
       end
 
+      if attributes.has_key?(:'import_from_url')
+        self.import_from_url = attributes[:'import_from_url']
+      end
+
       if attributes.has_key?(:'mime_type')
         self.mime_type = attributes[:'mime_type']
       end
@@ -78,6 +109,10 @@ module UltracartClient
       if attributes.has_key?(:'original_filename')
         self.original_filename = attributes[:'original_filename']
       end
+
+      if attributes.has_key?(:'pdf_meta')
+        self.pdf_meta = attributes[:'pdf_meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,11 +178,15 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          click_wrap_agreement == o.click_wrap_agreement &&
           creation_dts == o.creation_dts &&
           description == o.description &&
+          digital_item_oid == o.digital_item_oid &&
           file_size == o.file_size &&
+          import_from_url == o.import_from_url &&
           mime_type == o.mime_type &&
-          original_filename == o.original_filename
+          original_filename == o.original_filename &&
+          pdf_meta == o.pdf_meta
     end
 
     # @see the `==` method
@@ -159,7 +198,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [creation_dts, description, file_size, mime_type, original_filename].hash
+      [click_wrap_agreement, creation_dts, description, digital_item_oid, file_size, import_from_url, mime_type, original_filename, pdf_meta].hash
     end
 
     # Builds the object from hash