ultracart_api 4.0.63.rc → 4.0.65.rc

data/docs/ItemApi.md

@@ -4,17 +4,92 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**delete_digital_item**](ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item |
 | [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item |
+| [**get_digital_item**](ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items |
+| [**get_digital_items**](ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items |
 | [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item |
 | [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id |
 | [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
 | [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers |
+| [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
 | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
+| [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
 | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
 | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
 | [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia. |
 
 
+## delete_digital_item
+
+> delete_digital_item(digital_item_oid)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+digital_item_oid = 56 # Integer | The digital item oid to delete.
+
+begin
+  # Delete a digital item, which is a file within the digital library, not an actual merchant item
+  api_instance.delete_digital_item(digital_item_oid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->delete_digital_item: #{e}"
+end
+```
+
+#### Using the delete_digital_item_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_digital_item_with_http_info(digital_item_oid)
+
+```ruby
+begin
+  # Delete a digital item, which is a file within the digital library, not an actual merchant item
+  data, status_code, headers = api_instance.delete_digital_item_with_http_info(digital_item_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->delete_digital_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_item_oid** | **Integer** | The digital item oid to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_item
 
 > delete_item(merchant_item_oid)
@@ -85,6 +160,174 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## get_digital_item
+
+> <ItemDigitalItemResponse> get_digital_item(digital_item_oid, opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+digital_item_oid = 56 # Integer | The digital item oid to retrieve.
+opts = {
+  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
+  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
+  _sort: '_sort_example', # String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+  _expand: '_expand_example', # String | The object expansion to perform on the result.  See documentation for examples
+  _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+}
+
+begin
+  # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
+  result = api_instance.get_digital_item(digital_item_oid, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->get_digital_item: #{e}"
+end
+```
+
+#### Using the get_digital_item_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ItemDigitalItemResponse>, Integer, Hash)> get_digital_item_with_http_info(digital_item_oid, opts)
+
+```ruby
+begin
+  # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
+  data, status_code, headers = api_instance.get_digital_item_with_http_info(digital_item_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ItemDigitalItemResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->get_digital_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_item_oid** | **Integer** | The digital item oid to retrieve. |  |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+| **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
+| **_sort** | **String** | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+| **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. | [optional] |
+
+### Return type
+
+[**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_digital_items
+
+> <ItemDigitalItemsResponse> get_digital_items(opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+opts = {
+  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
+  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
+  _sort: '_sort_example', # String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+  _expand: '_expand_example', # String | The object expansion to perform on the result.  See documentation for examples
+  _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+}
+
+begin
+  # Retrieve digital items from the digital library which are digital files that may be attached to normal items
+  result = api_instance.get_digital_items(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->get_digital_items: #{e}"
+end
+```
+
+#### Using the get_digital_items_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ItemDigitalItemsResponse>, Integer, Hash)> get_digital_items_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve digital items from the digital library which are digital files that may be attached to normal items
+  data, status_code, headers = api_instance.get_digital_items_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ItemDigitalItemsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->get_digital_items_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+| **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
+| **_sort** | **String** | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+| **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. | [optional] |
+
+### Return type
+
+[**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_item
 
 > <ItemResponse> get_item(merchant_item_oid, opts)
@@ -399,6 +642,77 @@ end
 - **Accept**: application/json
 
 
+## insert_digital_item
+
+> <ItemDigitalItemResponse> insert_digital_item(digital_item)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to create
+
+begin
+  # Create a file within the digital library
+  result = api_instance.insert_digital_item(digital_item)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->insert_digital_item: #{e}"
+end
+```
+
+#### Using the insert_digital_item_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ItemDigitalItemResponse>, Integer, Hash)> insert_digital_item_with_http_info(digital_item)
+
+```ruby
+begin
+  # Create a file within the digital library
+  data, status_code, headers = api_instance.insert_digital_item_with_http_info(digital_item)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ItemDigitalItemResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->insert_digital_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | Digital item to create |  |
+
+### Return type
+
+[**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## insert_item
 
 > <ItemResponse> insert_item(item, opts)
@@ -476,6 +790,79 @@ end
 - **Accept**: application/json
 
 
+## update_digital_item
+
+> <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+digital_item_oid = 56 # Integer | The digital item oid to update.
+digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to update
+
+begin
+  # Updates a file within the digital library
+  result = api_instance.update_digital_item(digital_item_oid, digital_item)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->update_digital_item: #{e}"
+end
+```
+
+#### Using the update_digital_item_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ItemDigitalItemResponse>, Integer, Hash)> update_digital_item_with_http_info(digital_item_oid, digital_item)
+
+```ruby
+begin
+  # Updates a file within the digital library
+  data, status_code, headers = api_instance.update_digital_item_with_http_info(digital_item_oid, digital_item)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ItemDigitalItemResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->update_digital_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_item_oid** | **Integer** | The digital item oid to update. |  |
+| **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | Digital item to update |  |
+
+### Return type
+
+[**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## update_item
 
 > <ItemResponse> update_item(merchant_item_oid, item, opts)

data/docs/ItemDigitalItem.md

@@ -4,11 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **click_wrap_agreement** | **String** | Click wrap agreement is presented to the customer before they can purchase your product. | [optional] |
 | **creation_dts** | **String** | File creation date | [optional] |
 | **description** | **String** | Description of the digital item | [optional] |
+| **digital_item_oid** | **Integer** | 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. | [optional] |
 | **file_size** | **Integer** | File size | [optional] |
+| **import_from_url** | **String** | 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. | [optional] |
 | **mime_type** | **String** | Mime type associated with the file | [optional] |
 | **original_filename** | **String** | Original filename | [optional] |
+| **pdf_meta** | [**ItemDigitalItemPdfMeta**](ItemDigitalItemPdfMeta.md) |  | [optional] |
 
 ## Example
 
@@ -16,11 +20,15 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ItemDigitalItem.new(
+  click_wrap_agreement: null,
   creation_dts: null,
   description: null,
+  digital_item_oid: null,
   file_size: null,
+  import_from_url: null,
   mime_type: null,
-  original_filename: null
+  original_filename: null,
+  pdf_meta: null
 )
 ```
 

data/docs/ItemDigitalItemPdfMeta.md

@@ -0,0 +1,38 @@
+# UltracartClient::ItemDigitalItemPdfMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assembly_allowed** | **Boolean** | Assembly allowed | [optional] |
+| **copy_allowed** | **Boolean** | Copy/Paste is allowed | [optional] |
+| **custom_footer** | **String** | A custom footer for each pdf page | [optional] |
+| **custom_header** | **String** | A custom header for each pdf page | [optional] |
+| **degraded_printing_allowed** | **Boolean** | Degraded printing allowed | [optional] |
+| **fillin_allowed** | **Boolean** | Fillin is allowed | [optional] |
+| **modify_annotations_allowed** | **Boolean** | Modifying annotations is allowed | [optional] |
+| **modify_contents_allowed** | **Boolean** | Modifying contents is allowed | [optional] |
+| **printing_allowed** | **Boolean** | Printing is allowed | [optional] |
+| **screen_readers_allowed** | **Boolean** | Screen readers are allowed | [optional] |
+| **tagged** | **Boolean** | PDF is tagged | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemDigitalItemPdfMeta.new(
+  assembly_allowed: null,
+  copy_allowed: null,
+  custom_footer: null,
+  custom_header: null,
+  degraded_printing_allowed: null,
+  fillin_allowed: null,
+  modify_annotations_allowed: null,
+  modify_contents_allowed: null,
+  printing_allowed: null,
+  screen_readers_allowed: null,
+  tagged: null
+)
+```
+

data/docs/ItemDigitalItemResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ItemDigitalItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemDigitalItemResponse.new(
+  digital_item: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ItemDigitalItemsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ItemDigitalItemsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **digital_items** | [**Array<ItemDigitalItem>**](ItemDigitalItem.md) | digital_items | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemDigitalItemsResponse.new(
+  digital_items: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+