ultracart_api 4.0.67.rc → 4.0.68.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -8
- data/docs/FileManagerDirectory.md +42 -0
- data/docs/FileManagerFile.md +54 -0
- data/docs/FileManagerPage.md +6 -0
- data/docs/FileManagerUploadRequest.md +22 -0
- data/docs/FileManagerUploadUrlResponse.md +26 -0
- data/docs/ItemApi.md +72 -0
- data/docs/ItemDigitalItem.md +2 -0
- data/docs/StorefrontApi.md +336 -267
- data/lib/ultracart_api/api/item_api.rb +64 -0
- data/lib/ultracart_api/api/storefront_api.rb +328 -252
- data/lib/ultracart_api/models/file_manager_directory.rb +327 -0
- data/lib/ultracart_api/models/file_manager_file.rb +381 -0
- data/lib/ultracart_api/models/file_manager_page.rb +34 -1
- data/lib/ultracart_api/models/file_manager_upload_request.rb +237 -0
- data/lib/ultracart_api/models/file_manager_upload_url_response.rb +256 -0
- data/lib/ultracart_api/models/item_digital_item.rb +26 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
data/docs/StorefrontApi.md
CHANGED
@@ -12,12 +12,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
12
12
|
| [**check_download_email_segment**](StorefrontApi.md#check_download_email_segment) | **POST** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} | Check download of email segment |
|
13
13
|
| [**clone_email_campaign**](StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign |
|
14
14
|
| [**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow |
|
15
|
-
| [**create_admin_panel_fs_directory**](StorefrontApi.md#create_admin_panel_fs_directory) | **POST** /storefront/{id}/adminPanel/fs/dir | Create file manager directory for admin panel |
|
16
|
-
| [**create_admin_panel_fs_file_upload**](StorefrontApi.md#create_admin_panel_fs_file_upload) | **POST** /storefront/{id}/adminPanel/fs/file | Upload file manager file for admin panel |
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
|
@@ -752,154 +753,6 @@ end
|
|
752
753
|
- **Accept**: application/json
|
753
754
|
|
754
755
|
|
755
|
-
## create_admin_panel_fs_directory
|
756
|
-
|
757
|
-
> <FileManagerPage> create_admin_panel_fs_directory(id, opts)
|
758
|
-
|
759
|
-
Create file manager directory for admin panel
|
760
|
-
|
761
|
-
### Examples
|
762
|
-
|
763
|
-
```ruby
|
764
|
-
require 'time'
|
765
|
-
require 'ultracart_api'
|
766
|
-
require 'json'
|
767
|
-
require 'yaml'
|
768
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
769
|
-
|
770
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
771
|
-
# As such, this might not be the best way to use this object.
|
772
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
773
|
-
|
774
|
-
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
775
|
-
id = 56 # Integer |
|
776
|
-
opts = {
|
777
|
-
name: 'name_example', # String |
|
778
|
-
parent_storefront_fs_directory_oid: 56 # Integer |
|
779
|
-
}
|
780
|
-
|
781
|
-
begin
|
782
|
-
# Create file manager directory for admin panel
|
783
|
-
result = api_instance.create_admin_panel_fs_directory(id, opts)
|
784
|
-
p result
|
785
|
-
rescue UltracartClient::ApiError => e
|
786
|
-
puts "Error when calling StorefrontApi->create_admin_panel_fs_directory: #{e}"
|
787
|
-
end
|
788
|
-
```
|
789
|
-
|
790
|
-
#### Using the create_admin_panel_fs_directory_with_http_info variant
|
791
|
-
|
792
|
-
This returns an Array which contains the response data, status code and headers.
|
793
|
-
|
794
|
-
> <Array(<FileManagerPage>, Integer, Hash)> create_admin_panel_fs_directory_with_http_info(id, opts)
|
795
|
-
|
796
|
-
```ruby
|
797
|
-
begin
|
798
|
-
# Create file manager directory for admin panel
|
799
|
-
data, status_code, headers = api_instance.create_admin_panel_fs_directory_with_http_info(id, opts)
|
800
|
-
p status_code # => 2xx
|
801
|
-
p headers # => { ... }
|
802
|
-
p data # => <FileManagerPage>
|
803
|
-
rescue UltracartClient::ApiError => e
|
804
|
-
puts "Error when calling StorefrontApi->create_admin_panel_fs_directory_with_http_info: #{e}"
|
805
|
-
end
|
806
|
-
```
|
807
|
-
|
808
|
-
### Parameters
|
809
|
-
|
810
|
-
| Name | Type | Description | Notes |
|
811
|
-
| ---- | ---- | ----------- | ----- |
|
812
|
-
| **id** | **Integer** | | |
|
813
|
-
| **name** | **String** | | [optional] |
|
814
|
-
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
815
|
-
|
816
|
-
### Return type
|
817
|
-
|
818
|
-
[**FileManagerPage**](FileManagerPage.md)
|
819
|
-
|
820
|
-
### Authorization
|
821
|
-
|
822
|
-
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
823
|
-
|
824
|
-
### HTTP request headers
|
825
|
-
|
826
|
-
- **Content-Type**: Not defined
|
827
|
-
- **Accept**: application/json
|
828
|
-
|
829
|
-
|
830
|
-
## create_admin_panel_fs_file_upload
|
831
|
-
|
832
|
-
> <FileManagerPage> create_admin_panel_fs_file_upload(id, opts)
|
833
|
-
|
834
|
-
Upload file manager file for admin panel
|
835
|
-
|
836
|
-
### Examples
|
837
|
-
|
838
|
-
```ruby
|
839
|
-
require 'time'
|
840
|
-
require 'ultracart_api'
|
841
|
-
require 'json'
|
842
|
-
require 'yaml'
|
843
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
844
|
-
|
845
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
846
|
-
# As such, this might not be the best way to use this object.
|
847
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
848
|
-
|
849
|
-
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
850
|
-
id = 56 # Integer |
|
851
|
-
opts = {
|
852
|
-
parent_storefront_fs_directory_oid: 56 # Integer |
|
853
|
-
}
|
854
|
-
|
855
|
-
begin
|
856
|
-
# Upload file manager file for admin panel
|
857
|
-
result = api_instance.create_admin_panel_fs_file_upload(id, opts)
|
858
|
-
p result
|
859
|
-
rescue UltracartClient::ApiError => e
|
860
|
-
puts "Error when calling StorefrontApi->create_admin_panel_fs_file_upload: #{e}"
|
861
|
-
end
|
862
|
-
```
|
863
|
-
|
864
|
-
#### Using the create_admin_panel_fs_file_upload_with_http_info variant
|
865
|
-
|
866
|
-
This returns an Array which contains the response data, status code and headers.
|
867
|
-
|
868
|
-
> <Array(<FileManagerPage>, Integer, Hash)> create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
869
|
-
|
870
|
-
```ruby
|
871
|
-
begin
|
872
|
-
# Upload file manager file for admin panel
|
873
|
-
data, status_code, headers = api_instance.create_admin_panel_fs_file_upload_with_http_info(id, opts)
|
874
|
-
p status_code # => 2xx
|
875
|
-
p headers # => { ... }
|
876
|
-
p data # => <FileManagerPage>
|
877
|
-
rescue UltracartClient::ApiError => e
|
878
|
-
puts "Error when calling StorefrontApi->create_admin_panel_fs_file_upload_with_http_info: #{e}"
|
879
|
-
end
|
880
|
-
```
|
881
|
-
|
882
|
-
### Parameters
|
883
|
-
|
884
|
-
| Name | Type | Description | Notes |
|
885
|
-
| ---- | ---- | ----------- | ----- |
|
886
|
-
| **id** | **Integer** | | |
|
887
|
-
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
888
|
-
|
889
|
-
### Return type
|
890
|
-
|
891
|
-
[**FileManagerPage**](FileManagerPage.md)
|
892
|
-
|
893
|
-
### Authorization
|
894
|
-
|
895
|
-
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
896
|
-
|
897
|
-
### HTTP request headers
|
898
|
-
|
899
|
-
- **Content-Type**: Not defined
|
900
|
-
- **Accept**: application/json
|
901
|
-
|
902
|
-
|
903
756
|
## create_email_sending_domain
|
904
757
|
|
905
758
|
> <EmailSendingDomainResponse> create_email_sending_domain(domain)
|
@@ -1038,11 +891,11 @@ end
|
|
1038
891
|
- **Accept**: application/json
|
1039
892
|
|
1040
893
|
|
1041
|
-
##
|
894
|
+
## create_fs_directory
|
1042
895
|
|
1043
|
-
> <
|
896
|
+
> <FileManagerPage> create_fs_directory(id, opts)
|
1044
897
|
|
1045
|
-
Create
|
898
|
+
Create file manager directory
|
1046
899
|
|
1047
900
|
### Examples
|
1048
901
|
|
@@ -1058,32 +911,36 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
|
|
1058
911
|
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1059
912
|
|
1060
913
|
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1061
|
-
|
914
|
+
id = 56 # Integer |
|
915
|
+
opts = {
|
916
|
+
name: 'name_example', # String |
|
917
|
+
parent_storefront_fs_directory_oid: 56 # Integer |
|
918
|
+
}
|
1062
919
|
|
1063
920
|
begin
|
1064
|
-
# Create
|
1065
|
-
result = api_instance.
|
921
|
+
# Create file manager directory
|
922
|
+
result = api_instance.create_fs_directory(id, opts)
|
1066
923
|
p result
|
1067
924
|
rescue UltracartClient::ApiError => e
|
1068
|
-
puts "Error when calling StorefrontApi->
|
925
|
+
puts "Error when calling StorefrontApi->create_fs_directory: #{e}"
|
1069
926
|
end
|
1070
927
|
```
|
1071
928
|
|
1072
|
-
#### Using the
|
929
|
+
#### Using the create_fs_directory_with_http_info variant
|
1073
930
|
|
1074
931
|
This returns an Array which contains the response data, status code and headers.
|
1075
932
|
|
1076
|
-
> <Array(<
|
933
|
+
> <Array(<FileManagerPage>, Integer, Hash)> create_fs_directory_with_http_info(id, opts)
|
1077
934
|
|
1078
935
|
```ruby
|
1079
936
|
begin
|
1080
|
-
# Create
|
1081
|
-
data, status_code, headers = api_instance.
|
937
|
+
# Create file manager directory
|
938
|
+
data, status_code, headers = api_instance.create_fs_directory_with_http_info(id, opts)
|
1082
939
|
p status_code # => 2xx
|
1083
940
|
p headers # => { ... }
|
1084
|
-
p data # => <
|
941
|
+
p data # => <FileManagerPage>
|
1085
942
|
rescue UltracartClient::ApiError => e
|
1086
|
-
puts "Error when calling StorefrontApi->
|
943
|
+
puts "Error when calling StorefrontApi->create_fs_directory_with_http_info: #{e}"
|
1087
944
|
end
|
1088
945
|
```
|
1089
946
|
|
@@ -1091,11 +948,13 @@ end
|
|
1091
948
|
|
1092
949
|
| Name | Type | Description | Notes |
|
1093
950
|
| ---- | ---- | ----------- | ----- |
|
1094
|
-
| **
|
951
|
+
| **id** | **Integer** | | |
|
952
|
+
| **name** | **String** | | [optional] |
|
953
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
1095
954
|
|
1096
955
|
### Return type
|
1097
956
|
|
1098
|
-
[**
|
957
|
+
[**FileManagerPage**](FileManagerPage.md)
|
1099
958
|
|
1100
959
|
### Authorization
|
1101
960
|
|
@@ -1103,15 +962,15 @@ end
|
|
1103
962
|
|
1104
963
|
### HTTP request headers
|
1105
964
|
|
1106
|
-
- **Content-Type**:
|
965
|
+
- **Content-Type**: Not defined
|
1107
966
|
- **Accept**: application/json
|
1108
967
|
|
1109
968
|
|
1110
|
-
##
|
969
|
+
## create_twilio_account
|
1111
970
|
|
1112
|
-
> <
|
971
|
+
> <TwilioResponse> create_twilio_account(twilio)
|
1113
972
|
|
1114
|
-
|
973
|
+
Create Twilio account
|
1115
974
|
|
1116
975
|
### Examples
|
1117
976
|
|
@@ -1127,36 +986,32 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
|
|
1127
986
|
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1128
987
|
|
1129
988
|
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1130
|
-
|
1131
|
-
opts = {
|
1132
|
-
parent_storefront_fs_directory_oid: 56, # Integer |
|
1133
|
-
storefront_fs_file_oid: 56 # Integer |
|
1134
|
-
}
|
989
|
+
twilio = UltracartClient::Twilio.new # Twilio | Twilio
|
1135
990
|
|
1136
991
|
begin
|
1137
|
-
#
|
1138
|
-
result = api_instance.
|
992
|
+
# Create Twilio account
|
993
|
+
result = api_instance.create_twilio_account(twilio)
|
1139
994
|
p result
|
1140
995
|
rescue UltracartClient::ApiError => e
|
1141
|
-
puts "Error when calling StorefrontApi->
|
996
|
+
puts "Error when calling StorefrontApi->create_twilio_account: #{e}"
|
1142
997
|
end
|
1143
998
|
```
|
1144
999
|
|
1145
|
-
#### Using the
|
1000
|
+
#### Using the create_twilio_account_with_http_info variant
|
1146
1001
|
|
1147
1002
|
This returns an Array which contains the response data, status code and headers.
|
1148
1003
|
|
1149
|
-
> <Array(<
|
1004
|
+
> <Array(<TwilioResponse>, Integer, Hash)> create_twilio_account_with_http_info(twilio)
|
1150
1005
|
|
1151
1006
|
```ruby
|
1152
1007
|
begin
|
1153
|
-
#
|
1154
|
-
data, status_code, headers = api_instance.
|
1008
|
+
# Create Twilio account
|
1009
|
+
data, status_code, headers = api_instance.create_twilio_account_with_http_info(twilio)
|
1155
1010
|
p status_code # => 2xx
|
1156
1011
|
p headers # => { ... }
|
1157
|
-
p data # => <
|
1012
|
+
p data # => <TwilioResponse>
|
1158
1013
|
rescue UltracartClient::ApiError => e
|
1159
|
-
puts "Error when calling StorefrontApi->
|
1014
|
+
puts "Error when calling StorefrontApi->create_twilio_account_with_http_info: #{e}"
|
1160
1015
|
end
|
1161
1016
|
```
|
1162
1017
|
|
@@ -1164,13 +1019,11 @@ end
|
|
1164
1019
|
|
1165
1020
|
| Name | Type | Description | Notes |
|
1166
1021
|
| ---- | ---- | ----------- | ----- |
|
1167
|
-
| **
|
1168
|
-
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
1169
|
-
| **storefront_fs_file_oid** | **Integer** | | [optional] |
|
1022
|
+
| **twilio** | [**Twilio**](Twilio.md) | Twilio | |
|
1170
1023
|
|
1171
1024
|
### Return type
|
1172
1025
|
|
1173
|
-
[**
|
1026
|
+
[**TwilioResponse**](TwilioResponse.md)
|
1174
1027
|
|
1175
1028
|
### Authorization
|
1176
1029
|
|
@@ -1178,7 +1031,7 @@ end
|
|
1178
1031
|
|
1179
1032
|
### HTTP request headers
|
1180
1033
|
|
1181
|
-
- **Content-Type**:
|
1034
|
+
- **Content-Type**: application/json
|
1182
1035
|
- **Accept**: application/json
|
1183
1036
|
|
1184
1037
|
|
@@ -1819,6 +1672,81 @@ nil (empty response body)
|
|
1819
1672
|
- **Accept**: application/json
|
1820
1673
|
|
1821
1674
|
|
1675
|
+
## delete_fs_file
|
1676
|
+
|
1677
|
+
> <FileManagerPage> delete_fs_file(id, opts)
|
1678
|
+
|
1679
|
+
Delete file manager directory
|
1680
|
+
|
1681
|
+
### Examples
|
1682
|
+
|
1683
|
+
```ruby
|
1684
|
+
require 'time'
|
1685
|
+
require 'ultracart_api'
|
1686
|
+
require 'json'
|
1687
|
+
require 'yaml'
|
1688
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1689
|
+
|
1690
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1691
|
+
# As such, this might not be the best way to use this object.
|
1692
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1693
|
+
|
1694
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1695
|
+
id = 56 # Integer |
|
1696
|
+
opts = {
|
1697
|
+
parent_storefront_fs_directory_oid: 56, # Integer |
|
1698
|
+
storefront_fs_file_oid: 56 # Integer |
|
1699
|
+
}
|
1700
|
+
|
1701
|
+
begin
|
1702
|
+
# Delete file manager directory
|
1703
|
+
result = api_instance.delete_fs_file(id, opts)
|
1704
|
+
p result
|
1705
|
+
rescue UltracartClient::ApiError => e
|
1706
|
+
puts "Error when calling StorefrontApi->delete_fs_file: #{e}"
|
1707
|
+
end
|
1708
|
+
```
|
1709
|
+
|
1710
|
+
#### Using the delete_fs_file_with_http_info variant
|
1711
|
+
|
1712
|
+
This returns an Array which contains the response data, status code and headers.
|
1713
|
+
|
1714
|
+
> <Array(<FileManagerPage>, Integer, Hash)> delete_fs_file_with_http_info(id, opts)
|
1715
|
+
|
1716
|
+
```ruby
|
1717
|
+
begin
|
1718
|
+
# Delete file manager directory
|
1719
|
+
data, status_code, headers = api_instance.delete_fs_file_with_http_info(id, opts)
|
1720
|
+
p status_code # => 2xx
|
1721
|
+
p headers # => { ... }
|
1722
|
+
p data # => <FileManagerPage>
|
1723
|
+
rescue UltracartClient::ApiError => e
|
1724
|
+
puts "Error when calling StorefrontApi->delete_fs_file_with_http_info: #{e}"
|
1725
|
+
end
|
1726
|
+
```
|
1727
|
+
|
1728
|
+
### Parameters
|
1729
|
+
|
1730
|
+
| Name | Type | Description | Notes |
|
1731
|
+
| ---- | ---- | ----------- | ----- |
|
1732
|
+
| **id** | **Integer** | | |
|
1733
|
+
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
1734
|
+
| **storefront_fs_file_oid** | **Integer** | | [optional] |
|
1735
|
+
|
1736
|
+
### Return type
|
1737
|
+
|
1738
|
+
[**FileManagerPage**](FileManagerPage.md)
|
1739
|
+
|
1740
|
+
### Authorization
|
1741
|
+
|
1742
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1743
|
+
|
1744
|
+
### HTTP request headers
|
1745
|
+
|
1746
|
+
- **Content-Type**: Not defined
|
1747
|
+
- **Accept**: application/json
|
1748
|
+
|
1749
|
+
|
1822
1750
|
## delete_heatmap
|
1823
1751
|
|
1824
1752
|
> delete_heatmap(storefront_oid, query)
|
@@ -2378,83 +2306,6 @@ end
|
|
2378
2306
|
- **Accept**: application/json
|
2379
2307
|
|
2380
2308
|
|
2381
|
-
## get_admin_panel_fs_directory
|
2382
|
-
|
2383
|
-
> <FileManagerPage> get_admin_panel_fs_directory(id, opts)
|
2384
|
-
|
2385
|
-
Get file manager directory for admin panel
|
2386
|
-
|
2387
|
-
### Examples
|
2388
|
-
|
2389
|
-
```ruby
|
2390
|
-
require 'time'
|
2391
|
-
require 'ultracart_api'
|
2392
|
-
require 'json'
|
2393
|
-
require 'yaml'
|
2394
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2395
|
-
|
2396
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2397
|
-
# As such, this might not be the best way to use this object.
|
2398
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2399
|
-
|
2400
|
-
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2401
|
-
id = 56 # Integer |
|
2402
|
-
opts = {
|
2403
|
-
path: 'path_example', # String |
|
2404
|
-
storefront_fs_directory_oid: 56, # Integer |
|
2405
|
-
storefront_theme_oid: 56 # Integer |
|
2406
|
-
}
|
2407
|
-
|
2408
|
-
begin
|
2409
|
-
# Get file manager directory for admin panel
|
2410
|
-
result = api_instance.get_admin_panel_fs_directory(id, opts)
|
2411
|
-
p result
|
2412
|
-
rescue UltracartClient::ApiError => e
|
2413
|
-
puts "Error when calling StorefrontApi->get_admin_panel_fs_directory: #{e}"
|
2414
|
-
end
|
2415
|
-
```
|
2416
|
-
|
2417
|
-
#### Using the get_admin_panel_fs_directory_with_http_info variant
|
2418
|
-
|
2419
|
-
This returns an Array which contains the response data, status code and headers.
|
2420
|
-
|
2421
|
-
> <Array(<FileManagerPage>, Integer, Hash)> get_admin_panel_fs_directory_with_http_info(id, opts)
|
2422
|
-
|
2423
|
-
```ruby
|
2424
|
-
begin
|
2425
|
-
# Get file manager directory for admin panel
|
2426
|
-
data, status_code, headers = api_instance.get_admin_panel_fs_directory_with_http_info(id, opts)
|
2427
|
-
p status_code # => 2xx
|
2428
|
-
p headers # => { ... }
|
2429
|
-
p data # => <FileManagerPage>
|
2430
|
-
rescue UltracartClient::ApiError => e
|
2431
|
-
puts "Error when calling StorefrontApi->get_admin_panel_fs_directory_with_http_info: #{e}"
|
2432
|
-
end
|
2433
|
-
```
|
2434
|
-
|
2435
|
-
### Parameters
|
2436
|
-
|
2437
|
-
| Name | Type | Description | Notes |
|
2438
|
-
| ---- | ---- | ----------- | ----- |
|
2439
|
-
| **id** | **Integer** | | |
|
2440
|
-
| **path** | **String** | | [optional] |
|
2441
|
-
| **storefront_fs_directory_oid** | **Integer** | | [optional] |
|
2442
|
-
| **storefront_theme_oid** | **Integer** | | [optional] |
|
2443
|
-
|
2444
|
-
### Return type
|
2445
|
-
|
2446
|
-
[**FileManagerPage**](FileManagerPage.md)
|
2447
|
-
|
2448
|
-
### Authorization
|
2449
|
-
|
2450
|
-
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2451
|
-
|
2452
|
-
### HTTP request headers
|
2453
|
-
|
2454
|
-
- **Content-Type**: Not defined
|
2455
|
-
- **Accept**: application/json
|
2456
|
-
|
2457
|
-
|
2458
2309
|
## get_countries
|
2459
2310
|
|
2460
2311
|
> <CountriesResponse> get_countries(storefront_oid)
|
@@ -6583,6 +6434,83 @@ end
|
|
6583
6434
|
- **Accept**: application/json
|
6584
6435
|
|
6585
6436
|
|
6437
|
+
## get_fs_directory
|
6438
|
+
|
6439
|
+
> <FileManagerPage> get_fs_directory(id, opts)
|
6440
|
+
|
6441
|
+
Get file manager directory
|
6442
|
+
|
6443
|
+
### Examples
|
6444
|
+
|
6445
|
+
```ruby
|
6446
|
+
require 'time'
|
6447
|
+
require 'ultracart_api'
|
6448
|
+
require 'json'
|
6449
|
+
require 'yaml'
|
6450
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
6451
|
+
|
6452
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
6453
|
+
# As such, this might not be the best way to use this object.
|
6454
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
6455
|
+
|
6456
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
6457
|
+
id = 56 # Integer |
|
6458
|
+
opts = {
|
6459
|
+
path: 'path_example', # String |
|
6460
|
+
storefront_fs_directory_oid: 56, # Integer |
|
6461
|
+
storefront_theme_oid: 56 # Integer |
|
6462
|
+
}
|
6463
|
+
|
6464
|
+
begin
|
6465
|
+
# Get file manager directory
|
6466
|
+
result = api_instance.get_fs_directory(id, opts)
|
6467
|
+
p result
|
6468
|
+
rescue UltracartClient::ApiError => e
|
6469
|
+
puts "Error when calling StorefrontApi->get_fs_directory: #{e}"
|
6470
|
+
end
|
6471
|
+
```
|
6472
|
+
|
6473
|
+
#### Using the get_fs_directory_with_http_info variant
|
6474
|
+
|
6475
|
+
This returns an Array which contains the response data, status code and headers.
|
6476
|
+
|
6477
|
+
> <Array(<FileManagerPage>, Integer, Hash)> get_fs_directory_with_http_info(id, opts)
|
6478
|
+
|
6479
|
+
```ruby
|
6480
|
+
begin
|
6481
|
+
# Get file manager directory
|
6482
|
+
data, status_code, headers = api_instance.get_fs_directory_with_http_info(id, opts)
|
6483
|
+
p status_code # => 2xx
|
6484
|
+
p headers # => { ... }
|
6485
|
+
p data # => <FileManagerPage>
|
6486
|
+
rescue UltracartClient::ApiError => e
|
6487
|
+
puts "Error when calling StorefrontApi->get_fs_directory_with_http_info: #{e}"
|
6488
|
+
end
|
6489
|
+
```
|
6490
|
+
|
6491
|
+
### Parameters
|
6492
|
+
|
6493
|
+
| Name | Type | Description | Notes |
|
6494
|
+
| ---- | ---- | ----------- | ----- |
|
6495
|
+
| **id** | **Integer** | | |
|
6496
|
+
| **path** | **String** | | [optional] |
|
6497
|
+
| **storefront_fs_directory_oid** | **Integer** | | [optional] |
|
6498
|
+
| **storefront_theme_oid** | **Integer** | | [optional] |
|
6499
|
+
|
6500
|
+
### Return type
|
6501
|
+
|
6502
|
+
[**FileManagerPage**](FileManagerPage.md)
|
6503
|
+
|
6504
|
+
### Authorization
|
6505
|
+
|
6506
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
6507
|
+
|
6508
|
+
### HTTP request headers
|
6509
|
+
|
6510
|
+
- **Content-Type**: Not defined
|
6511
|
+
- **Accept**: application/json
|
6512
|
+
|
6513
|
+
|
6586
6514
|
## get_heatmap
|
6587
6515
|
|
6588
6516
|
> <ScreenRecordingHeatmapResponse> get_heatmap(storefront_oid, query)
|
@@ -8243,6 +8171,77 @@ This endpoint does not need any parameter.
|
|
8243
8171
|
- **Accept**: application/json
|
8244
8172
|
|
8245
8173
|
|
8174
|
+
## get_upload_fs_file_url
|
8175
|
+
|
8176
|
+
> <FileManagerUploadUrlResponse> get_upload_fs_file_url(id, extension)
|
8177
|
+
|
8178
|
+
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.
|
8179
|
+
|
8180
|
+
### Examples
|
8181
|
+
|
8182
|
+
```ruby
|
8183
|
+
require 'time'
|
8184
|
+
require 'ultracart_api'
|
8185
|
+
require 'json'
|
8186
|
+
require 'yaml'
|
8187
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
8188
|
+
|
8189
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
8190
|
+
# As such, this might not be the best way to use this object.
|
8191
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
8192
|
+
|
8193
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
8194
|
+
id = 56 # Integer |
|
8195
|
+
extension = 'extension_example' # String |
|
8196
|
+
|
8197
|
+
begin
|
8198
|
+
# 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.
|
8199
|
+
result = api_instance.get_upload_fs_file_url(id, extension)
|
8200
|
+
p result
|
8201
|
+
rescue UltracartClient::ApiError => e
|
8202
|
+
puts "Error when calling StorefrontApi->get_upload_fs_file_url: #{e}"
|
8203
|
+
end
|
8204
|
+
```
|
8205
|
+
|
8206
|
+
#### Using the get_upload_fs_file_url_with_http_info variant
|
8207
|
+
|
8208
|
+
This returns an Array which contains the response data, status code and headers.
|
8209
|
+
|
8210
|
+
> <Array(<FileManagerUploadUrlResponse>, Integer, Hash)> get_upload_fs_file_url_with_http_info(id, extension)
|
8211
|
+
|
8212
|
+
```ruby
|
8213
|
+
begin
|
8214
|
+
# 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.
|
8215
|
+
data, status_code, headers = api_instance.get_upload_fs_file_url_with_http_info(id, extension)
|
8216
|
+
p status_code # => 2xx
|
8217
|
+
p headers # => { ... }
|
8218
|
+
p data # => <FileManagerUploadUrlResponse>
|
8219
|
+
rescue UltracartClient::ApiError => e
|
8220
|
+
puts "Error when calling StorefrontApi->get_upload_fs_file_url_with_http_info: #{e}"
|
8221
|
+
end
|
8222
|
+
```
|
8223
|
+
|
8224
|
+
### Parameters
|
8225
|
+
|
8226
|
+
| Name | Type | Description | Notes |
|
8227
|
+
| ---- | ---- | ----------- | ----- |
|
8228
|
+
| **id** | **Integer** | | |
|
8229
|
+
| **extension** | **String** | | |
|
8230
|
+
|
8231
|
+
### Return type
|
8232
|
+
|
8233
|
+
[**FileManagerUploadUrlResponse**](FileManagerUploadUrlResponse.md)
|
8234
|
+
|
8235
|
+
### Authorization
|
8236
|
+
|
8237
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
8238
|
+
|
8239
|
+
### HTTP request headers
|
8240
|
+
|
8241
|
+
- **Content-Type**: Not defined
|
8242
|
+
- **Accept**: application/json
|
8243
|
+
|
8244
|
+
|
8246
8245
|
## global_unsubscribe
|
8247
8246
|
|
8248
8247
|
> <EmailGlobalUnsubscribeResponse> global_unsubscribe(storefront_oid, unsubscribe)
|
@@ -12311,6 +12310,76 @@ end
|
|
12311
12310
|
- **Accept**: application/json
|
12312
12311
|
|
12313
12312
|
|
12313
|
+
## upload_fs_file
|
12314
|
+
|
12315
|
+
> upload_fs_file(id, upload_request)
|
12316
|
+
|
12317
|
+
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.
|
12318
|
+
|
12319
|
+
### Examples
|
12320
|
+
|
12321
|
+
```ruby
|
12322
|
+
require 'time'
|
12323
|
+
require 'ultracart_api'
|
12324
|
+
require 'json'
|
12325
|
+
require 'yaml'
|
12326
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
12327
|
+
|
12328
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
12329
|
+
# As such, this might not be the best way to use this object.
|
12330
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
12331
|
+
|
12332
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
12333
|
+
id = 56 # Integer |
|
12334
|
+
upload_request = UltracartClient::FileManagerUploadRequest.new # FileManagerUploadRequest | UploadRequest
|
12335
|
+
|
12336
|
+
begin
|
12337
|
+
# 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.
|
12338
|
+
api_instance.upload_fs_file(id, upload_request)
|
12339
|
+
rescue UltracartClient::ApiError => e
|
12340
|
+
puts "Error when calling StorefrontApi->upload_fs_file: #{e}"
|
12341
|
+
end
|
12342
|
+
```
|
12343
|
+
|
12344
|
+
#### Using the upload_fs_file_with_http_info variant
|
12345
|
+
|
12346
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
12347
|
+
|
12348
|
+
> <Array(nil, Integer, Hash)> upload_fs_file_with_http_info(id, upload_request)
|
12349
|
+
|
12350
|
+
```ruby
|
12351
|
+
begin
|
12352
|
+
# 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.
|
12353
|
+
data, status_code, headers = api_instance.upload_fs_file_with_http_info(id, upload_request)
|
12354
|
+
p status_code # => 2xx
|
12355
|
+
p headers # => { ... }
|
12356
|
+
p data # => nil
|
12357
|
+
rescue UltracartClient::ApiError => e
|
12358
|
+
puts "Error when calling StorefrontApi->upload_fs_file_with_http_info: #{e}"
|
12359
|
+
end
|
12360
|
+
```
|
12361
|
+
|
12362
|
+
### Parameters
|
12363
|
+
|
12364
|
+
| Name | Type | Description | Notes |
|
12365
|
+
| ---- | ---- | ----------- | ----- |
|
12366
|
+
| **id** | **Integer** | | |
|
12367
|
+
| **upload_request** | [**FileManagerUploadRequest**](FileManagerUploadRequest.md) | UploadRequest | |
|
12368
|
+
|
12369
|
+
### Return type
|
12370
|
+
|
12371
|
+
nil (empty response body)
|
12372
|
+
|
12373
|
+
### Authorization
|
12374
|
+
|
12375
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
12376
|
+
|
12377
|
+
### HTTP request headers
|
12378
|
+
|
12379
|
+
- **Content-Type**: application/json
|
12380
|
+
- **Accept**: application/json
|
12381
|
+
|
12382
|
+
|
12314
12383
|
## validate_ruler
|
12315
12384
|
|
12316
12385
|
> <RulerValidationResponse> validate_ruler(ruler_validate_request)
|