ultracart_api 3.10.48 → 3.10.50
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 +12 -0
- data/docs/ItemApi.md +64 -16
- data/docs/StorefrontApi.md +220 -0
- data/lib/ultracart_api/api/item_api.rb +67 -18
- data/lib/ultracart_api/api/storefront_api.rb +236 -0
- data/lib/ultracart_api/models/file_manager_page.rb +220 -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: 10815d35709a8708da23438ef8081d915d00c04675e1644b35024b9ea7771a99
|
4
|
+
data.tar.gz: c1ea09636798ab9cbc01c33d15239cd9872819d951a87181c334f075d2bdae27
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0d5ae301dbb575a8d48323c91d8da8bed94897ac80bd6abbe5df6beaea311c755453c484c3bd9312869a9620e11422fd015dec1543ea017f1dcc9ea7bd0a3313
|
7
|
+
data.tar.gz: 15dbda93dbf7698f80254ac5186e3de98ed459411bc5c8fc81764823ba1975c95beb0461349498dcfd03abf4147f8eb1886bbd42dda018adc7415bdb2febae1c
|
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.
|
10
|
+
- Package version: 3.10.50
|
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.
|
27
|
+
gem install ./ultracart_api-3.10.50.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.50.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.
|
35
|
+
gem 'ultracart_api', '~> 3.10.50'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -201,6 +201,7 @@ Class | Method | HTTP request | Description
|
|
201
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
|
202
202
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
203
203
|
*UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
204
|
+
*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
|
204
205
|
*UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
205
206
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
206
207
|
*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
|
@@ -244,9 +245,12 @@ Class | Method | HTTP request | Description
|
|
244
245
|
*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
|
245
246
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
246
247
|
*UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
248
|
+
*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
|
249
|
+
*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
|
247
250
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
248
251
|
*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
|
249
252
|
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
253
|
+
*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
|
250
254
|
*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
|
251
255
|
*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
|
252
256
|
*UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
@@ -264,6 +268,7 @@ Class | Method | HTTP request | Description
|
|
264
268
|
*UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
265
269
|
*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
|
266
270
|
*UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
271
|
+
*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
|
267
272
|
*UltracartClient::StorefrontApi* | [**get_countries**](docs/StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
|
268
273
|
*UltracartClient::StorefrontApi* | [**get_editor_token**](docs/StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
|
269
274
|
*UltracartClient::StorefrontApi* | [**get_email_base_templates**](docs/StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
|
@@ -815,6 +820,7 @@ Class | Method | HTTP request | Description
|
|
815
820
|
- [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
|
816
821
|
- [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
|
817
822
|
- [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
|
823
|
+
- [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
|
818
824
|
- [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
|
819
825
|
- [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
|
820
826
|
- [UltracartClient::GeoPoint](docs/GeoPoint.md)
|
@@ -1196,6 +1202,8 @@ Not every change is committed to every SDK.
|
|
1196
1202
|
|
1197
1203
|
| Version | Date | Comments |
|
1198
1204
|
| --: | :-: | --- |
|
1205
|
+
| 3.10.50 | 09/27/2022 | added digital library call for unassociated content |
|
1206
|
+
| 3.10.49 | 09/22/2022 | digital item mgmt testing |
|
1199
1207
|
| 3.10.48 | 09/22/2022 | testing digital file mgmt calls |
|
1200
1208
|
| 3.10.47 | 09/19/2022 | conversations pagination |
|
1201
1209
|
| 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::FileManagerPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**current_storefront_fs_directory_oid** | **Integer** | | [optional]
|
7
|
+
**hostname** | **String** | | [optional]
|
8
|
+
**parent_storefront_fs_directory_oid** | **Integer** | | [optional]
|
9
|
+
**path** | **String** | | [optional]
|
10
|
+
**storefront_oid** | **Integer** | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/ItemApi.md
CHANGED
@@ -12,6 +12,7 @@ Method | HTTP request | Description
|
|
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
|
@@ -119,7 +120,7 @@ nil (empty response body)
|
|
119
120
|
|
120
121
|
|
121
122
|
# **get_digital_item**
|
122
|
-
> ItemDigitalItemResponse get_digital_item(digital_item_oid
|
123
|
+
> ItemDigitalItemResponse get_digital_item(digital_item_oid)
|
123
124
|
|
124
125
|
Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
125
126
|
|
@@ -137,18 +138,10 @@ api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, fal
|
|
137
138
|
|
138
139
|
digital_item_oid = 56 # Integer | The digital item oid to retrieve.
|
139
140
|
|
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
141
|
|
149
142
|
begin
|
150
143
|
#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
|
144
|
+
result = api_instance.get_digital_item(digital_item_oid)
|
152
145
|
p result
|
153
146
|
rescue UltracartClient::ApiError => e
|
154
147
|
puts "Exception when calling ItemApi->get_digital_item: #{e}"
|
@@ -160,12 +153,6 @@ end
|
|
160
153
|
Name | Type | Description | Notes
|
161
154
|
------------- | ------------- | ------------- | -------------
|
162
155
|
**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
156
|
|
170
157
|
### Return type
|
171
158
|
|
@@ -471,6 +458,67 @@ Name | Type | Description | Notes
|
|
471
458
|
|
472
459
|
|
473
460
|
|
461
|
+
# **get_unassociated_digital_items**
|
462
|
+
> ItemDigitalItemsResponse get_unassociated_digital_items(opts)
|
463
|
+
|
464
|
+
Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
465
|
+
|
466
|
+
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.
|
467
|
+
|
468
|
+
### Example
|
469
|
+
```ruby
|
470
|
+
# load the gem
|
471
|
+
require 'ultracart_api'
|
472
|
+
|
473
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
474
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
475
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
476
|
+
|
477
|
+
|
478
|
+
opts = {
|
479
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
480
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
481
|
+
_since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
|
482
|
+
_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.
|
483
|
+
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
484
|
+
_placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
485
|
+
}
|
486
|
+
|
487
|
+
begin
|
488
|
+
#Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
489
|
+
result = api_instance.get_unassociated_digital_items(opts)
|
490
|
+
p result
|
491
|
+
rescue UltracartClient::ApiError => e
|
492
|
+
puts "Exception when calling ItemApi->get_unassociated_digital_items: #{e}"
|
493
|
+
end
|
494
|
+
```
|
495
|
+
|
496
|
+
### Parameters
|
497
|
+
|
498
|
+
Name | Type | Description | Notes
|
499
|
+
------------- | ------------- | ------------- | -------------
|
500
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
|
501
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
502
|
+
**_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
|
503
|
+
**_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
504
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
505
|
+
**_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
|
506
|
+
|
507
|
+
### Return type
|
508
|
+
|
509
|
+
[**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
|
510
|
+
|
511
|
+
### Authorization
|
512
|
+
|
513
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
514
|
+
|
515
|
+
### HTTP request headers
|
516
|
+
|
517
|
+
- **Content-Type**: application/json
|
518
|
+
- **Accept**: application/json
|
519
|
+
|
520
|
+
|
521
|
+
|
474
522
|
# **insert_digital_item**
|
475
523
|
> ItemDigitalItemResponse insert_digital_item(digital_item)
|
476
524
|
|
data/docs/StorefrontApi.md
CHANGED
@@ -12,9 +12,12 @@ Method | HTTP request | Description
|
|
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 @@ Method | HTTP request | Description
|
|
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
|
@@ -588,6 +592,112 @@ Name | Type | Description | Notes
|
|
588
592
|
|
589
593
|
|
590
594
|
|
595
|
+
# **create_admin_panel_fs_directory**
|
596
|
+
> FileManagerPage create_admin_panel_fs_directory(id, opts)
|
597
|
+
|
598
|
+
Create file manager directory for admin panel
|
599
|
+
|
600
|
+
### Example
|
601
|
+
```ruby
|
602
|
+
# load the gem
|
603
|
+
require 'ultracart_api'
|
604
|
+
|
605
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
606
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
607
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
608
|
+
|
609
|
+
|
610
|
+
id = 56 # Integer |
|
611
|
+
|
612
|
+
opts = {
|
613
|
+
name: 'name_example', # String |
|
614
|
+
parent_storefront_fs_directory_oid: 56 # Integer |
|
615
|
+
}
|
616
|
+
|
617
|
+
begin
|
618
|
+
#Create file manager directory for admin panel
|
619
|
+
result = api_instance.create_admin_panel_fs_directory(id, opts)
|
620
|
+
p result
|
621
|
+
rescue UltracartClient::ApiError => e
|
622
|
+
puts "Exception when calling StorefrontApi->create_admin_panel_fs_directory: #{e}"
|
623
|
+
end
|
624
|
+
```
|
625
|
+
|
626
|
+
### Parameters
|
627
|
+
|
628
|
+
Name | Type | Description | Notes
|
629
|
+
------------- | ------------- | ------------- | -------------
|
630
|
+
**id** | **Integer**| |
|
631
|
+
**name** | **String**| | [optional]
|
632
|
+
**parent_storefront_fs_directory_oid** | **Integer**| | [optional]
|
633
|
+
|
634
|
+
### Return type
|
635
|
+
|
636
|
+
[**FileManagerPage**](FileManagerPage.md)
|
637
|
+
|
638
|
+
### Authorization
|
639
|
+
|
640
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
641
|
+
|
642
|
+
### HTTP request headers
|
643
|
+
|
644
|
+
- **Content-Type**: application/json
|
645
|
+
- **Accept**: application/json
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
# **create_admin_panel_fs_file_upload**
|
650
|
+
> FileManagerPage create_admin_panel_fs_file_upload(id, opts)
|
651
|
+
|
652
|
+
Upload file manager file for admin panel
|
653
|
+
|
654
|
+
### Example
|
655
|
+
```ruby
|
656
|
+
# load the gem
|
657
|
+
require 'ultracart_api'
|
658
|
+
|
659
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
660
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
661
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
662
|
+
|
663
|
+
|
664
|
+
id = 56 # Integer |
|
665
|
+
|
666
|
+
opts = {
|
667
|
+
parent_storefront_fs_directory_oid: 56 # Integer |
|
668
|
+
}
|
669
|
+
|
670
|
+
begin
|
671
|
+
#Upload file manager file for admin panel
|
672
|
+
result = api_instance.create_admin_panel_fs_file_upload(id, opts)
|
673
|
+
p result
|
674
|
+
rescue UltracartClient::ApiError => e
|
675
|
+
puts "Exception when calling StorefrontApi->create_admin_panel_fs_file_upload: #{e}"
|
676
|
+
end
|
677
|
+
```
|
678
|
+
|
679
|
+
### Parameters
|
680
|
+
|
681
|
+
Name | Type | Description | Notes
|
682
|
+
------------- | ------------- | ------------- | -------------
|
683
|
+
**id** | **Integer**| |
|
684
|
+
**parent_storefront_fs_directory_oid** | **Integer**| | [optional]
|
685
|
+
|
686
|
+
### Return type
|
687
|
+
|
688
|
+
[**FileManagerPage**](FileManagerPage.md)
|
689
|
+
|
690
|
+
### Authorization
|
691
|
+
|
692
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
693
|
+
|
694
|
+
### HTTP request headers
|
695
|
+
|
696
|
+
- **Content-Type**: multipart/form-data
|
697
|
+
- **Accept**: application/json
|
698
|
+
|
699
|
+
|
700
|
+
|
591
701
|
# **create_email_sending_domain**
|
592
702
|
> EmailSendingDomainResponse create_email_sending_domain(domain)
|
593
703
|
|
@@ -732,6 +842,60 @@ Name | Type | Description | Notes
|
|
732
842
|
|
733
843
|
|
734
844
|
|
845
|
+
# **delete_admin_panel_fs_file**
|
846
|
+
> FileManagerPage delete_admin_panel_fs_file(id, opts)
|
847
|
+
|
848
|
+
Delete file manager directory for admin panel
|
849
|
+
|
850
|
+
### Example
|
851
|
+
```ruby
|
852
|
+
# load the gem
|
853
|
+
require 'ultracart_api'
|
854
|
+
|
855
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
856
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
857
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
858
|
+
|
859
|
+
|
860
|
+
id = 56 # Integer |
|
861
|
+
|
862
|
+
opts = {
|
863
|
+
parent_storefront_fs_directory_oid: 56, # Integer |
|
864
|
+
storefront_fs_file_oid: 56 # Integer |
|
865
|
+
}
|
866
|
+
|
867
|
+
begin
|
868
|
+
#Delete file manager directory for admin panel
|
869
|
+
result = api_instance.delete_admin_panel_fs_file(id, opts)
|
870
|
+
p result
|
871
|
+
rescue UltracartClient::ApiError => e
|
872
|
+
puts "Exception when calling StorefrontApi->delete_admin_panel_fs_file: #{e}"
|
873
|
+
end
|
874
|
+
```
|
875
|
+
|
876
|
+
### Parameters
|
877
|
+
|
878
|
+
Name | Type | Description | Notes
|
879
|
+
------------- | ------------- | ------------- | -------------
|
880
|
+
**id** | **Integer**| |
|
881
|
+
**parent_storefront_fs_directory_oid** | **Integer**| | [optional]
|
882
|
+
**storefront_fs_file_oid** | **Integer**| | [optional]
|
883
|
+
|
884
|
+
### Return type
|
885
|
+
|
886
|
+
[**FileManagerPage**](FileManagerPage.md)
|
887
|
+
|
888
|
+
### Authorization
|
889
|
+
|
890
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
891
|
+
|
892
|
+
### HTTP request headers
|
893
|
+
|
894
|
+
- **Content-Type**: application/json
|
895
|
+
- **Accept**: application/json
|
896
|
+
|
897
|
+
|
898
|
+
|
735
899
|
# **delete_email_campaign_folder**
|
736
900
|
> BaseResponse delete_email_campaign_folder(storefront_oid, email_campaign_folder_uuid)
|
737
901
|
|
@@ -1584,6 +1748,62 @@ Name | Type | Description | Notes
|
|
1584
1748
|
|
1585
1749
|
|
1586
1750
|
|
1751
|
+
# **get_admin_panel_fs_directory**
|
1752
|
+
> FileManagerPage get_admin_panel_fs_directory(id, opts)
|
1753
|
+
|
1754
|
+
Get file manager directory for admin panel
|
1755
|
+
|
1756
|
+
### Example
|
1757
|
+
```ruby
|
1758
|
+
# load the gem
|
1759
|
+
require 'ultracart_api'
|
1760
|
+
|
1761
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1762
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1763
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
1764
|
+
|
1765
|
+
|
1766
|
+
id = 56 # Integer |
|
1767
|
+
|
1768
|
+
opts = {
|
1769
|
+
path: 'path_example', # String |
|
1770
|
+
storefront_fs_directory_oid: 56, # Integer |
|
1771
|
+
storefront_theme_oid: 56 # Integer |
|
1772
|
+
}
|
1773
|
+
|
1774
|
+
begin
|
1775
|
+
#Get file manager directory for admin panel
|
1776
|
+
result = api_instance.get_admin_panel_fs_directory(id, opts)
|
1777
|
+
p result
|
1778
|
+
rescue UltracartClient::ApiError => e
|
1779
|
+
puts "Exception when calling StorefrontApi->get_admin_panel_fs_directory: #{e}"
|
1780
|
+
end
|
1781
|
+
```
|
1782
|
+
|
1783
|
+
### Parameters
|
1784
|
+
|
1785
|
+
Name | Type | Description | Notes
|
1786
|
+
------------- | ------------- | ------------- | -------------
|
1787
|
+
**id** | **Integer**| |
|
1788
|
+
**path** | **String**| | [optional]
|
1789
|
+
**storefront_fs_directory_oid** | **Integer**| | [optional]
|
1790
|
+
**storefront_theme_oid** | **Integer**| | [optional]
|
1791
|
+
|
1792
|
+
### Return type
|
1793
|
+
|
1794
|
+
[**FileManagerPage**](FileManagerPage.md)
|
1795
|
+
|
1796
|
+
### Authorization
|
1797
|
+
|
1798
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1799
|
+
|
1800
|
+
### HTTP request headers
|
1801
|
+
|
1802
|
+
- **Content-Type**: application/json
|
1803
|
+
- **Accept**: application/json
|
1804
|
+
|
1805
|
+
|
1806
|
+
|
1587
1807
|
# **get_countries**
|
1588
1808
|
> CountriesResponse get_countries(storefront_oid)
|
1589
1809
|
|
@@ -144,12 +144,6 @@ module UltracartClient
|
|
144
144
|
# 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.
|
145
145
|
# @param digital_item_oid The digital item oid to retrieve.
|
146
146
|
# @param [Hash] opts the optional parameters
|
147
|
-
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
148
|
-
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
149
|
-
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
150
|
-
# @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.
|
151
|
-
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
152
|
-
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
153
147
|
# @return [ItemDigitalItemResponse]
|
154
148
|
def get_digital_item(digital_item_oid, opts = {})
|
155
149
|
data, _status_code, _headers = get_digital_item_with_http_info(digital_item_oid, opts)
|
@@ -160,12 +154,6 @@ module UltracartClient
|
|
160
154
|
# 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.
|
161
155
|
# @param digital_item_oid The digital item oid to retrieve.
|
162
156
|
# @param [Hash] opts the optional parameters
|
163
|
-
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
164
|
-
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
|
165
|
-
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
166
|
-
# @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.
|
167
|
-
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
168
|
-
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
169
157
|
# @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
|
170
158
|
def get_digital_item_with_http_info(digital_item_oid, opts = {})
|
171
159
|
if @api_client.config.debugging
|
@@ -180,12 +168,6 @@ module UltracartClient
|
|
180
168
|
|
181
169
|
# query parameters
|
182
170
|
query_params = {}
|
183
|
-
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
184
|
-
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
185
|
-
query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
|
186
|
-
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|
187
|
-
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
188
|
-
query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
|
189
171
|
|
190
172
|
# header parameters
|
191
173
|
header_params = {}
|
@@ -527,6 +509,73 @@ module UltracartClient
|
|
527
509
|
end
|
528
510
|
return data, status_code, headers
|
529
511
|
end
|
512
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
513
|
+
# 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.
|
514
|
+
# @param [Hash] opts the optional parameters
|
515
|
+
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
|
516
|
+
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
517
|
+
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
518
|
+
# @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.
|
519
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
520
|
+
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
521
|
+
# @return [ItemDigitalItemsResponse]
|
522
|
+
def get_unassociated_digital_items(opts = {})
|
523
|
+
data, _status_code, _headers = get_unassociated_digital_items_with_http_info(opts)
|
524
|
+
data
|
525
|
+
end
|
526
|
+
|
527
|
+
# Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
528
|
+
# 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.
|
529
|
+
# @param [Hash] opts the optional parameters
|
530
|
+
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
531
|
+
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
|
532
|
+
# @option opts [String] :_since Fetch items that have been created/modified since this date/time.
|
533
|
+
# @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.
|
534
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
535
|
+
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
536
|
+
# @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
|
537
|
+
def get_unassociated_digital_items_with_http_info(opts = {})
|
538
|
+
if @api_client.config.debugging
|
539
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.get_unassociated_digital_items ...'
|
540
|
+
end
|
541
|
+
# resource path
|
542
|
+
local_var_path = '/item/digital_library/unassociated'
|
543
|
+
|
544
|
+
# query parameters
|
545
|
+
query_params = {}
|
546
|
+
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
547
|
+
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
548
|
+
query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
|
549
|
+
query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
|
550
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
551
|
+
query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
|
552
|
+
|
553
|
+
# header parameters
|
554
|
+
header_params = {}
|
555
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
556
|
+
# HTTP header 'Accept' (if needed)
|
557
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
558
|
+
# HTTP header 'Content-Type'
|
559
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
560
|
+
|
561
|
+
# form parameters
|
562
|
+
form_params = {}
|
563
|
+
|
564
|
+
# http body (model)
|
565
|
+
post_body = nil
|
566
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
567
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
568
|
+
:header_params => header_params,
|
569
|
+
:query_params => query_params,
|
570
|
+
:form_params => form_params,
|
571
|
+
:body => post_body,
|
572
|
+
:auth_names => auth_names,
|
573
|
+
:return_type => 'ItemDigitalItemsResponse')
|
574
|
+
if @api_client.config.debugging
|
575
|
+
@api_client.config.logger.debug "API called: ItemApi#get_unassociated_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
576
|
+
end
|
577
|
+
return data, status_code, headers
|
578
|
+
end
|
530
579
|
# Create a file within the digital library
|
531
580
|
# 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.
|
532
581
|
# @param digital_item Digital item to create
|
@@ -510,6 +510,121 @@ module UltracartClient
|
|
510
510
|
end
|
511
511
|
return data, status_code, headers
|
512
512
|
end
|
513
|
+
# Create file manager directory for admin panel
|
514
|
+
# @param id
|
515
|
+
# @param [Hash] opts the optional parameters
|
516
|
+
# @option opts [String] :name
|
517
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
518
|
+
# @return [FileManagerPage]
|
519
|
+
def create_admin_panel_fs_directory(id, opts = {})
|
520
|
+
data, _status_code, _headers = create_admin_panel_fs_directory_with_http_info(id, opts)
|
521
|
+
data
|
522
|
+
end
|
523
|
+
|
524
|
+
# Create file manager directory for admin panel
|
525
|
+
# @param id
|
526
|
+
# @param [Hash] opts the optional parameters
|
527
|
+
# @option opts [String] :name
|
528
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
529
|
+
# @return [Array<(FileManagerPage, Fixnum, Hash)>] FileManagerPage data, response status code and response headers
|
530
|
+
def create_admin_panel_fs_directory_with_http_info(id, opts = {})
|
531
|
+
if @api_client.config.debugging
|
532
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.create_admin_panel_fs_directory ...'
|
533
|
+
end
|
534
|
+
# verify the required parameter 'id' is set
|
535
|
+
if @api_client.config.client_side_validation && id.nil?
|
536
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_admin_panel_fs_directory"
|
537
|
+
end
|
538
|
+
# resource path
|
539
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/dir'.sub('{' + 'id' + '}', id.to_s)
|
540
|
+
|
541
|
+
# query parameters
|
542
|
+
query_params = {}
|
543
|
+
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
544
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
545
|
+
|
546
|
+
# header parameters
|
547
|
+
header_params = {}
|
548
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
549
|
+
# HTTP header 'Accept' (if needed)
|
550
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
551
|
+
# HTTP header 'Content-Type'
|
552
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
553
|
+
|
554
|
+
# form parameters
|
555
|
+
form_params = {}
|
556
|
+
|
557
|
+
# http body (model)
|
558
|
+
post_body = nil
|
559
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
560
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
561
|
+
:header_params => header_params,
|
562
|
+
:query_params => query_params,
|
563
|
+
:form_params => form_params,
|
564
|
+
:body => post_body,
|
565
|
+
:auth_names => auth_names,
|
566
|
+
:return_type => 'FileManagerPage')
|
567
|
+
if @api_client.config.debugging
|
568
|
+
@api_client.config.logger.debug "API called: StorefrontApi#create_admin_panel_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
569
|
+
end
|
570
|
+
return data, status_code, headers
|
571
|
+
end
|
572
|
+
# Upload file manager file for admin panel
|
573
|
+
# @param id
|
574
|
+
# @param [Hash] opts the optional parameters
|
575
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
576
|
+
# @return [FileManagerPage]
|
577
|
+
def create_admin_panel_fs_file_upload(id, opts = {})
|
578
|
+
data, _status_code, _headers = create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
579
|
+
data
|
580
|
+
end
|
581
|
+
|
582
|
+
# Upload file manager file for admin panel
|
583
|
+
# @param id
|
584
|
+
# @param [Hash] opts the optional parameters
|
585
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
586
|
+
# @return [Array<(FileManagerPage, Fixnum, Hash)>] FileManagerPage data, response status code and response headers
|
587
|
+
def create_admin_panel_fs_file_upload_with_http_info(id, opts = {})
|
588
|
+
if @api_client.config.debugging
|
589
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.create_admin_panel_fs_file_upload ...'
|
590
|
+
end
|
591
|
+
# verify the required parameter 'id' is set
|
592
|
+
if @api_client.config.client_side_validation && id.nil?
|
593
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_admin_panel_fs_file_upload"
|
594
|
+
end
|
595
|
+
# resource path
|
596
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/file'.sub('{' + 'id' + '}', id.to_s)
|
597
|
+
|
598
|
+
# query parameters
|
599
|
+
query_params = {}
|
600
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
601
|
+
|
602
|
+
# header parameters
|
603
|
+
header_params = {}
|
604
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
605
|
+
# HTTP header 'Accept' (if needed)
|
606
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
607
|
+
# HTTP header 'Content-Type'
|
608
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
609
|
+
|
610
|
+
# form parameters
|
611
|
+
form_params = {}
|
612
|
+
|
613
|
+
# http body (model)
|
614
|
+
post_body = nil
|
615
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
616
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
617
|
+
:header_params => header_params,
|
618
|
+
:query_params => query_params,
|
619
|
+
:form_params => form_params,
|
620
|
+
:body => post_body,
|
621
|
+
:auth_names => auth_names,
|
622
|
+
:return_type => 'FileManagerPage')
|
623
|
+
if @api_client.config.debugging
|
624
|
+
@api_client.config.logger.debug "API called: StorefrontApi#create_admin_panel_fs_file_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
625
|
+
end
|
626
|
+
return data, status_code, headers
|
627
|
+
end
|
513
628
|
# Create email campaign
|
514
629
|
# @param domain
|
515
630
|
# @param [Hash] opts the optional parameters
|
@@ -669,6 +784,65 @@ module UltracartClient
|
|
669
784
|
end
|
670
785
|
return data, status_code, headers
|
671
786
|
end
|
787
|
+
# Delete file manager directory for admin panel
|
788
|
+
# @param id
|
789
|
+
# @param [Hash] opts the optional parameters
|
790
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
791
|
+
# @option opts [Integer] :storefront_fs_file_oid
|
792
|
+
# @return [FileManagerPage]
|
793
|
+
def delete_admin_panel_fs_file(id, opts = {})
|
794
|
+
data, _status_code, _headers = delete_admin_panel_fs_file_with_http_info(id, opts)
|
795
|
+
data
|
796
|
+
end
|
797
|
+
|
798
|
+
# Delete file manager directory for admin panel
|
799
|
+
# @param id
|
800
|
+
# @param [Hash] opts the optional parameters
|
801
|
+
# @option opts [Integer] :parent_storefront_fs_directory_oid
|
802
|
+
# @option opts [Integer] :storefront_fs_file_oid
|
803
|
+
# @return [Array<(FileManagerPage, Fixnum, Hash)>] FileManagerPage data, response status code and response headers
|
804
|
+
def delete_admin_panel_fs_file_with_http_info(id, opts = {})
|
805
|
+
if @api_client.config.debugging
|
806
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.delete_admin_panel_fs_file ...'
|
807
|
+
end
|
808
|
+
# verify the required parameter 'id' is set
|
809
|
+
if @api_client.config.client_side_validation && id.nil?
|
810
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.delete_admin_panel_fs_file"
|
811
|
+
end
|
812
|
+
# resource path
|
813
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/file'.sub('{' + 'id' + '}', id.to_s)
|
814
|
+
|
815
|
+
# query parameters
|
816
|
+
query_params = {}
|
817
|
+
query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
|
818
|
+
query_params[:'storefront_fs_file_oid'] = opts[:'storefront_fs_file_oid'] if !opts[:'storefront_fs_file_oid'].nil?
|
819
|
+
|
820
|
+
# header parameters
|
821
|
+
header_params = {}
|
822
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
823
|
+
# HTTP header 'Accept' (if needed)
|
824
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
825
|
+
# HTTP header 'Content-Type'
|
826
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
827
|
+
|
828
|
+
# form parameters
|
829
|
+
form_params = {}
|
830
|
+
|
831
|
+
# http body (model)
|
832
|
+
post_body = nil
|
833
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
834
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
835
|
+
:header_params => header_params,
|
836
|
+
:query_params => query_params,
|
837
|
+
:form_params => form_params,
|
838
|
+
:body => post_body,
|
839
|
+
:auth_names => auth_names,
|
840
|
+
:return_type => 'FileManagerPage')
|
841
|
+
if @api_client.config.debugging
|
842
|
+
@api_client.config.logger.debug "API called: StorefrontApi#delete_admin_panel_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
843
|
+
end
|
844
|
+
return data, status_code, headers
|
845
|
+
end
|
672
846
|
# Delete email campaignFolder
|
673
847
|
# @param storefront_oid
|
674
848
|
# @param email_campaign_folder_uuid
|
@@ -1645,6 +1819,68 @@ module UltracartClient
|
|
1645
1819
|
end
|
1646
1820
|
return data, status_code, headers
|
1647
1821
|
end
|
1822
|
+
# Get file manager directory for admin panel
|
1823
|
+
# @param id
|
1824
|
+
# @param [Hash] opts the optional parameters
|
1825
|
+
# @option opts [String] :path
|
1826
|
+
# @option opts [Integer] :storefront_fs_directory_oid
|
1827
|
+
# @option opts [Integer] :storefront_theme_oid
|
1828
|
+
# @return [FileManagerPage]
|
1829
|
+
def get_admin_panel_fs_directory(id, opts = {})
|
1830
|
+
data, _status_code, _headers = get_admin_panel_fs_directory_with_http_info(id, opts)
|
1831
|
+
data
|
1832
|
+
end
|
1833
|
+
|
1834
|
+
# Get file manager directory for admin panel
|
1835
|
+
# @param id
|
1836
|
+
# @param [Hash] opts the optional parameters
|
1837
|
+
# @option opts [String] :path
|
1838
|
+
# @option opts [Integer] :storefront_fs_directory_oid
|
1839
|
+
# @option opts [Integer] :storefront_theme_oid
|
1840
|
+
# @return [Array<(FileManagerPage, Fixnum, Hash)>] FileManagerPage data, response status code and response headers
|
1841
|
+
def get_admin_panel_fs_directory_with_http_info(id, opts = {})
|
1842
|
+
if @api_client.config.debugging
|
1843
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_admin_panel_fs_directory ...'
|
1844
|
+
end
|
1845
|
+
# verify the required parameter 'id' is set
|
1846
|
+
if @api_client.config.client_side_validation && id.nil?
|
1847
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_admin_panel_fs_directory"
|
1848
|
+
end
|
1849
|
+
# resource path
|
1850
|
+
local_var_path = '/storefront/{id}/adminPanel/fs/dir'.sub('{' + 'id' + '}', id.to_s)
|
1851
|
+
|
1852
|
+
# query parameters
|
1853
|
+
query_params = {}
|
1854
|
+
query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
|
1855
|
+
query_params[:'storefront_fs_directory_oid'] = opts[:'storefront_fs_directory_oid'] if !opts[:'storefront_fs_directory_oid'].nil?
|
1856
|
+
query_params[:'storefront_theme_oid'] = opts[:'storefront_theme_oid'] if !opts[:'storefront_theme_oid'].nil?
|
1857
|
+
|
1858
|
+
# header parameters
|
1859
|
+
header_params = {}
|
1860
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1861
|
+
# HTTP header 'Accept' (if needed)
|
1862
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1863
|
+
# HTTP header 'Content-Type'
|
1864
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1865
|
+
|
1866
|
+
# form parameters
|
1867
|
+
form_params = {}
|
1868
|
+
|
1869
|
+
# http body (model)
|
1870
|
+
post_body = nil
|
1871
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
1872
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1873
|
+
:header_params => header_params,
|
1874
|
+
:query_params => query_params,
|
1875
|
+
:form_params => form_params,
|
1876
|
+
:body => post_body,
|
1877
|
+
:auth_names => auth_names,
|
1878
|
+
:return_type => 'FileManagerPage')
|
1879
|
+
if @api_client.config.debugging
|
1880
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_admin_panel_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1881
|
+
end
|
1882
|
+
return data, status_code, headers
|
1883
|
+
end
|
1648
1884
|
# Get countries
|
1649
1885
|
# Obtain a list of all the countries
|
1650
1886
|
# @param storefront_oid
|
@@ -0,0 +1,220 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class FileManagerPage
|
17
|
+
attr_accessor :current_storefront_fs_directory_oid
|
18
|
+
|
19
|
+
attr_accessor :hostname
|
20
|
+
|
21
|
+
attr_accessor :parent_storefront_fs_directory_oid
|
22
|
+
|
23
|
+
attr_accessor :path
|
24
|
+
|
25
|
+
attr_accessor :storefront_oid
|
26
|
+
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
28
|
+
def self.attribute_map
|
29
|
+
{
|
30
|
+
:'current_storefront_fs_directory_oid' => :'current_storefront_fs_directory_oid',
|
31
|
+
:'hostname' => :'hostname',
|
32
|
+
:'parent_storefront_fs_directory_oid' => :'parent_storefront_fs_directory_oid',
|
33
|
+
:'path' => :'path',
|
34
|
+
:'storefront_oid' => :'storefront_oid'
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
# Attribute type mapping.
|
39
|
+
def self.swagger_types
|
40
|
+
{
|
41
|
+
:'current_storefront_fs_directory_oid' => :'Integer',
|
42
|
+
:'hostname' => :'String',
|
43
|
+
:'parent_storefront_fs_directory_oid' => :'Integer',
|
44
|
+
:'path' => :'String',
|
45
|
+
:'storefront_oid' => :'Integer'
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Initializes the object
|
50
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
51
|
+
def initialize(attributes = {})
|
52
|
+
return unless attributes.is_a?(Hash)
|
53
|
+
|
54
|
+
# convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
56
|
+
|
57
|
+
if attributes.has_key?(:'current_storefront_fs_directory_oid')
|
58
|
+
self.current_storefront_fs_directory_oid = attributes[:'current_storefront_fs_directory_oid']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'hostname')
|
62
|
+
self.hostname = attributes[:'hostname']
|
63
|
+
end
|
64
|
+
|
65
|
+
if attributes.has_key?(:'parent_storefront_fs_directory_oid')
|
66
|
+
self.parent_storefront_fs_directory_oid = attributes[:'parent_storefront_fs_directory_oid']
|
67
|
+
end
|
68
|
+
|
69
|
+
if attributes.has_key?(:'path')
|
70
|
+
self.path = attributes[:'path']
|
71
|
+
end
|
72
|
+
|
73
|
+
if attributes.has_key?(:'storefront_oid')
|
74
|
+
self.storefront_oid = attributes[:'storefront_oid']
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
79
|
+
# @return Array for valid properties with the reasons
|
80
|
+
def list_invalid_properties
|
81
|
+
invalid_properties = Array.new
|
82
|
+
invalid_properties
|
83
|
+
end
|
84
|
+
|
85
|
+
# Check to see if the all the properties in the model are valid
|
86
|
+
# @return true if the model is valid
|
87
|
+
def valid?
|
88
|
+
true
|
89
|
+
end
|
90
|
+
|
91
|
+
# Checks equality by comparing each attribute.
|
92
|
+
# @param [Object] Object to be compared
|
93
|
+
def ==(o)
|
94
|
+
return true if self.equal?(o)
|
95
|
+
self.class == o.class &&
|
96
|
+
current_storefront_fs_directory_oid == o.current_storefront_fs_directory_oid &&
|
97
|
+
hostname == o.hostname &&
|
98
|
+
parent_storefront_fs_directory_oid == o.parent_storefront_fs_directory_oid &&
|
99
|
+
path == o.path &&
|
100
|
+
storefront_oid == o.storefront_oid
|
101
|
+
end
|
102
|
+
|
103
|
+
# @see the `==` method
|
104
|
+
# @param [Object] Object to be compared
|
105
|
+
def eql?(o)
|
106
|
+
self == o
|
107
|
+
end
|
108
|
+
|
109
|
+
# Calculates hash code according to all attributes.
|
110
|
+
# @return [Fixnum] Hash code
|
111
|
+
def hash
|
112
|
+
[current_storefront_fs_directory_oid, hostname, parent_storefront_fs_directory_oid, path, storefront_oid].hash
|
113
|
+
end
|
114
|
+
|
115
|
+
# Builds the object from hash
|
116
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
117
|
+
# @return [Object] Returns the model itself
|
118
|
+
def build_from_hash(attributes)
|
119
|
+
return nil unless attributes.is_a?(Hash)
|
120
|
+
self.class.swagger_types.each_pair do |key, type|
|
121
|
+
if type =~ /\AArray<(.*)>/i
|
122
|
+
# check to ensure the input is an array given that the attribute
|
123
|
+
# is documented as an array but the input is not
|
124
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
125
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
126
|
+
end
|
127
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
128
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
129
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
130
|
+
end
|
131
|
+
|
132
|
+
self
|
133
|
+
end
|
134
|
+
|
135
|
+
# Deserializes the data based on type
|
136
|
+
# @param string type Data type
|
137
|
+
# @param string value Value to be deserialized
|
138
|
+
# @return [Object] Deserialized data
|
139
|
+
def _deserialize(type, value)
|
140
|
+
case type.to_sym
|
141
|
+
when :DateTime
|
142
|
+
DateTime.parse(value)
|
143
|
+
when :Date
|
144
|
+
Date.parse(value)
|
145
|
+
when :String
|
146
|
+
value.to_s
|
147
|
+
when :Integer
|
148
|
+
value.to_i
|
149
|
+
when :Float
|
150
|
+
value.to_f
|
151
|
+
when :BOOLEAN
|
152
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
153
|
+
true
|
154
|
+
else
|
155
|
+
false
|
156
|
+
end
|
157
|
+
when :Object
|
158
|
+
# generic object (usually a Hash), return directly
|
159
|
+
value
|
160
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
161
|
+
inner_type = Regexp.last_match[:inner_type]
|
162
|
+
value.map { |v| _deserialize(inner_type, v) }
|
163
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
164
|
+
k_type = Regexp.last_match[:k_type]
|
165
|
+
v_type = Regexp.last_match[:v_type]
|
166
|
+
{}.tap do |hash|
|
167
|
+
value.each do |k, v|
|
168
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
169
|
+
end
|
170
|
+
end
|
171
|
+
else # model
|
172
|
+
temp_model = UltracartClient.const_get(type).new
|
173
|
+
temp_model.build_from_hash(value)
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
# Returns the string representation of the object
|
178
|
+
# @return [String] String presentation of the object
|
179
|
+
def to_s
|
180
|
+
to_hash.to_s
|
181
|
+
end
|
182
|
+
|
183
|
+
# to_body is an alias to to_hash (backward compatibility)
|
184
|
+
# @return [Hash] Returns the object in the form of hash
|
185
|
+
def to_body
|
186
|
+
to_hash
|
187
|
+
end
|
188
|
+
|
189
|
+
# Returns the object in the form of hash
|
190
|
+
# @return [Hash] Returns the object in the form of hash
|
191
|
+
def to_hash
|
192
|
+
hash = {}
|
193
|
+
self.class.attribute_map.each_pair do |attr, param|
|
194
|
+
value = self.send(attr)
|
195
|
+
next if value.nil?
|
196
|
+
hash[param] = _to_hash(value)
|
197
|
+
end
|
198
|
+
hash
|
199
|
+
end
|
200
|
+
|
201
|
+
# Outputs non-array value in the form of hash
|
202
|
+
# For object, use to_hash. Otherwise, just return the value
|
203
|
+
# @param [Object] value Any valid value
|
204
|
+
# @return [Hash] Returns the value in the form of hash
|
205
|
+
def _to_hash(value)
|
206
|
+
if value.is_a?(Array)
|
207
|
+
value.compact.map { |v| _to_hash(v) }
|
208
|
+
elsif value.is_a?(Hash)
|
209
|
+
{}.tap do |hash|
|
210
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
211
|
+
end
|
212
|
+
elsif value.respond_to? :to_hash
|
213
|
+
value.to_hash
|
214
|
+
else
|
215
|
+
value
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
219
|
+
end
|
220
|
+
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: 3.10.
|
4
|
+
version: 3.10.50
|
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
|
@@ -591,6 +591,7 @@ files:
|
|
591
591
|
- docs/ExperimentVariation.md
|
592
592
|
- docs/ExperimentVariationStat.md
|
593
593
|
- docs/ExperimentsResponse.md
|
594
|
+
- docs/FileManagerPage.md
|
594
595
|
- docs/FulfillmentApi.md
|
595
596
|
- docs/FulfillmentInventory.md
|
596
597
|
- docs/FulfillmentShipment.md
|
@@ -1299,6 +1300,7 @@ files:
|
|
1299
1300
|
- lib/ultracart_api/models/experiment_variation.rb
|
1300
1301
|
- lib/ultracart_api/models/experiment_variation_stat.rb
|
1301
1302
|
- lib/ultracart_api/models/experiments_response.rb
|
1303
|
+
- lib/ultracart_api/models/file_manager_page.rb
|
1302
1304
|
- lib/ultracart_api/models/fulfillment_inventory.rb
|
1303
1305
|
- lib/ultracart_api/models/fulfillment_shipment.rb
|
1304
1306
|
- lib/ultracart_api/models/geo_point.rb
|