ultracart_api 3.10.50 → 3.10.51

Sign up to get free protection for your applications and to get access to all the features.
@@ -12,12 +12,10 @@ 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
17
15
  [**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
18
16
  [**create_email_sending_domain2**](StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
17
+ [**create_fs_directory**](StorefrontApi.md#create_fs_directory) | **POST** /storefront/{id}/fs/dir | Create file manager directory
19
18
  [**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
21
19
  [**delete_email_campaign_folder**](StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
22
20
  [**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
23
21
  [**delete_email_email**](StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
@@ -27,6 +25,7 @@ Method | HTTP request | Description
27
25
  [**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
28
26
  [**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
29
27
  [**delete_experiment**](StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
28
+ [**delete_fs_file**](StorefrontApi.md#delete_fs_file) | **DELETE** /storefront/{id}/fs/file | Delete file manager directory
30
29
  [**delete_heatmap**](StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
31
30
  [**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
32
31
  [**delete_library_item_published_versions**](StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
@@ -35,7 +34,6 @@ Method | HTTP request | Description
35
34
  [**duplicate_library_item**](StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
36
35
  [**favorite_screen_recording**](StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
37
36
  [**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
39
37
  [**get_countries**](StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
40
38
  [**get_editor_token**](StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
41
39
  [**get_email_base_templates**](StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
@@ -94,6 +92,7 @@ Method | HTTP request | Description
94
92
  [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
95
93
  [**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
96
94
  [**get_experiments**](StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
95
+ [**get_fs_directory**](StorefrontApi.md#get_fs_directory) | **GET** /storefront/{id}/fs/dir | Get file manager directory
97
96
  [**get_heatmap**](StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
98
97
  [**get_heatmap_index**](StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
99
98
  [**get_histogram_property_names**](StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
@@ -117,6 +116,7 @@ Method | HTTP request | Description
117
116
  [**get_transaction_email_screenshots**](StorefrontApi.md#get_transaction_email_screenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
118
117
  [**get_twilio_account**](StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
119
118
  [**get_twilio_accounts**](StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
119
+ [**get_upload_fs_file_url**](StorefrontApi.md#get_upload_fs_file_url) | **GET** /storefront/{id}/fs/upload_url/{extension} | Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
120
120
  [**global_unsubscribe**](StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
121
121
  [**import_email_third_party_provider_list**](StorefrontApi.md#import_email_third_party_provider_list) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
122
122
  [**insert_email_campaign**](StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
@@ -173,6 +173,7 @@ Method | HTTP request | Description
173
173
  [**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
174
174
  [**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
175
175
  [**update_twilio_account**](StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
176
+ [**upload_fs_file**](StorefrontApi.md#upload_fs_file) | **POST** /storefront/{id}/fs/upload | This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
176
177
  [**validate_ruler**](StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
177
178
 
178
179
 
@@ -592,112 +593,6 @@ Name | Type | Description | Notes
592
593
 
593
594
 
594
595
 
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
-
701
596
  # **create_email_sending_domain**
702
597
  > EmailSendingDomainResponse create_email_sending_domain(domain)
703
598
 
@@ -794,10 +689,10 @@ Name | Type | Description | Notes
794
689
 
795
690
 
796
691
 
797
- # **create_twilio_account**
798
- > TwilioResponse create_twilio_account(twilio)
692
+ # **create_fs_directory**
693
+ > FileManagerPage create_fs_directory(id, opts)
799
694
 
800
- Create Twilio account
695
+ Create file manager directory
801
696
 
802
697
  ### Example
803
698
  ```ruby
@@ -809,15 +704,19 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
809
704
  api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
810
705
 
811
706
 
812
- twilio = UltracartClient::Twilio.new # Twilio | Twilio
707
+ id = 56 # Integer |
813
708
 
709
+ opts = {
710
+ name: 'name_example', # String |
711
+ parent_storefront_fs_directory_oid: 56 # Integer |
712
+ }
814
713
 
815
714
  begin
816
- #Create Twilio account
817
- result = api_instance.create_twilio_account(twilio)
715
+ #Create file manager directory
716
+ result = api_instance.create_fs_directory(id, opts)
818
717
  p result
819
718
  rescue UltracartClient::ApiError => e
820
- puts "Exception when calling StorefrontApi->create_twilio_account: #{e}"
719
+ puts "Exception when calling StorefrontApi->create_fs_directory: #{e}"
821
720
  end
822
721
  ```
823
722
 
@@ -825,11 +724,13 @@ end
825
724
 
826
725
  Name | Type | Description | Notes
827
726
  ------------- | ------------- | ------------- | -------------
828
- **twilio** | [**Twilio**](Twilio.md)| Twilio |
727
+ **id** | **Integer**| |
728
+ **name** | **String**| | [optional]
729
+ **parent_storefront_fs_directory_oid** | **Integer**| | [optional]
829
730
 
830
731
  ### Return type
831
732
 
832
- [**TwilioResponse**](TwilioResponse.md)
733
+ [**FileManagerPage**](FileManagerPage.md)
833
734
 
834
735
  ### Authorization
835
736
 
@@ -842,10 +743,10 @@ Name | Type | Description | Notes
842
743
 
843
744
 
844
745
 
845
- # **delete_admin_panel_fs_file**
846
- > FileManagerPage delete_admin_panel_fs_file(id, opts)
746
+ # **create_twilio_account**
747
+ > TwilioResponse create_twilio_account(twilio)
847
748
 
848
- Delete file manager directory for admin panel
749
+ Create Twilio account
849
750
 
850
751
  ### Example
851
752
  ```ruby
@@ -857,19 +758,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
857
758
  api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
858
759
 
859
760
 
860
- id = 56 # Integer |
761
+ twilio = UltracartClient::Twilio.new # Twilio | Twilio
861
762
 
862
- opts = {
863
- parent_storefront_fs_directory_oid: 56, # Integer |
864
- storefront_fs_file_oid: 56 # Integer |
865
- }
866
763
 
867
764
  begin
868
- #Delete file manager directory for admin panel
869
- result = api_instance.delete_admin_panel_fs_file(id, opts)
765
+ #Create Twilio account
766
+ result = api_instance.create_twilio_account(twilio)
870
767
  p result
871
768
  rescue UltracartClient::ApiError => e
872
- puts "Exception when calling StorefrontApi->delete_admin_panel_fs_file: #{e}"
769
+ puts "Exception when calling StorefrontApi->create_twilio_account: #{e}"
873
770
  end
874
771
  ```
875
772
 
@@ -877,13 +774,11 @@ end
877
774
 
878
775
  Name | Type | Description | Notes
879
776
  ------------- | ------------- | ------------- | -------------
880
- **id** | **Integer**| |
881
- **parent_storefront_fs_directory_oid** | **Integer**| | [optional]
882
- **storefront_fs_file_oid** | **Integer**| | [optional]
777
+ **twilio** | [**Twilio**](Twilio.md)| Twilio |
883
778
 
884
779
  ### Return type
885
780
 
886
- [**FileManagerPage**](FileManagerPage.md)
781
+ [**TwilioResponse**](TwilioResponse.md)
887
782
 
888
783
  ### Authorization
889
784
 
@@ -1353,6 +1248,60 @@ nil (empty response body)
1353
1248
 
1354
1249
 
1355
1250
 
1251
+ # **delete_fs_file**
1252
+ > FileManagerPage delete_fs_file(id, opts)
1253
+
1254
+ Delete file manager directory
1255
+
1256
+ ### Example
1257
+ ```ruby
1258
+ # load the gem
1259
+ require 'ultracart_api'
1260
+
1261
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1262
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1263
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
1264
+
1265
+
1266
+ id = 56 # Integer |
1267
+
1268
+ opts = {
1269
+ parent_storefront_fs_directory_oid: 56, # Integer |
1270
+ storefront_fs_file_oid: 56 # Integer |
1271
+ }
1272
+
1273
+ begin
1274
+ #Delete file manager directory
1275
+ result = api_instance.delete_fs_file(id, opts)
1276
+ p result
1277
+ rescue UltracartClient::ApiError => e
1278
+ puts "Exception when calling StorefrontApi->delete_fs_file: #{e}"
1279
+ end
1280
+ ```
1281
+
1282
+ ### Parameters
1283
+
1284
+ Name | Type | Description | Notes
1285
+ ------------- | ------------- | ------------- | -------------
1286
+ **id** | **Integer**| |
1287
+ **parent_storefront_fs_directory_oid** | **Integer**| | [optional]
1288
+ **storefront_fs_file_oid** | **Integer**| | [optional]
1289
+
1290
+ ### Return type
1291
+
1292
+ [**FileManagerPage**](FileManagerPage.md)
1293
+
1294
+ ### Authorization
1295
+
1296
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1297
+
1298
+ ### HTTP request headers
1299
+
1300
+ - **Content-Type**: application/json
1301
+ - **Accept**: application/json
1302
+
1303
+
1304
+
1356
1305
  # **delete_heatmap**
1357
1306
  > delete_heatmap(storefront_oid, query)
1358
1307
 
@@ -1748,62 +1697,6 @@ Name | Type | Description | Notes
1748
1697
 
1749
1698
 
1750
1699
 
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
-
1807
1700
  # **get_countries**
1808
1701
  > CountriesResponse get_countries(storefront_oid)
1809
1702
 
@@ -4754,6 +4647,62 @@ Name | Type | Description | Notes
4754
4647
 
4755
4648
 
4756
4649
 
4650
+ # **get_fs_directory**
4651
+ > FileManagerPage get_fs_directory(id, opts)
4652
+
4653
+ Get file manager directory
4654
+
4655
+ ### Example
4656
+ ```ruby
4657
+ # load the gem
4658
+ require 'ultracart_api'
4659
+
4660
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4661
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4662
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
4663
+
4664
+
4665
+ id = 56 # Integer |
4666
+
4667
+ opts = {
4668
+ path: 'path_example', # String |
4669
+ storefront_fs_directory_oid: 56, # Integer |
4670
+ storefront_theme_oid: 56 # Integer |
4671
+ }
4672
+
4673
+ begin
4674
+ #Get file manager directory
4675
+ result = api_instance.get_fs_directory(id, opts)
4676
+ p result
4677
+ rescue UltracartClient::ApiError => e
4678
+ puts "Exception when calling StorefrontApi->get_fs_directory: #{e}"
4679
+ end
4680
+ ```
4681
+
4682
+ ### Parameters
4683
+
4684
+ Name | Type | Description | Notes
4685
+ ------------- | ------------- | ------------- | -------------
4686
+ **id** | **Integer**| |
4687
+ **path** | **String**| | [optional]
4688
+ **storefront_fs_directory_oid** | **Integer**| | [optional]
4689
+ **storefront_theme_oid** | **Integer**| | [optional]
4690
+
4691
+ ### Return type
4692
+
4693
+ [**FileManagerPage**](FileManagerPage.md)
4694
+
4695
+ ### Authorization
4696
+
4697
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4698
+
4699
+ ### HTTP request headers
4700
+
4701
+ - **Content-Type**: application/json
4702
+ - **Accept**: application/json
4703
+
4704
+
4705
+
4757
4706
  # **get_heatmap**
4758
4707
  > ScreenRecordingHeatmapResponse get_heatmap(storefront_oid, query)
4759
4708
 
@@ -5934,6 +5883,57 @@ This endpoint does not need any parameter.
5934
5883
 
5935
5884
 
5936
5885
 
5886
+ # **get_upload_fs_file_url**
5887
+ > FileManagerUploadUrlResponse get_upload_fs_file_url(id, extension)
5888
+
5889
+ Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
5890
+
5891
+ ### Example
5892
+ ```ruby
5893
+ # load the gem
5894
+ require 'ultracart_api'
5895
+
5896
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
5897
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
5898
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
5899
+
5900
+
5901
+ id = 56 # Integer |
5902
+
5903
+ extension = 'extension_example' # String |
5904
+
5905
+
5906
+ begin
5907
+ #Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
5908
+ result = api_instance.get_upload_fs_file_url(id, extension)
5909
+ p result
5910
+ rescue UltracartClient::ApiError => e
5911
+ puts "Exception when calling StorefrontApi->get_upload_fs_file_url: #{e}"
5912
+ end
5913
+ ```
5914
+
5915
+ ### Parameters
5916
+
5917
+ Name | Type | Description | Notes
5918
+ ------------- | ------------- | ------------- | -------------
5919
+ **id** | **Integer**| |
5920
+ **extension** | **String**| |
5921
+
5922
+ ### Return type
5923
+
5924
+ [**FileManagerUploadUrlResponse**](FileManagerUploadUrlResponse.md)
5925
+
5926
+ ### Authorization
5927
+
5928
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5929
+
5930
+ ### HTTP request headers
5931
+
5932
+ - **Content-Type**: application/json
5933
+ - **Accept**: application/json
5934
+
5935
+
5936
+
5937
5937
  # **global_unsubscribe**
5938
5938
  > EmailGlobalUnsubscribeResponse global_unsubscribe(storefront_oid, unsubscribe)
5939
5939
 
@@ -8895,6 +8895,56 @@ Name | Type | Description | Notes
8895
8895
 
8896
8896
 
8897
8897
 
8898
+ # **upload_fs_file**
8899
+ > upload_fs_file(id, upload_request)
8900
+
8901
+ This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
8902
+
8903
+ ### Example
8904
+ ```ruby
8905
+ # load the gem
8906
+ require 'ultracart_api'
8907
+
8908
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
8909
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
8910
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
8911
+
8912
+
8913
+ id = 56 # Integer |
8914
+
8915
+ upload_request = UltracartClient::FileManagerUploadRequest.new # FileManagerUploadRequest | UploadRequest
8916
+
8917
+
8918
+ begin
8919
+ #This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
8920
+ api_instance.upload_fs_file(id, upload_request)
8921
+ rescue UltracartClient::ApiError => e
8922
+ puts "Exception when calling StorefrontApi->upload_fs_file: #{e}"
8923
+ end
8924
+ ```
8925
+
8926
+ ### Parameters
8927
+
8928
+ Name | Type | Description | Notes
8929
+ ------------- | ------------- | ------------- | -------------
8930
+ **id** | **Integer**| |
8931
+ **upload_request** | [**FileManagerUploadRequest**](FileManagerUploadRequest.md)| UploadRequest |
8932
+
8933
+ ### Return type
8934
+
8935
+ nil (empty response body)
8936
+
8937
+ ### Authorization
8938
+
8939
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8940
+
8941
+ ### HTTP request headers
8942
+
8943
+ - **Content-Type**: application/json
8944
+ - **Accept**: application/json
8945
+
8946
+
8947
+
8898
8948
  # **validate_ruler**
8899
8949
  > RulerValidationResponse validate_ruler(ruler_validate_request)
8900
8950
 
@@ -262,6 +262,61 @@ module UltracartClient
262
262
  end
263
263
  return data, status_code, headers
264
264
  end
265
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
266
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. 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.
267
+ # @param external_id The external id to match against.
268
+ # @param [Hash] opts the optional parameters
269
+ # @return [ItemDigitalItemsResponse]
270
+ def get_digital_items_by_external_id(external_id, opts = {})
271
+ data, _status_code, _headers = get_digital_items_by_external_id_with_http_info(external_id, opts)
272
+ data
273
+ end
274
+
275
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
276
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. 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.
277
+ # @param external_id The external id to match against.
278
+ # @param [Hash] opts the optional parameters
279
+ # @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
280
+ def get_digital_items_by_external_id_with_http_info(external_id, opts = {})
281
+ if @api_client.config.debugging
282
+ @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items_by_external_id ...'
283
+ end
284
+ # verify the required parameter 'external_id' is set
285
+ if @api_client.config.client_side_validation && external_id.nil?
286
+ fail ArgumentError, "Missing the required parameter 'external_id' when calling ItemApi.get_digital_items_by_external_id"
287
+ end
288
+ # resource path
289
+ local_var_path = '/item/digital_library/by_external/{external_id}'.sub('{' + 'external_id' + '}', external_id.to_s)
290
+
291
+ # query parameters
292
+ query_params = {}
293
+
294
+ # header parameters
295
+ header_params = {}
296
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
297
+ # HTTP header 'Accept' (if needed)
298
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
299
+ # HTTP header 'Content-Type'
300
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
301
+
302
+ # form parameters
303
+ form_params = {}
304
+
305
+ # http body (model)
306
+ post_body = nil
307
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
308
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
309
+ :header_params => header_params,
310
+ :query_params => query_params,
311
+ :form_params => form_params,
312
+ :body => post_body,
313
+ :auth_names => auth_names,
314
+ :return_type => 'ItemDigitalItemsResponse')
315
+ if @api_client.config.debugging
316
+ @api_client.config.logger.debug "API called: ItemApi#get_digital_items_by_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
317
+ end
318
+ return data, status_code, headers
319
+ end
265
320
  # Retrieve an item
266
321
  # Retrieves a single item using the specified item oid.
267
322
  # @param merchant_item_oid The item oid to retrieve.