ultracart_api 4.0.65.rc → 4.0.67.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/docs/FileManagerPage.md +26 -0
- data/docs/ItemApi.md +88 -18
- data/docs/StorefrontApi.md +304 -0
- data/lib/ultracart_api/api/item_api.rb +76 -18
- data/lib/ultracart_api/api/storefront_api.rb +272 -0
- data/lib/ultracart_api/models/file_manager_page.rb +255 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 352f92179a3fdae83a4cd4144658a7b6c45a2764ec2d103ce2648ddf976b3743
|
4
|
+
data.tar.gz: 9f76fa9b198420493724615bd9d4b66c5efe024eca5ad83bd7c00aa2bf62911a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 68cebb6c9eb9e93440ca8c6e77539a52d82a6fe2c9651fc2deacd0f31c69452424cb1612a129516fe84f3b2468f9450966abff68a2ea2a49158cfb9390045015
|
7
|
+
data.tar.gz: e1329f222077ef8eda62b390a7135e64b35b9c6b097cf2b419352c3ff9f7d6a1d2137b803fc796406e100b9d0937ba7fc4e47ea9f825bb2e22b6a87503234c89
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.67.rc
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.67.rc.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.67.rc.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.67.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -207,6 +207,7 @@ Class | Method | HTTP request | Description
|
|
207
207
|
*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
|
208
208
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
209
209
|
*UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
210
|
+
*UltracartClient::ItemApi* | [**get_unassociated_digital_items**](docs/ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
210
211
|
*UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
211
212
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
212
213
|
*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
|
@@ -250,9 +251,12 @@ Class | Method | HTTP request | Description
|
|
250
251
|
*UltracartClient::StorefrontApi* | [**check_download_email_segment**](docs/StorefrontApi.md#check_download_email_segment) | **POST** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} | Check download of email segment
|
251
252
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
252
253
|
*UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
254
|
+
*UltracartClient::StorefrontApi* | [**create_admin_panel_fs_directory**](docs/StorefrontApi.md#create_admin_panel_fs_directory) | **POST** /storefront/{id}/adminPanel/fs/dir | Create file manager directory for admin panel
|
255
|
+
*UltracartClient::StorefrontApi* | [**create_admin_panel_fs_file_upload**](docs/StorefrontApi.md#create_admin_panel_fs_file_upload) | **POST** /storefront/{id}/adminPanel/fs/file | Upload file manager file for admin panel
|
253
256
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
254
257
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain2**](docs/StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
|
255
258
|
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
259
|
+
*UltracartClient::StorefrontApi* | [**delete_admin_panel_fs_file**](docs/StorefrontApi.md#delete_admin_panel_fs_file) | **DELETE** /storefront/{id}/adminPanel/fs/file | Delete file manager directory for admin panel
|
256
260
|
*UltracartClient::StorefrontApi* | [**delete_email_campaign_folder**](docs/StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
|
257
261
|
*UltracartClient::StorefrontApi* | [**delete_email_commseq_stat**](docs/StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
|
258
262
|
*UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
@@ -270,6 +274,7 @@ Class | Method | HTTP request | Description
|
|
270
274
|
*UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
271
275
|
*UltracartClient::StorefrontApi* | [**favorite_screen_recording**](docs/StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
|
272
276
|
*UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
277
|
+
*UltracartClient::StorefrontApi* | [**get_admin_panel_fs_directory**](docs/StorefrontApi.md#get_admin_panel_fs_directory) | **GET** /storefront/{id}/adminPanel/fs/dir | Get file manager directory for admin panel
|
273
278
|
*UltracartClient::StorefrontApi* | [**get_countries**](docs/StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
|
274
279
|
*UltracartClient::StorefrontApi* | [**get_editor_token**](docs/StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
|
275
280
|
*UltracartClient::StorefrontApi* | [**get_email_base_templates**](docs/StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
|
@@ -821,6 +826,7 @@ Class | Method | HTTP request | Description
|
|
821
826
|
- [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
|
822
827
|
- [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
|
823
828
|
- [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
|
829
|
+
- [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
|
824
830
|
- [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
|
825
831
|
- [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
|
826
832
|
- [UltracartClient::GeoPoint](docs/GeoPoint.md)
|
@@ -1205,6 +1211,8 @@ Not every change is committed to every SDK.
|
|
1205
1211
|
|
1206
1212
|
| Version | Date | Comments |
|
1207
1213
|
| --: | :-: | --- |
|
1214
|
+
| 4.0.67-RC | 09/27/2022 | added digital library call for unassociated content |
|
1215
|
+
| 4.0.66-RC | 09/22/2022 | digital item mgmt testing |
|
1208
1216
|
| 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
|
1209
1217
|
| 4.0.64-RC | 09/19/2022 | conversations pagination |
|
1210
1218
|
| 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::FileManagerPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **current_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
8
|
+
| **hostname** | **String** | | [optional] |
|
9
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
10
|
+
| **path** | **String** | | [optional] |
|
11
|
+
| **storefront_oid** | **Integer** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::FileManagerPage.new(
|
19
|
+
current_storefront_fs_directory_oid: null,
|
20
|
+
hostname: null,
|
21
|
+
parent_storefront_fs_directory_oid: null,
|
22
|
+
path: null,
|
23
|
+
storefront_oid: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/ItemApi.md
CHANGED
@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
12
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 |
|
13
13
|
| [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
|
14
14
|
| [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers |
|
15
|
+
| [**get_unassociated_digital_items**](ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items |
|
15
16
|
| [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
|
16
17
|
| [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
|
17
18
|
| [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
|
@@ -162,7 +163,7 @@ nil (empty response body)
|
|
162
163
|
|
163
164
|
## get_digital_item
|
164
165
|
|
165
|
-
> <ItemDigitalItemResponse> get_digital_item(digital_item_oid
|
166
|
+
> <ItemDigitalItemResponse> get_digital_item(digital_item_oid)
|
166
167
|
|
167
168
|
Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
168
169
|
|
@@ -183,18 +184,10 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
|
|
183
184
|
|
184
185
|
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
185
186
|
digital_item_oid = 56 # Integer | The digital item oid to retrieve.
|
186
|
-
opts = {
|
187
|
-
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
188
|
-
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
|
189
|
-
_since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
|
190
|
-
_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.
|
191
|
-
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
192
|
-
_placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
193
|
-
}
|
194
187
|
|
195
188
|
begin
|
196
189
|
# Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
197
|
-
result = api_instance.get_digital_item(digital_item_oid
|
190
|
+
result = api_instance.get_digital_item(digital_item_oid)
|
198
191
|
p result
|
199
192
|
rescue UltracartClient::ApiError => e
|
200
193
|
puts "Error when calling ItemApi->get_digital_item: #{e}"
|
@@ -205,12 +198,12 @@ end
|
|
205
198
|
|
206
199
|
This returns an Array which contains the response data, status code and headers.
|
207
200
|
|
208
|
-
> <Array(<ItemDigitalItemResponse>, Integer, Hash)> get_digital_item_with_http_info(digital_item_oid
|
201
|
+
> <Array(<ItemDigitalItemResponse>, Integer, Hash)> get_digital_item_with_http_info(digital_item_oid)
|
209
202
|
|
210
203
|
```ruby
|
211
204
|
begin
|
212
205
|
# Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
213
|
-
data, status_code, headers = api_instance.get_digital_item_with_http_info(digital_item_oid
|
206
|
+
data, status_code, headers = api_instance.get_digital_item_with_http_info(digital_item_oid)
|
214
207
|
p status_code # => 2xx
|
215
208
|
p headers # => { ... }
|
216
209
|
p data # => <ItemDigitalItemResponse>
|
@@ -224,12 +217,6 @@ end
|
|
224
217
|
| Name | Type | Description | Notes |
|
225
218
|
| ---- | ---- | ----------- | ----- |
|
226
219
|
| **digital_item_oid** | **Integer** | The digital item oid to retrieve. | |
|
227
|
-
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
|
228
|
-
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
229
|
-
| **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
|
230
|
-
| **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
|
231
|
-
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
232
|
-
| **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
|
233
220
|
|
234
221
|
### Return type
|
235
222
|
|
@@ -642,6 +629,89 @@ end
|
|
642
629
|
- **Accept**: application/json
|
643
630
|
|
644
631
|
|
632
|
+
## get_unassociated_digital_items
|
633
|
+
|
634
|
+
> <ItemDigitalItemsResponse> get_unassociated_digital_items(opts)
|
635
|
+
|
636
|
+
Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
637
|
+
|
638
|
+
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.
|
639
|
+
|
640
|
+
### Examples
|
641
|
+
|
642
|
+
```ruby
|
643
|
+
require 'time'
|
644
|
+
require 'ultracart_api'
|
645
|
+
require 'json'
|
646
|
+
require 'yaml'
|
647
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
648
|
+
|
649
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
650
|
+
# As such, this might not be the best way to use this object.
|
651
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
652
|
+
|
653
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
654
|
+
opts = {
|
655
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
656
|
+
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
|
657
|
+
_since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
|
658
|
+
_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.
|
659
|
+
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
660
|
+
_placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
661
|
+
}
|
662
|
+
|
663
|
+
begin
|
664
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
665
|
+
result = api_instance.get_unassociated_digital_items(opts)
|
666
|
+
p result
|
667
|
+
rescue UltracartClient::ApiError => e
|
668
|
+
puts "Error when calling ItemApi->get_unassociated_digital_items: #{e}"
|
669
|
+
end
|
670
|
+
```
|
671
|
+
|
672
|
+
#### Using the get_unassociated_digital_items_with_http_info variant
|
673
|
+
|
674
|
+
This returns an Array which contains the response data, status code and headers.
|
675
|
+
|
676
|
+
> <Array(<ItemDigitalItemsResponse>, Integer, Hash)> get_unassociated_digital_items_with_http_info(opts)
|
677
|
+
|
678
|
+
```ruby
|
679
|
+
begin
|
680
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
681
|
+
data, status_code, headers = api_instance.get_unassociated_digital_items_with_http_info(opts)
|
682
|
+
p status_code # => 2xx
|
683
|
+
p headers # => { ... }
|
684
|
+
p data # => <ItemDigitalItemsResponse>
|
685
|
+
rescue UltracartClient::ApiError => e
|
686
|
+
puts "Error when calling ItemApi->get_unassociated_digital_items_with_http_info: #{e}"
|
687
|
+
end
|
688
|
+
```
|
689
|
+
|
690
|
+
### Parameters
|
691
|
+
|
692
|
+
| Name | Type | Description | Notes |
|
693
|
+
| ---- | ---- | ----------- | ----- |
|
694
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
|
695
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
696
|
+
| **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
|
697
|
+
| **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
|
698
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
699
|
+
| **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
|
700
|
+
|
701
|
+
### Return type
|
702
|
+
|
703
|
+
[**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
|
704
|
+
|
705
|
+
### Authorization
|
706
|
+
|
707
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
708
|
+
|
709
|
+
### HTTP request headers
|
710
|
+
|
711
|
+
- **Content-Type**: Not defined
|
712
|
+
- **Accept**: application/json
|
713
|
+
|
714
|
+
|
645
715
|
## insert_digital_item
|
646
716
|
|
647
717
|
> <ItemDigitalItemResponse> insert_digital_item(digital_item)
|
data/docs/StorefrontApi.md
CHANGED
@@ -12,9 +12,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
12
12
|
| [**check_download_email_segment**](StorefrontApi.md#check_download_email_segment) | **POST** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} | Check download of email segment |
|
13
13
|
| [**clone_email_campaign**](StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign |
|
14
14
|
| [**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow |
|
15
|
+
| [**create_admin_panel_fs_directory**](StorefrontApi.md#create_admin_panel_fs_directory) | **POST** /storefront/{id}/adminPanel/fs/dir | Create file manager directory for admin panel |
|
16
|
+
| [**create_admin_panel_fs_file_upload**](StorefrontApi.md#create_admin_panel_fs_file_upload) | **POST** /storefront/{id}/adminPanel/fs/file | Upload file manager file for admin panel |
|
15
17
|
| [**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign |
|
16
18
|
| [**create_email_sending_domain2**](StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers |
|
17
19
|
| [**create_twilio_account**](StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account |
|
20
|
+
| [**delete_admin_panel_fs_file**](StorefrontApi.md#delete_admin_panel_fs_file) | **DELETE** /storefront/{id}/adminPanel/fs/file | Delete file manager directory for admin panel |
|
18
21
|
| [**delete_email_campaign_folder**](StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder |
|
19
22
|
| [**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats |
|
20
23
|
| [**delete_email_email**](StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email |
|
@@ -32,6 +35,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
32
35
|
| [**duplicate_library_item**](StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item. |
|
33
36
|
| [**favorite_screen_recording**](StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording |
|
34
37
|
| [**geocode_address**](StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address |
|
38
|
+
| [**get_admin_panel_fs_directory**](StorefrontApi.md#get_admin_panel_fs_directory) | **GET** /storefront/{id}/adminPanel/fs/dir | Get file manager directory for admin panel |
|
35
39
|
| [**get_countries**](StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries |
|
36
40
|
| [**get_editor_token**](StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token |
|
37
41
|
| [**get_email_base_templates**](StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates |
|
@@ -748,6 +752,154 @@ end
|
|
748
752
|
- **Accept**: application/json
|
749
753
|
|
750
754
|
|
755
|
+
## create_admin_panel_fs_directory
|
756
|
+
|
757
|
+
> <FileManagerPage> create_admin_panel_fs_directory(id, opts)
|
758
|
+
|
759
|
+
Create file manager directory for admin panel
|
760
|
+
|
761
|
+
### Examples
|
762
|
+
|
763
|
+
```ruby
|
764
|
+
require 'time'
|
765
|
+
require 'ultracart_api'
|
766
|
+
require 'json'
|
767
|
+
require 'yaml'
|
768
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
769
|
+
|
770
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
771
|
+
# As such, this might not be the best way to use this object.
|
772
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
773
|
+
|
774
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
775
|
+
id = 56 # Integer |
|
776
|
+
opts = {
|
777
|
+
name: 'name_example', # String |
|
778
|
+
parent_storefront_fs_directory_oid: 56 # Integer |
|
779
|
+
}
|
780
|
+
|
781
|
+
begin
|
782
|
+
# Create file manager directory for admin panel
|
783
|
+
result = api_instance.create_admin_panel_fs_directory(id, opts)
|
784
|
+
p result
|
785
|
+
rescue UltracartClient::ApiError => e
|
786
|
+
puts "Error when calling StorefrontApi->create_admin_panel_fs_directory: #{e}"
|
787
|
+
end
|
788
|
+
```
|
789
|
+
|
790
|
+
#### Using the create_admin_panel_fs_directory_with_http_info variant
|
791
|
+
|
792
|
+
This returns an Array which contains the response data, status code and headers.
|
793
|
+
|
794
|
+
> <Array(<FileManagerPage>, Integer, Hash)> create_admin_panel_fs_directory_with_http_info(id, opts)
|
795
|
+
|
796
|
+
```ruby
|
797
|
+
begin
|
798
|
+
# Create file manager directory for admin panel
|
799
|
+
data, status_code, headers = api_instance.create_admin_panel_fs_directory_with_http_info(id, opts)
|
800
|
+
p status_code # => 2xx
|
801
|
+
p headers # => { ... }
|
802
|
+
p data # => <FileManagerPage>
|
803
|
+
rescue UltracartClient::ApiError => e
|
804
|
+
puts "Error when calling StorefrontApi->create_admin_panel_fs_directory_with_http_info: #{e}"
|
805
|
+
end
|
806
|
+
```
|
807
|
+
|
808
|
+
### Parameters
|
809
|
+
|
810
|
+
| Name | Type | Description | Notes |
|
811
|
+
| ---- | ---- | ----------- | ----- |
|
812
|
+
| **id** | **Integer** | | |
|
813
|
+
| **name** | **String** | | [optional] |
|
814
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
815
|
+
|
816
|
+
### Return type
|
817
|
+
|
818
|
+
[**FileManagerPage**](FileManagerPage.md)
|
819
|
+
|
820
|
+
### Authorization
|
821
|
+
|
822
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
823
|
+
|
824
|
+
### HTTP request headers
|
825
|
+
|
826
|
+
- **Content-Type**: Not defined
|
827
|
+
- **Accept**: application/json
|
828
|
+
|
829
|
+
|
830
|
+
## create_admin_panel_fs_file_upload
|
831
|
+
|
832
|
+
> <FileManagerPage> create_admin_panel_fs_file_upload(id, opts)
|
833
|
+
|
834
|
+
Upload file manager file for admin panel
|
835
|
+
|
836
|
+
### Examples
|
837
|
+
|
838
|
+
```ruby
|
839
|
+
require 'time'
|
840
|
+
require 'ultracart_api'
|
841
|
+
require 'json'
|
842
|
+
require 'yaml'
|
843
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
844
|
+
|
845
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
846
|
+
# As such, this might not be the best way to use this object.
|
847
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
848
|
+
|
849
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
850
|
+
id = 56 # Integer |
|
851
|
+
opts = {
|
852
|
+
parent_storefront_fs_directory_oid: 56 # Integer |
|
853
|
+
}
|
854
|
+
|
855
|
+
begin
|
856
|
+
# Upload file manager file for admin panel
|
857
|
+
result = api_instance.create_admin_panel_fs_file_upload(id, opts)
|
858
|
+
p result
|
859
|
+
rescue UltracartClient::ApiError => e
|
860
|
+
puts "Error when calling StorefrontApi->create_admin_panel_fs_file_upload: #{e}"
|
861
|
+
end
|
862
|
+
```
|
863
|
+
|
864
|
+
#### Using the create_admin_panel_fs_file_upload_with_http_info variant
|
865
|
+
|
866
|
+
This returns an Array which contains the response data, status code and headers.
|
867
|
+
|
868
|
+
> <Array(<FileManagerPage>, Integer, Hash)> create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
869
|
+
|
870
|
+
```ruby
|
871
|
+
begin
|
872
|
+
# Upload file manager file for admin panel
|
873
|
+
data, status_code, headers = api_instance.create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
874
|
+
p status_code # => 2xx
|
875
|
+
p headers # => { ... }
|
876
|
+
p data # => <FileManagerPage>
|
877
|
+
rescue UltracartClient::ApiError => e
|
878
|
+
puts "Error when calling StorefrontApi->create_admin_panel_fs_file_upload_with_http_info: #{e}"
|
879
|
+
end
|
880
|
+
```
|
881
|
+
|
882
|
+
### Parameters
|
883
|
+
|
884
|
+
| Name | Type | Description | Notes |
|
885
|
+
| ---- | ---- | ----------- | ----- |
|
886
|
+
| **id** | **Integer** | | |
|
887
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
888
|
+
|
889
|
+
### Return type
|
890
|
+
|
891
|
+
[**FileManagerPage**](FileManagerPage.md)
|
892
|
+
|
893
|
+
### Authorization
|
894
|
+
|
895
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
896
|
+
|
897
|
+
### HTTP request headers
|
898
|
+
|
899
|
+
- **Content-Type**: Not defined
|
900
|
+
- **Accept**: application/json
|
901
|
+
|
902
|
+
|
751
903
|
## create_email_sending_domain
|
752
904
|
|
753
905
|
> <EmailSendingDomainResponse> create_email_sending_domain(domain)
|
@@ -955,6 +1107,81 @@ end
|
|
955
1107
|
- **Accept**: application/json
|
956
1108
|
|
957
1109
|
|
1110
|
+
## delete_admin_panel_fs_file
|
1111
|
+
|
1112
|
+
> <FileManagerPage> delete_admin_panel_fs_file(id, opts)
|
1113
|
+
|
1114
|
+
Delete file manager directory for admin panel
|
1115
|
+
|
1116
|
+
### Examples
|
1117
|
+
|
1118
|
+
```ruby
|
1119
|
+
require 'time'
|
1120
|
+
require 'ultracart_api'
|
1121
|
+
require 'json'
|
1122
|
+
require 'yaml'
|
1123
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1124
|
+
|
1125
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1126
|
+
# As such, this might not be the best way to use this object.
|
1127
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1128
|
+
|
1129
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1130
|
+
id = 56 # Integer |
|
1131
|
+
opts = {
|
1132
|
+
parent_storefront_fs_directory_oid: 56, # Integer |
|
1133
|
+
storefront_fs_file_oid: 56 # Integer |
|
1134
|
+
}
|
1135
|
+
|
1136
|
+
begin
|
1137
|
+
# Delete file manager directory for admin panel
|
1138
|
+
result = api_instance.delete_admin_panel_fs_file(id, opts)
|
1139
|
+
p result
|
1140
|
+
rescue UltracartClient::ApiError => e
|
1141
|
+
puts "Error when calling StorefrontApi->delete_admin_panel_fs_file: #{e}"
|
1142
|
+
end
|
1143
|
+
```
|
1144
|
+
|
1145
|
+
#### Using the delete_admin_panel_fs_file_with_http_info variant
|
1146
|
+
|
1147
|
+
This returns an Array which contains the response data, status code and headers.
|
1148
|
+
|
1149
|
+
> <Array(<FileManagerPage>, Integer, Hash)> delete_admin_panel_fs_file_with_http_info(id, opts)
|
1150
|
+
|
1151
|
+
```ruby
|
1152
|
+
begin
|
1153
|
+
# Delete file manager directory for admin panel
|
1154
|
+
data, status_code, headers = api_instance.delete_admin_panel_fs_file_with_http_info(id, opts)
|
1155
|
+
p status_code # => 2xx
|
1156
|
+
p headers # => { ... }
|
1157
|
+
p data # => <FileManagerPage>
|
1158
|
+
rescue UltracartClient::ApiError => e
|
1159
|
+
puts "Error when calling StorefrontApi->delete_admin_panel_fs_file_with_http_info: #{e}"
|
1160
|
+
end
|
1161
|
+
```
|
1162
|
+
|
1163
|
+
### Parameters
|
1164
|
+
|
1165
|
+
| Name | Type | Description | Notes |
|
1166
|
+
| ---- | ---- | ----------- | ----- |
|
1167
|
+
| **id** | **Integer** | | |
|
1168
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
1169
|
+
| **storefront_fs_file_oid** | **Integer** | | [optional] |
|
1170
|
+
|
1171
|
+
### Return type
|
1172
|
+
|
1173
|
+
[**FileManagerPage**](FileManagerPage.md)
|
1174
|
+
|
1175
|
+
### Authorization
|
1176
|
+
|
1177
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1178
|
+
|
1179
|
+
### HTTP request headers
|
1180
|
+
|
1181
|
+
- **Content-Type**: Not defined
|
1182
|
+
- **Accept**: application/json
|
1183
|
+
|
1184
|
+
|
958
1185
|
## delete_email_campaign_folder
|
959
1186
|
|
960
1187
|
> <BaseResponse> delete_email_campaign_folder(storefront_oid, email_campaign_folder_uuid)
|
@@ -2151,6 +2378,83 @@ end
|
|
2151
2378
|
- **Accept**: application/json
|
2152
2379
|
|
2153
2380
|
|
2381
|
+
## get_admin_panel_fs_directory
|
2382
|
+
|
2383
|
+
> <FileManagerPage> get_admin_panel_fs_directory(id, opts)
|
2384
|
+
|
2385
|
+
Get file manager directory for admin panel
|
2386
|
+
|
2387
|
+
### Examples
|
2388
|
+
|
2389
|
+
```ruby
|
2390
|
+
require 'time'
|
2391
|
+
require 'ultracart_api'
|
2392
|
+
require 'json'
|
2393
|
+
require 'yaml'
|
2394
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2395
|
+
|
2396
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2397
|
+
# As such, this might not be the best way to use this object.
|
2398
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2399
|
+
|
2400
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2401
|
+
id = 56 # Integer |
|
2402
|
+
opts = {
|
2403
|
+
path: 'path_example', # String |
|
2404
|
+
storefront_fs_directory_oid: 56, # Integer |
|
2405
|
+
storefront_theme_oid: 56 # Integer |
|
2406
|
+
}
|
2407
|
+
|
2408
|
+
begin
|
2409
|
+
# Get file manager directory for admin panel
|
2410
|
+
result = api_instance.get_admin_panel_fs_directory(id, opts)
|
2411
|
+
p result
|
2412
|
+
rescue UltracartClient::ApiError => e
|
2413
|
+
puts "Error when calling StorefrontApi->get_admin_panel_fs_directory: #{e}"
|
2414
|
+
end
|
2415
|
+
```
|
2416
|
+
|
2417
|
+
#### Using the get_admin_panel_fs_directory_with_http_info variant
|
2418
|
+
|
2419
|
+
This returns an Array which contains the response data, status code and headers.
|
2420
|
+
|
2421
|
+
> <Array(<FileManagerPage>, Integer, Hash)> get_admin_panel_fs_directory_with_http_info(id, opts)
|
2422
|
+
|
2423
|
+
```ruby
|
2424
|
+
begin
|
2425
|
+
# Get file manager directory for admin panel
|
2426
|
+
data, status_code, headers = api_instance.get_admin_panel_fs_directory_with_http_info(id, opts)
|
2427
|
+
p status_code # => 2xx
|
2428
|
+
p headers # => { ... }
|
2429
|
+
p data # => <FileManagerPage>
|
2430
|
+
rescue UltracartClient::ApiError => e
|
2431
|
+
puts "Error when calling StorefrontApi->get_admin_panel_fs_directory_with_http_info: #{e}"
|
2432
|
+
end
|
2433
|
+
```
|
2434
|
+
|
2435
|
+
### Parameters
|
2436
|
+
|
2437
|
+
| Name | Type | Description | Notes |
|
2438
|
+
| ---- | ---- | ----------- | ----- |
|
2439
|
+
| **id** | **Integer** | | |
|
2440
|
+
| **path** | **String** | | [optional] |
|
2441
|
+
| **storefront_fs_directory_oid** | **Integer** | | [optional] |
|
2442
|
+
| **storefront_theme_oid** | **Integer** | | [optional] |
|
2443
|
+
|
2444
|
+
### Return type
|
2445
|
+
|
2446
|
+
[**FileManagerPage**](FileManagerPage.md)
|
2447
|
+
|
2448
|
+
### Authorization
|
2449
|
+
|
2450
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2451
|
+
|
2452
|
+
### HTTP request headers
|
2453
|
+
|
2454
|
+
- **Content-Type**: Not defined
|
2455
|
+
- **Accept**: application/json
|
2456
|
+
|
2457
|
+
|
2154
2458
|
## get_countries
|
2155
2459
|
|
2156
2460
|
> <CountriesResponse> get_countries(storefront_oid)
|
@@ -164,12 +164,6 @@ module UltracartClient
|
|
164
164
|
# 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.
|
165
165
|
# @param digital_item_oid [Integer] The digital item oid to retrieve.
|
166
166
|
# @param [Hash] opts the optional parameters
|
167
|
-
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
168
|
-
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
169
|
-
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
170
|
-
# @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.
|
171
|
-
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
172
|
-
# @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
173
167
|
# @return [ItemDigitalItemResponse]
|
174
168
|
def get_digital_item(digital_item_oid, opts = {})
|
175
169
|
data, _status_code, _headers = get_digital_item_with_http_info(digital_item_oid, opts)
|
@@ -180,12 +174,6 @@ module UltracartClient
|
|
180
174
|
# 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.
|
181
175
|
# @param digital_item_oid [Integer] The digital item oid to retrieve.
|
182
176
|
# @param [Hash] opts the optional parameters
|
183
|
-
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
184
|
-
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
185
|
-
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
186
|
-
# @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.
|
187
|
-
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
188
|
-
# @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
189
177
|
# @return [Array<(ItemDigitalItemResponse, Integer, Hash)>] ItemDigitalItemResponse data, response status code and response headers
|
190
178
|
def get_digital_item_with_http_info(digital_item_oid, opts = {})
|
191
179
|
if @api_client.config.debugging
|
@@ -200,12 +188,6 @@ module UltracartClient
|
|
200
188
|
|
201
189
|
# query parameters
|
202
190
|
query_params = opts[:query_params] || {}
|
203
|
-
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
204
|
-
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
205
|
-
query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
|
206
|
-
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|
207
|
-
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
208
|
-
query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
|
209
191
|
|
210
192
|
# header parameters
|
211
193
|
header_params = opts[:header_params] || {}
|
@@ -601,6 +583,82 @@ module UltracartClient
|
|
601
583
|
return data, status_code, headers
|
602
584
|
end
|
603
585
|
|
586
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
587
|
+
# 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.
|
588
|
+
# @param [Hash] opts the optional parameters
|
589
|
+
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
590
|
+
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
591
|
+
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
592
|
+
# @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.
|
593
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
594
|
+
# @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
595
|
+
# @return [ItemDigitalItemsResponse]
|
596
|
+
def get_unassociated_digital_items(opts = {})
|
597
|
+
data, _status_code, _headers = get_unassociated_digital_items_with_http_info(opts)
|
598
|
+
data
|
599
|
+
end
|
600
|
+
|
601
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
602
|
+
# 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.
|
603
|
+
# @param [Hash] opts the optional parameters
|
604
|
+
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
605
|
+
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
606
|
+
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
607
|
+
# @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.
|
608
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
609
|
+
# @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
610
|
+
# @return [Array<(ItemDigitalItemsResponse, Integer, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
|
611
|
+
def get_unassociated_digital_items_with_http_info(opts = {})
|
612
|
+
if @api_client.config.debugging
|
613
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.get_unassociated_digital_items ...'
|
614
|
+
end
|
615
|
+
# resource path
|
616
|
+
local_var_path = '/item/digital_library/unassociated'
|
617
|
+
|
618
|
+
# query parameters
|
619
|
+
query_params = opts[:query_params] || {}
|
620
|
+
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
621
|
+
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
622
|
+
query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
|
623
|
+
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|
624
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
625
|
+
query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
|
626
|
+
|
627
|
+
# header parameters
|
628
|
+
header_params = opts[:header_params] || {}
|
629
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
630
|
+
# HTTP header 'Accept' (if needed)
|
631
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
632
|
+
|
633
|
+
# form parameters
|
634
|
+
form_params = opts[:form_params] || {}
|
635
|
+
|
636
|
+
# http body (model)
|
637
|
+
post_body = opts[:debug_body]
|
638
|
+
|
639
|
+
# return_type
|
640
|
+
return_type = opts[:debug_return_type] || 'ItemDigitalItemsResponse'
|
641
|
+
|
642
|
+
# auth_names
|
643
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
644
|
+
|
645
|
+
new_options = opts.merge(
|
646
|
+
:operation => :"ItemApi.get_unassociated_digital_items",
|
647
|
+
:header_params => header_params,
|
648
|
+
:query_params => query_params,
|
649
|
+
:form_params => form_params,
|
650
|
+
:body => post_body,
|
651
|
+
:auth_names => auth_names,
|
652
|
+
:return_type => return_type
|
653
|
+
)
|
654
|
+
|
655
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
656
|
+
if @api_client.config.debugging
|
657
|
+
@api_client.config.logger.debug "API called: ItemApi#get_unassociated_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
658
|
+
end
|
659
|
+
return data, status_code, headers
|
660
|
+
end
|
661
|
+
|
604
662
|
# Create a file within the digital library
|
605
663
|
# 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.
|
606
664
|
# @param digital_item [ItemDigitalItem] Digital item to create
|
@@ -597,6 +597,139 @@ module UltracartClient
|
|
597
597
|
return data, status_code, headers
|
598
598
|
end
|
599
599
|
|
600
|
+
# Create file manager directory for admin panel
|
601
|
+
# @param id [Integer]
|
602
|
+
# @param [Hash] opts the optional parameters
|
603
|
+
# @option opts [String] :name
|
604
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
605
|
+
# @return [FileManagerPage]
|
606
|
+
def create_admin_panel_fs_directory(id, opts = {})
|
607
|
+
data, _status_code, _headers = create_admin_panel_fs_directory_with_http_info(id, opts)
|
608
|
+
data
|
609
|
+
end
|
610
|
+
|
611
|
+
# Create file manager directory for admin panel
|
612
|
+
# @param id [Integer]
|
613
|
+
# @param [Hash] opts the optional parameters
|
614
|
+
# @option opts [String] :name
|
615
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
616
|
+
# @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
|
617
|
+
def create_admin_panel_fs_directory_with_http_info(id, opts = {})
|
618
|
+
if @api_client.config.debugging
|
619
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.create_admin_panel_fs_directory ...'
|
620
|
+
end
|
621
|
+
# verify the required parameter 'id' is set
|
622
|
+
if @api_client.config.client_side_validation && id.nil?
|
623
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_admin_panel_fs_directory"
|
624
|
+
end
|
625
|
+
# resource path
|
626
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
627
|
+
|
628
|
+
# query parameters
|
629
|
+
query_params = opts[:query_params] || {}
|
630
|
+
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
631
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
632
|
+
|
633
|
+
# header parameters
|
634
|
+
header_params = opts[:header_params] || {}
|
635
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
636
|
+
# HTTP header 'Accept' (if needed)
|
637
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
638
|
+
|
639
|
+
# form parameters
|
640
|
+
form_params = opts[:form_params] || {}
|
641
|
+
|
642
|
+
# http body (model)
|
643
|
+
post_body = opts[:debug_body]
|
644
|
+
|
645
|
+
# return_type
|
646
|
+
return_type = opts[:debug_return_type] || 'FileManagerPage'
|
647
|
+
|
648
|
+
# auth_names
|
649
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
650
|
+
|
651
|
+
new_options = opts.merge(
|
652
|
+
:operation => :"StorefrontApi.create_admin_panel_fs_directory",
|
653
|
+
:header_params => header_params,
|
654
|
+
:query_params => query_params,
|
655
|
+
:form_params => form_params,
|
656
|
+
:body => post_body,
|
657
|
+
:auth_names => auth_names,
|
658
|
+
:return_type => return_type
|
659
|
+
)
|
660
|
+
|
661
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
662
|
+
if @api_client.config.debugging
|
663
|
+
@api_client.config.logger.debug "API called: StorefrontApi#create_admin_panel_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
664
|
+
end
|
665
|
+
return data, status_code, headers
|
666
|
+
end
|
667
|
+
|
668
|
+
# Upload file manager file for admin panel
|
669
|
+
# @param id [Integer]
|
670
|
+
# @param [Hash] opts the optional parameters
|
671
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
672
|
+
# @return [FileManagerPage]
|
673
|
+
def create_admin_panel_fs_file_upload(id, opts = {})
|
674
|
+
data, _status_code, _headers = create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
675
|
+
data
|
676
|
+
end
|
677
|
+
|
678
|
+
# Upload file manager file for admin panel
|
679
|
+
# @param id [Integer]
|
680
|
+
# @param [Hash] opts the optional parameters
|
681
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
682
|
+
# @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
|
683
|
+
def create_admin_panel_fs_file_upload_with_http_info(id, opts = {})
|
684
|
+
if @api_client.config.debugging
|
685
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.create_admin_panel_fs_file_upload ...'
|
686
|
+
end
|
687
|
+
# verify the required parameter 'id' is set
|
688
|
+
if @api_client.config.client_side_validation && id.nil?
|
689
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_admin_panel_fs_file_upload"
|
690
|
+
end
|
691
|
+
# resource path
|
692
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/file'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
693
|
+
|
694
|
+
# query parameters
|
695
|
+
query_params = opts[:query_params] || {}
|
696
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
697
|
+
|
698
|
+
# header parameters
|
699
|
+
header_params = opts[:header_params] || {}
|
700
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
701
|
+
# HTTP header 'Accept' (if needed)
|
702
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
703
|
+
|
704
|
+
# form parameters
|
705
|
+
form_params = opts[:form_params] || {}
|
706
|
+
|
707
|
+
# http body (model)
|
708
|
+
post_body = opts[:debug_body]
|
709
|
+
|
710
|
+
# return_type
|
711
|
+
return_type = opts[:debug_return_type] || 'FileManagerPage'
|
712
|
+
|
713
|
+
# auth_names
|
714
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
715
|
+
|
716
|
+
new_options = opts.merge(
|
717
|
+
:operation => :"StorefrontApi.create_admin_panel_fs_file_upload",
|
718
|
+
:header_params => header_params,
|
719
|
+
:query_params => query_params,
|
720
|
+
:form_params => form_params,
|
721
|
+
:body => post_body,
|
722
|
+
:auth_names => auth_names,
|
723
|
+
:return_type => return_type
|
724
|
+
)
|
725
|
+
|
726
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
727
|
+
if @api_client.config.debugging
|
728
|
+
@api_client.config.logger.debug "API called: StorefrontApi#create_admin_panel_fs_file_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
729
|
+
end
|
730
|
+
return data, status_code, headers
|
731
|
+
end
|
732
|
+
|
600
733
|
# Create email campaign
|
601
734
|
# @param domain [String]
|
602
735
|
# @param [Hash] opts the optional parameters
|
@@ -793,6 +926,74 @@ module UltracartClient
|
|
793
926
|
return data, status_code, headers
|
794
927
|
end
|
795
928
|
|
929
|
+
# Delete file manager directory for admin panel
|
930
|
+
# @param id [Integer]
|
931
|
+
# @param [Hash] opts the optional parameters
|
932
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
933
|
+
# @option opts [Integer] :storefront_fs_file_oid
|
934
|
+
# @return [FileManagerPage]
|
935
|
+
def delete_admin_panel_fs_file(id, opts = {})
|
936
|
+
data, _status_code, _headers = delete_admin_panel_fs_file_with_http_info(id, opts)
|
937
|
+
data
|
938
|
+
end
|
939
|
+
|
940
|
+
# Delete file manager directory for admin panel
|
941
|
+
# @param id [Integer]
|
942
|
+
# @param [Hash] opts the optional parameters
|
943
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
944
|
+
# @option opts [Integer] :storefront_fs_file_oid
|
945
|
+
# @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
|
946
|
+
def delete_admin_panel_fs_file_with_http_info(id, opts = {})
|
947
|
+
if @api_client.config.debugging
|
948
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.delete_admin_panel_fs_file ...'
|
949
|
+
end
|
950
|
+
# verify the required parameter 'id' is set
|
951
|
+
if @api_client.config.client_side_validation && id.nil?
|
952
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.delete_admin_panel_fs_file"
|
953
|
+
end
|
954
|
+
# resource path
|
955
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/file'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
956
|
+
|
957
|
+
# query parameters
|
958
|
+
query_params = opts[:query_params] || {}
|
959
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
960
|
+
query_params[:'storefront_fs_file_oid'] = opts[:'storefront_fs_file_oid'] if !opts[:'storefront_fs_file_oid'].nil?
|
961
|
+
|
962
|
+
# header parameters
|
963
|
+
header_params = opts[:header_params] || {}
|
964
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
965
|
+
# HTTP header 'Accept' (if needed)
|
966
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
967
|
+
|
968
|
+
# form parameters
|
969
|
+
form_params = opts[:form_params] || {}
|
970
|
+
|
971
|
+
# http body (model)
|
972
|
+
post_body = opts[:debug_body]
|
973
|
+
|
974
|
+
# return_type
|
975
|
+
return_type = opts[:debug_return_type] || 'FileManagerPage'
|
976
|
+
|
977
|
+
# auth_names
|
978
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
979
|
+
|
980
|
+
new_options = opts.merge(
|
981
|
+
:operation => :"StorefrontApi.delete_admin_panel_fs_file",
|
982
|
+
:header_params => header_params,
|
983
|
+
:query_params => query_params,
|
984
|
+
:form_params => form_params,
|
985
|
+
:body => post_body,
|
986
|
+
:auth_names => auth_names,
|
987
|
+
:return_type => return_type
|
988
|
+
)
|
989
|
+
|
990
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
991
|
+
if @api_client.config.debugging
|
992
|
+
@api_client.config.logger.debug "API called: StorefrontApi#delete_admin_panel_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
993
|
+
end
|
994
|
+
return data, status_code, headers
|
995
|
+
end
|
996
|
+
|
796
997
|
# Delete email campaignFolder
|
797
998
|
# @param storefront_oid [Integer]
|
798
999
|
# @param email_campaign_folder_uuid [String]
|
@@ -1939,6 +2140,77 @@ module UltracartClient
|
|
1939
2140
|
return data, status_code, headers
|
1940
2141
|
end
|
1941
2142
|
|
2143
|
+
# Get file manager directory for admin panel
|
2144
|
+
# @param id [Integer]
|
2145
|
+
# @param [Hash] opts the optional parameters
|
2146
|
+
# @option opts [String] :path
|
2147
|
+
# @option opts [Integer] :storefront_fs_directory_oid
|
2148
|
+
# @option opts [Integer] :storefront_theme_oid
|
2149
|
+
# @return [FileManagerPage]
|
2150
|
+
def get_admin_panel_fs_directory(id, opts = {})
|
2151
|
+
data, _status_code, _headers = get_admin_panel_fs_directory_with_http_info(id, opts)
|
2152
|
+
data
|
2153
|
+
end
|
2154
|
+
|
2155
|
+
# Get file manager directory for admin panel
|
2156
|
+
# @param id [Integer]
|
2157
|
+
# @param [Hash] opts the optional parameters
|
2158
|
+
# @option opts [String] :path
|
2159
|
+
# @option opts [Integer] :storefront_fs_directory_oid
|
2160
|
+
# @option opts [Integer] :storefront_theme_oid
|
2161
|
+
# @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
|
2162
|
+
def get_admin_panel_fs_directory_with_http_info(id, opts = {})
|
2163
|
+
if @api_client.config.debugging
|
2164
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_admin_panel_fs_directory ...'
|
2165
|
+
end
|
2166
|
+
# verify the required parameter 'id' is set
|
2167
|
+
if @api_client.config.client_side_validation && id.nil?
|
2168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_admin_panel_fs_directory"
|
2169
|
+
end
|
2170
|
+
# resource path
|
2171
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2172
|
+
|
2173
|
+
# query parameters
|
2174
|
+
query_params = opts[:query_params] || {}
|
2175
|
+
query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
|
2176
|
+
query_params[:'storefront_fs_directory_oid'] = opts[:'storefront_fs_directory_oid'] if !opts[:'storefront_fs_directory_oid'].nil?
|
2177
|
+
query_params[:'storefront_theme_oid'] = opts[:'storefront_theme_oid'] if !opts[:'storefront_theme_oid'].nil?
|
2178
|
+
|
2179
|
+
# header parameters
|
2180
|
+
header_params = opts[:header_params] || {}
|
2181
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2182
|
+
# HTTP header 'Accept' (if needed)
|
2183
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2184
|
+
|
2185
|
+
# form parameters
|
2186
|
+
form_params = opts[:form_params] || {}
|
2187
|
+
|
2188
|
+
# http body (model)
|
2189
|
+
post_body = opts[:debug_body]
|
2190
|
+
|
2191
|
+
# return_type
|
2192
|
+
return_type = opts[:debug_return_type] || 'FileManagerPage'
|
2193
|
+
|
2194
|
+
# auth_names
|
2195
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
2196
|
+
|
2197
|
+
new_options = opts.merge(
|
2198
|
+
:operation => :"StorefrontApi.get_admin_panel_fs_directory",
|
2199
|
+
:header_params => header_params,
|
2200
|
+
:query_params => query_params,
|
2201
|
+
:form_params => form_params,
|
2202
|
+
:body => post_body,
|
2203
|
+
:auth_names => auth_names,
|
2204
|
+
:return_type => return_type
|
2205
|
+
)
|
2206
|
+
|
2207
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2208
|
+
if @api_client.config.debugging
|
2209
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_admin_panel_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2210
|
+
end
|
2211
|
+
return data, status_code, headers
|
2212
|
+
end
|
2213
|
+
|
1942
2214
|
# Get countries
|
1943
2215
|
# Obtain a list of all the countries
|
1944
2216
|
# @param storefront_oid [Integer]
|
@@ -0,0 +1,255 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class FileManagerPage
|
18
|
+
attr_accessor :current_storefront_fs_directory_oid
|
19
|
+
|
20
|
+
attr_accessor :hostname
|
21
|
+
|
22
|
+
attr_accessor :parent_storefront_fs_directory_oid
|
23
|
+
|
24
|
+
attr_accessor :path
|
25
|
+
|
26
|
+
attr_accessor :storefront_oid
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'current_storefront_fs_directory_oid' => :'current_storefront_fs_directory_oid',
|
32
|
+
:'hostname' => :'hostname',
|
33
|
+
:'parent_storefront_fs_directory_oid' => :'parent_storefront_fs_directory_oid',
|
34
|
+
:'path' => :'path',
|
35
|
+
:'storefront_oid' => :'storefront_oid'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Returns all the JSON keys this model knows about
|
40
|
+
def self.acceptable_attributes
|
41
|
+
attribute_map.values
|
42
|
+
end
|
43
|
+
|
44
|
+
# Attribute type mapping.
|
45
|
+
def self.openapi_types
|
46
|
+
{
|
47
|
+
:'current_storefront_fs_directory_oid' => :'Integer',
|
48
|
+
:'hostname' => :'String',
|
49
|
+
:'parent_storefront_fs_directory_oid' => :'Integer',
|
50
|
+
:'path' => :'String',
|
51
|
+
:'storefront_oid' => :'Integer'
|
52
|
+
}
|
53
|
+
end
|
54
|
+
|
55
|
+
# List of attributes with nullable: true
|
56
|
+
def self.openapi_nullable
|
57
|
+
Set.new([
|
58
|
+
])
|
59
|
+
end
|
60
|
+
|
61
|
+
# Initializes the object
|
62
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
63
|
+
def initialize(attributes = {})
|
64
|
+
if (!attributes.is_a?(Hash))
|
65
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::FileManagerPage` initialize method"
|
66
|
+
end
|
67
|
+
|
68
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
69
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
70
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
71
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::FileManagerPage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
72
|
+
end
|
73
|
+
h[k.to_sym] = v
|
74
|
+
}
|
75
|
+
|
76
|
+
if attributes.key?(:'current_storefront_fs_directory_oid')
|
77
|
+
self.current_storefront_fs_directory_oid = attributes[:'current_storefront_fs_directory_oid']
|
78
|
+
end
|
79
|
+
|
80
|
+
if attributes.key?(:'hostname')
|
81
|
+
self.hostname = attributes[:'hostname']
|
82
|
+
end
|
83
|
+
|
84
|
+
if attributes.key?(:'parent_storefront_fs_directory_oid')
|
85
|
+
self.parent_storefront_fs_directory_oid = attributes[:'parent_storefront_fs_directory_oid']
|
86
|
+
end
|
87
|
+
|
88
|
+
if attributes.key?(:'path')
|
89
|
+
self.path = attributes[:'path']
|
90
|
+
end
|
91
|
+
|
92
|
+
if attributes.key?(:'storefront_oid')
|
93
|
+
self.storefront_oid = attributes[:'storefront_oid']
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
98
|
+
# @return Array for valid properties with the reasons
|
99
|
+
def list_invalid_properties
|
100
|
+
invalid_properties = Array.new
|
101
|
+
invalid_properties
|
102
|
+
end
|
103
|
+
|
104
|
+
# Check to see if the all the properties in the model are valid
|
105
|
+
# @return true if the model is valid
|
106
|
+
def valid?
|
107
|
+
true
|
108
|
+
end
|
109
|
+
|
110
|
+
# Checks equality by comparing each attribute.
|
111
|
+
# @param [Object] Object to be compared
|
112
|
+
def ==(o)
|
113
|
+
return true if self.equal?(o)
|
114
|
+
self.class == o.class &&
|
115
|
+
current_storefront_fs_directory_oid == o.current_storefront_fs_directory_oid &&
|
116
|
+
hostname == o.hostname &&
|
117
|
+
parent_storefront_fs_directory_oid == o.parent_storefront_fs_directory_oid &&
|
118
|
+
path == o.path &&
|
119
|
+
storefront_oid == o.storefront_oid
|
120
|
+
end
|
121
|
+
|
122
|
+
# @see the `==` method
|
123
|
+
# @param [Object] Object to be compared
|
124
|
+
def eql?(o)
|
125
|
+
self == o
|
126
|
+
end
|
127
|
+
|
128
|
+
# Calculates hash code according to all attributes.
|
129
|
+
# @return [Integer] Hash code
|
130
|
+
def hash
|
131
|
+
[current_storefront_fs_directory_oid, hostname, parent_storefront_fs_directory_oid, path, storefront_oid].hash
|
132
|
+
end
|
133
|
+
|
134
|
+
# Builds the object from hash
|
135
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
136
|
+
# @return [Object] Returns the model itself
|
137
|
+
def self.build_from_hash(attributes)
|
138
|
+
new.build_from_hash(attributes)
|
139
|
+
end
|
140
|
+
|
141
|
+
# Builds the object from hash
|
142
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
143
|
+
# @return [Object] Returns the model itself
|
144
|
+
def build_from_hash(attributes)
|
145
|
+
return nil unless attributes.is_a?(Hash)
|
146
|
+
attributes = attributes.transform_keys(&:to_sym)
|
147
|
+
self.class.openapi_types.each_pair do |key, type|
|
148
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
149
|
+
self.send("#{key}=", nil)
|
150
|
+
elsif type =~ /\AArray<(.*)>/i
|
151
|
+
# check to ensure the input is an array given that the attribute
|
152
|
+
# is documented as an array but the input is not
|
153
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
154
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
155
|
+
end
|
156
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
157
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
self
|
162
|
+
end
|
163
|
+
|
164
|
+
# Deserializes the data based on type
|
165
|
+
# @param string type Data type
|
166
|
+
# @param string value Value to be deserialized
|
167
|
+
# @return [Object] Deserialized data
|
168
|
+
def _deserialize(type, value)
|
169
|
+
case type.to_sym
|
170
|
+
when :Time
|
171
|
+
Time.parse(value)
|
172
|
+
when :Date
|
173
|
+
Date.parse(value)
|
174
|
+
when :String
|
175
|
+
value.to_s
|
176
|
+
when :Integer
|
177
|
+
value.to_i
|
178
|
+
when :Float
|
179
|
+
value.to_f
|
180
|
+
when :Boolean
|
181
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
182
|
+
true
|
183
|
+
else
|
184
|
+
false
|
185
|
+
end
|
186
|
+
when :Object
|
187
|
+
# generic object (usually a Hash), return directly
|
188
|
+
value
|
189
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
190
|
+
inner_type = Regexp.last_match[:inner_type]
|
191
|
+
value.map { |v| _deserialize(inner_type, v) }
|
192
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
193
|
+
k_type = Regexp.last_match[:k_type]
|
194
|
+
v_type = Regexp.last_match[:v_type]
|
195
|
+
{}.tap do |hash|
|
196
|
+
value.each do |k, v|
|
197
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
198
|
+
end
|
199
|
+
end
|
200
|
+
else # model
|
201
|
+
# models (e.g. Pet) or oneOf
|
202
|
+
klass = UltracartClient.const_get(type)
|
203
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
# Returns the string representation of the object
|
208
|
+
# @return [String] String presentation of the object
|
209
|
+
def to_s
|
210
|
+
to_hash.to_s
|
211
|
+
end
|
212
|
+
|
213
|
+
# to_body is an alias to to_hash (backward compatibility)
|
214
|
+
# @return [Hash] Returns the object in the form of hash
|
215
|
+
def to_body
|
216
|
+
to_hash
|
217
|
+
end
|
218
|
+
|
219
|
+
# Returns the object in the form of hash
|
220
|
+
# @return [Hash] Returns the object in the form of hash
|
221
|
+
def to_hash
|
222
|
+
hash = {}
|
223
|
+
self.class.attribute_map.each_pair do |attr, param|
|
224
|
+
value = self.send(attr)
|
225
|
+
if value.nil?
|
226
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
227
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
228
|
+
end
|
229
|
+
|
230
|
+
hash[param] = _to_hash(value)
|
231
|
+
end
|
232
|
+
hash
|
233
|
+
end
|
234
|
+
|
235
|
+
# Outputs non-array value in the form of hash
|
236
|
+
# For object, use to_hash. Otherwise, just return the value
|
237
|
+
# @param [Object] value Any valid value
|
238
|
+
# @return [Hash] Returns the value in the form of hash
|
239
|
+
def _to_hash(value)
|
240
|
+
if value.is_a?(Array)
|
241
|
+
value.compact.map { |v| _to_hash(v) }
|
242
|
+
elsif value.is_a?(Hash)
|
243
|
+
{}.tap do |hash|
|
244
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
245
|
+
end
|
246
|
+
elsif value.respond_to? :to_hash
|
247
|
+
value.to_hash
|
248
|
+
else
|
249
|
+
value
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
end
|
254
|
+
|
255
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -379,6 +379,7 @@ require 'ultracart_api/models/experiment_response'
|
|
379
379
|
require 'ultracart_api/models/experiment_variation'
|
380
380
|
require 'ultracart_api/models/experiment_variation_stat'
|
381
381
|
require 'ultracart_api/models/experiments_response'
|
382
|
+
require 'ultracart_api/models/file_manager_page'
|
382
383
|
require 'ultracart_api/models/fulfillment_inventory'
|
383
384
|
require 'ultracart_api/models/fulfillment_shipment'
|
384
385
|
require 'ultracart_api/models/geo_point'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.67.rc
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-09-
|
11
|
+
date: 2022-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -431,6 +431,7 @@ files:
|
|
431
431
|
- docs/ExperimentVariation.md
|
432
432
|
- docs/ExperimentVariationStat.md
|
433
433
|
- docs/ExperimentsResponse.md
|
434
|
+
- docs/FileManagerPage.md
|
434
435
|
- docs/FulfillmentApi.md
|
435
436
|
- docs/FulfillmentInventory.md
|
436
437
|
- docs/FulfillmentShipment.md
|
@@ -1139,6 +1140,7 @@ files:
|
|
1139
1140
|
- lib/ultracart_api/models/experiment_variation.rb
|
1140
1141
|
- lib/ultracart_api/models/experiment_variation_stat.rb
|
1141
1142
|
- lib/ultracart_api/models/experiments_response.rb
|
1143
|
+
- lib/ultracart_api/models/file_manager_page.rb
|
1142
1144
|
- lib/ultracart_api/models/fulfillment_inventory.rb
|
1143
1145
|
- lib/ultracart_api/models/fulfillment_shipment.rb
|
1144
1146
|
- lib/ultracart_api/models/geo_point.rb
|