ultracart_api 3.10.46 → 3.10.48

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 377b9d095f723be07c9afffb03549128473ca5d53d2db8166589f5b1927f3c7a
4
- data.tar.gz: c9798b40411f46e8a96ddfc213582bee2f6b5147c24c66a42ad842b4171149e8
3
+ metadata.gz: 33e79556b76fb2f412242aa2f9305041d05f5aa515b7556e9d9d48d89ac32c5f
4
+ data.tar.gz: de122d8d9c19d57dec8e1a81268f4a0e23f66c1300eee8f975c8276bd6953c57
5
5
  SHA512:
6
- metadata.gz: 87e752a22dc48d8d6f2803e37717c0ec756044c467beb0fa8de4edade1573074718fc3acede9530c5a866ece6af81628bc925626720f491163087e877c0192f2
7
- data.tar.gz: dfeb897c6054f77b3f11b35e09dcec872b72955056a4f823f14cb60e964da372c099b0bdb2d0edf37543aa737866bee268e824195873e462cb3914272f597d21
6
+ metadata.gz: a408efec60e7d6b5359ba6f166238c69b64e61522d9c328b6cc5ba19240d899546cbf52d4f0d05331fe6a2739e2055f78ccd7995f6d473bf9244251c7e87027c
7
+ data.tar.gz: eeba3e58bf01b60ac319efdc32ef298f8a7d516184b44e6eca73d1f8debaa27ef8db8cbcd29109fd96bc1a213d36388decee55a661717e86950380817e272257
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.10.46
10
+ - Package version: 3.10.48
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.10.46.gem
27
+ gem install ./ultracart_api-3.10.48.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.46.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.48.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.10.46'
35
+ gem 'ultracart_api', '~> 3.10.48'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -125,8 +125,10 @@ Class | Method | HTTP request | Description
125
125
  *UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
126
126
  *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
127
127
  *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
128
+ *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
128
129
  *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
129
130
  *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
131
+ *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
130
132
  *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
131
133
  *UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
132
134
  *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
@@ -191,12 +193,17 @@ Class | Method | HTTP request | Description
191
193
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
192
194
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
193
195
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
196
+ *UltracartClient::ItemApi* | [**delete_digital_item**](docs/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
194
197
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
198
+ *UltracartClient::ItemApi* | [**get_digital_item**](docs/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
199
+ *UltracartClient::ItemApi* | [**get_digital_items**](docs/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
195
200
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
196
201
  *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
197
202
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
198
203
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
204
+ *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
199
205
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
206
+ *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
200
207
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
201
208
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
202
209
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -572,6 +579,7 @@ Class | Method | HTTP request | Description
572
579
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
573
580
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
574
581
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
582
+ - [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
575
583
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
576
584
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
577
585
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
@@ -853,6 +861,9 @@ Class | Method | HTTP request | Description
853
861
  - [UltracartClient::ItemContentMultimediaThumbnail](docs/ItemContentMultimediaThumbnail.md)
854
862
  - [UltracartClient::ItemDigitalDelivery](docs/ItemDigitalDelivery.md)
855
863
  - [UltracartClient::ItemDigitalItem](docs/ItemDigitalItem.md)
864
+ - [UltracartClient::ItemDigitalItemPdfMeta](docs/ItemDigitalItemPdfMeta.md)
865
+ - [UltracartClient::ItemDigitalItemResponse](docs/ItemDigitalItemResponse.md)
866
+ - [UltracartClient::ItemDigitalItemsResponse](docs/ItemDigitalItemsResponse.md)
856
867
  - [UltracartClient::ItemEbay](docs/ItemEbay.md)
857
868
  - [UltracartClient::ItemEbayCategorySpecific](docs/ItemEbayCategorySpecific.md)
858
869
  - [UltracartClient::ItemEbayMarketListing](docs/ItemEbayMarketListing.md)
@@ -1185,6 +1196,8 @@ Not every change is committed to every SDK.
1185
1196
 
1186
1197
  | Version | Date | Comments |
1187
1198
  | --: | :-: | --- |
1199
+ | 3.10.48 | 09/22/2022 | testing digital file mgmt calls |
1200
+ | 3.10.47 | 09/19/2022 | conversations pagination |
1188
1201
  | 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
1189
1202
  | 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
1190
1203
  | 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
@@ -4,8 +4,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
7
8
  [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
8
9
  [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
10
+ [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
9
11
  [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
10
12
  [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
11
13
  [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
@@ -15,6 +17,50 @@ Method | HTTP request | Description
15
17
  [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
16
18
 
17
19
 
20
+ # **get_agent_keep_alive**
21
+ > get_agent_keep_alive
22
+
23
+ Agent keep alive
24
+
25
+ Called periodically by the conversation API to keep the session alive.
26
+
27
+ ### Example
28
+ ```ruby
29
+ # load the gem
30
+ require 'ultracart_api'
31
+
32
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
33
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
34
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
35
+
36
+
37
+
38
+ begin
39
+ #Agent keep alive
40
+ api_instance.get_agent_keep_alive
41
+ rescue UltracartClient::ApiError => e
42
+ puts "Exception when calling ConversationApi->get_agent_keep_alive: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+ This endpoint does not need any parameter.
48
+
49
+ ### Return type
50
+
51
+ nil (empty response body)
52
+
53
+ ### Authorization
54
+
55
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json
60
+ - **Accept**: application/json
61
+
62
+
63
+
18
64
  # **get_agent_websocket_authorization**
19
65
  > ConversationAgentAuthResponse get_agent_websocket_authorization
20
66
 
@@ -61,7 +107,7 @@ This endpoint does not need any parameter.
61
107
 
62
108
 
63
109
  # **get_conversation**
64
- > ConversationResponse get_conversation(conversation_uuid)
110
+ > ConversationResponse get_conversation(conversation_uuid, opts)
65
111
 
66
112
  Retrieve a conversation
67
113
 
@@ -79,10 +125,13 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
79
125
 
80
126
  conversation_uuid = 'conversation_uuid_example' # String |
81
127
 
128
+ opts = {
129
+ limit: 56 # Integer |
130
+ }
82
131
 
83
132
  begin
84
133
  #Retrieve a conversation
85
- result = api_instance.get_conversation(conversation_uuid)
134
+ result = api_instance.get_conversation(conversation_uuid, opts)
86
135
  p result
87
136
  rescue UltracartClient::ApiError => e
88
137
  puts "Exception when calling ConversationApi->get_conversation: #{e}"
@@ -94,6 +143,7 @@ end
94
143
  Name | Type | Description | Notes
95
144
  ------------- | ------------- | ------------- | -------------
96
145
  **conversation_uuid** | **String**| |
146
+ **limit** | **Integer**| | [optional]
97
147
 
98
148
  ### Return type
99
149
 
@@ -110,6 +160,63 @@ Name | Type | Description | Notes
110
160
 
111
161
 
112
162
 
163
+ # **get_conversation_messages**
164
+ > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
165
+
166
+ Retrieve conversation messages
167
+
168
+ Retrieve conversation messages since a particular time
169
+
170
+ ### Example
171
+ ```ruby
172
+ # load the gem
173
+ require 'ultracart_api'
174
+
175
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
176
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
177
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
178
+
179
+
180
+ conversation_uuid = 'conversation_uuid_example' # String |
181
+
182
+ since = 789 # Integer |
183
+
184
+ opts = {
185
+ limit: 56 # Integer |
186
+ }
187
+
188
+ begin
189
+ #Retrieve conversation messages
190
+ result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
191
+ p result
192
+ rescue UltracartClient::ApiError => e
193
+ puts "Exception when calling ConversationApi->get_conversation_messages: #{e}"
194
+ end
195
+ ```
196
+
197
+ ### Parameters
198
+
199
+ Name | Type | Description | Notes
200
+ ------------- | ------------- | ------------- | -------------
201
+ **conversation_uuid** | **String**| |
202
+ **since** | **Integer**| |
203
+ **limit** | **Integer**| | [optional]
204
+
205
+ ### Return type
206
+
207
+ [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
208
+
209
+ ### Authorization
210
+
211
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
212
+
213
+ ### HTTP request headers
214
+
215
+ - **Content-Type**: application/json
216
+ - **Accept**: application/json
217
+
218
+
219
+
113
220
  # **get_conversation_multimedia_upload_url**
114
221
  > ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
115
222
 
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationMessagesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_messages** | [**Array<ConversationMessage>**](ConversationMessage.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
data/docs/ItemApi.md CHANGED
@@ -4,17 +4,71 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**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
7
8
  [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
9
+ [**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
10
+ [**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
8
11
  [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
9
12
  [**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
10
13
  [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
11
14
  [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
15
+ [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
12
16
  [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
17
+ [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
13
18
  [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
14
19
  [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
15
20
  [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
16
21
 
17
22
 
23
+ # **delete_digital_item**
24
+ > delete_digital_item(digital_item_oid)
25
+
26
+ Delete a digital item, which is a file within the digital library, not an actual merchant item
27
+
28
+ Delete a digital item on the UltraCart account.
29
+
30
+ ### Example
31
+ ```ruby
32
+ # load the gem
33
+ require 'ultracart_api'
34
+
35
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
36
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
37
+ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
38
+
39
+
40
+ digital_item_oid = 56 # Integer | The digital item oid to delete.
41
+
42
+
43
+ begin
44
+ #Delete a digital item, which is a file within the digital library, not an actual merchant item
45
+ api_instance.delete_digital_item(digital_item_oid)
46
+ rescue UltracartClient::ApiError => e
47
+ puts "Exception when calling ItemApi->delete_digital_item: #{e}"
48
+ end
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **digital_item_oid** | **Integer**| The digital item oid to delete. |
56
+
57
+ ### Return type
58
+
59
+ nil (empty response body)
60
+
61
+ ### Authorization
62
+
63
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: application/json
68
+ - **Accept**: application/json
69
+
70
+
71
+
18
72
  # **delete_item**
19
73
  > delete_item(merchant_item_oid)
20
74
 
@@ -64,6 +118,131 @@ nil (empty response body)
64
118
 
65
119
 
66
120
 
121
+ # **get_digital_item**
122
+ > ItemDigitalItemResponse get_digital_item(digital_item_oid, opts)
123
+
124
+ Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
125
+
126
+ 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.
127
+
128
+ ### Example
129
+ ```ruby
130
+ # load the gem
131
+ require 'ultracart_api'
132
+
133
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
134
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
135
+ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
136
+
137
+
138
+ digital_item_oid = 56 # Integer | The digital item oid to retrieve.
139
+
140
+ opts = {
141
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
142
+ _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
143
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
144
+ _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.
145
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
146
+ _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
147
+ }
148
+
149
+ begin
150
+ #Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
151
+ result = api_instance.get_digital_item(digital_item_oid, opts)
152
+ p result
153
+ rescue UltracartClient::ApiError => e
154
+ puts "Exception when calling ItemApi->get_digital_item: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ Name | Type | Description | Notes
161
+ ------------- | ------------- | ------------- | -------------
162
+ **digital_item_oid** | **Integer**| The digital item oid to retrieve. |
163
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
164
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
165
+ **_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
166
+ **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
167
+ **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
168
+ **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
169
+
170
+ ### Return type
171
+
172
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
173
+
174
+ ### Authorization
175
+
176
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: application/json
181
+ - **Accept**: application/json
182
+
183
+
184
+
185
+ # **get_digital_items**
186
+ > ItemDigitalItemsResponse get_digital_items(opts)
187
+
188
+ Retrieve digital items from the digital library which are digital files that may be attached to normal items
189
+
190
+ 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.
191
+
192
+ ### Example
193
+ ```ruby
194
+ # load the gem
195
+ require 'ultracart_api'
196
+
197
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
198
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
199
+ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
200
+
201
+
202
+ opts = {
203
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
204
+ _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
205
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
206
+ _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.
207
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
208
+ _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
209
+ }
210
+
211
+ begin
212
+ #Retrieve digital items from the digital library which are digital files that may be attached to normal items
213
+ result = api_instance.get_digital_items(opts)
214
+ p result
215
+ rescue UltracartClient::ApiError => e
216
+ puts "Exception when calling ItemApi->get_digital_items: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ Name | Type | Description | Notes
223
+ ------------- | ------------- | ------------- | -------------
224
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
225
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
226
+ **_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
227
+ **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
228
+ **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
229
+ **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
230
+
231
+ ### Return type
232
+
233
+ [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
234
+
235
+ ### Authorization
236
+
237
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: application/json
242
+ - **Accept**: application/json
243
+
244
+
245
+
67
246
  # **get_item**
68
247
  > ItemResponse get_item(merchant_item_oid, opts)
69
248
 
@@ -292,6 +471,56 @@ Name | Type | Description | Notes
292
471
 
293
472
 
294
473
 
474
+ # **insert_digital_item**
475
+ > ItemDigitalItemResponse insert_digital_item(digital_item)
476
+
477
+ Create a file within the digital library
478
+
479
+ 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.
480
+
481
+ ### Example
482
+ ```ruby
483
+ # load the gem
484
+ require 'ultracart_api'
485
+
486
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
487
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
488
+ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
489
+
490
+
491
+ digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to create
492
+
493
+
494
+ begin
495
+ #Create a file within the digital library
496
+ result = api_instance.insert_digital_item(digital_item)
497
+ p result
498
+ rescue UltracartClient::ApiError => e
499
+ puts "Exception when calling ItemApi->insert_digital_item: #{e}"
500
+ end
501
+ ```
502
+
503
+ ### Parameters
504
+
505
+ Name | Type | Description | Notes
506
+ ------------- | ------------- | ------------- | -------------
507
+ **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md)| Digital item to create |
508
+
509
+ ### Return type
510
+
511
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
512
+
513
+ ### Authorization
514
+
515
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
516
+
517
+ ### HTTP request headers
518
+
519
+ - **Content-Type**: application/json; charset=UTF-8
520
+ - **Accept**: application/json
521
+
522
+
523
+
295
524
  # **insert_item**
296
525
  > ItemResponse insert_item(item, opts)
297
526
 
@@ -348,6 +577,59 @@ Name | Type | Description | Notes
348
577
 
349
578
 
350
579
 
580
+ # **update_digital_item**
581
+ > ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
582
+
583
+ Updates a file within the digital library
584
+
585
+ 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.
586
+
587
+ ### Example
588
+ ```ruby
589
+ # load the gem
590
+ require 'ultracart_api'
591
+
592
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
593
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
594
+ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
595
+
596
+
597
+ digital_item_oid = 56 # Integer | The digital item oid to update.
598
+
599
+ digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to update
600
+
601
+
602
+ begin
603
+ #Updates a file within the digital library
604
+ result = api_instance.update_digital_item(digital_item_oid, digital_item)
605
+ p result
606
+ rescue UltracartClient::ApiError => e
607
+ puts "Exception when calling ItemApi->update_digital_item: #{e}"
608
+ end
609
+ ```
610
+
611
+ ### Parameters
612
+
613
+ Name | Type | Description | Notes
614
+ ------------- | ------------- | ------------- | -------------
615
+ **digital_item_oid** | **Integer**| The digital item oid to update. |
616
+ **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md)| Digital item to update |
617
+
618
+ ### Return type
619
+
620
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
621
+
622
+ ### Authorization
623
+
624
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: application/json; charset=UTF-8
629
+ - **Accept**: application/json
630
+
631
+
632
+
351
633
  # **update_item**
352
634
  > ItemResponse update_item(item, merchant_item_oid, opts)
353
635
 
@@ -3,10 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **click_wrap_agreement** | **String** | Click wrap agreement is presented to the customer before they can purchase your product. | [optional]
6
7
  **creation_dts** | **String** | File creation date | [optional]
7
8
  **description** | **String** | Description of the digital item | [optional]
9
+ **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]
8
10
  **file_size** | **Integer** | File size | [optional]
11
+ **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]
9
12
  **mime_type** | **String** | Mime type associated with the file | [optional]
10
13
  **original_filename** | **String** | Original filename | [optional]
14
+ **pdf_meta** | [**ItemDigitalItemPdfMeta**](ItemDigitalItemPdfMeta.md) | | [optional]
11
15
 
12
16
 
@@ -0,0 +1,18 @@
1
+ # UltracartClient::ItemDigitalItemPdfMeta
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **assembly_allowed** | **BOOLEAN** | Assembly allowed | [optional]
7
+ **copy_allowed** | **BOOLEAN** | Copy/Paste is allowed | [optional]
8
+ **custom_footer** | **String** | A custom footer for each pdf page | [optional]
9
+ **custom_header** | **String** | A custom header for each pdf page | [optional]
10
+ **degraded_printing_allowed** | **BOOLEAN** | Degraded printing allowed | [optional]
11
+ **fillin_allowed** | **BOOLEAN** | Fillin is allowed | [optional]
12
+ **modify_annotations_allowed** | **BOOLEAN** | Modifying annotations is allowed | [optional]
13
+ **modify_contents_allowed** | **BOOLEAN** | Modifying contents is allowed | [optional]
14
+ **printing_allowed** | **BOOLEAN** | Printing is allowed | [optional]
15
+ **screen_readers_allowed** | **BOOLEAN** | Screen readers are allowed | [optional]
16
+ **tagged** | **BOOLEAN** | PDF is tagged | [optional]
17
+
18
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ItemDigitalItemResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ItemDigitalItemsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **digital_items** | [**Array<ItemDigitalItem>**](ItemDigitalItem.md) | digital_items | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+