ultracart_api 4.0.66.rc → 4.0.68.rc

Sign up to get free protection for your applications and to get access to all the features.
@@ -14,6 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
14
14
  | [**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow |
15
15
  | [**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign |
16
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 |
17
18
  | [**create_twilio_account**](StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account |
18
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 |
19
20
  | [**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats |
@@ -24,6 +25,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
24
25
  | [**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard |
25
26
  | [**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign |
26
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 |
27
29
  | [**delete_heatmap**](StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap |
28
30
  | [**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item |
29
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. |
@@ -90,6 +92,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
90
92
  | [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates |
91
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 |
92
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 |
93
96
  | [**get_heatmap**](StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap |
94
97
  | [**get_heatmap_index**](StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index |
95
98
  | [**get_histogram_property_names**](StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names |
@@ -113,6 +116,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
113
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 |
114
117
  | [**get_twilio_account**](StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account |
115
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. |
116
120
  | [**global_unsubscribe**](StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer |
117
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 |
118
122
  | [**insert_email_campaign**](StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign |
@@ -169,6 +173,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
169
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 |
170
174
  | [**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object |
171
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. |
172
177
  | [**validate_ruler**](StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler |
173
178
 
174
179
 
@@ -886,6 +891,81 @@ end
886
891
  - **Accept**: application/json
887
892
 
888
893
 
894
+ ## create_fs_directory
895
+
896
+ > <FileManagerPage> create_fs_directory(id, opts)
897
+
898
+ Create file manager directory
899
+
900
+ ### Examples
901
+
902
+ ```ruby
903
+ require 'time'
904
+ require 'ultracart_api'
905
+ require 'json'
906
+ require 'yaml'
907
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
908
+
909
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
910
+ # As such, this might not be the best way to use this object.
911
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
912
+
913
+ api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
914
+ id = 56 # Integer |
915
+ opts = {
916
+ name: 'name_example', # String |
917
+ parent_storefront_fs_directory_oid: 56 # Integer |
918
+ }
919
+
920
+ begin
921
+ # Create file manager directory
922
+ result = api_instance.create_fs_directory(id, opts)
923
+ p result
924
+ rescue UltracartClient::ApiError => e
925
+ puts "Error when calling StorefrontApi->create_fs_directory: #{e}"
926
+ end
927
+ ```
928
+
929
+ #### Using the create_fs_directory_with_http_info variant
930
+
931
+ This returns an Array which contains the response data, status code and headers.
932
+
933
+ > <Array(<FileManagerPage>, Integer, Hash)> create_fs_directory_with_http_info(id, opts)
934
+
935
+ ```ruby
936
+ begin
937
+ # Create file manager directory
938
+ data, status_code, headers = api_instance.create_fs_directory_with_http_info(id, opts)
939
+ p status_code # => 2xx
940
+ p headers # => { ... }
941
+ p data # => <FileManagerPage>
942
+ rescue UltracartClient::ApiError => e
943
+ puts "Error when calling StorefrontApi->create_fs_directory_with_http_info: #{e}"
944
+ end
945
+ ```
946
+
947
+ ### Parameters
948
+
949
+ | Name | Type | Description | Notes |
950
+ | ---- | ---- | ----------- | ----- |
951
+ | **id** | **Integer** | | |
952
+ | **name** | **String** | | [optional] |
953
+ | **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
954
+
955
+ ### Return type
956
+
957
+ [**FileManagerPage**](FileManagerPage.md)
958
+
959
+ ### Authorization
960
+
961
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
962
+
963
+ ### HTTP request headers
964
+
965
+ - **Content-Type**: Not defined
966
+ - **Accept**: application/json
967
+
968
+
889
969
  ## create_twilio_account
890
970
 
891
971
  > <TwilioResponse> create_twilio_account(twilio)
@@ -1592,6 +1672,81 @@ nil (empty response body)
1592
1672
  - **Accept**: application/json
1593
1673
 
1594
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
+
1595
1750
  ## delete_heatmap
1596
1751
 
1597
1752
  > delete_heatmap(storefront_oid, query)
@@ -6279,6 +6434,83 @@ end
6279
6434
  - **Accept**: application/json
6280
6435
 
6281
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
+
6282
6514
  ## get_heatmap
6283
6515
 
6284
6516
  > <ScreenRecordingHeatmapResponse> get_heatmap(storefront_oid, query)
@@ -7939,6 +8171,77 @@ This endpoint does not need any parameter.
7939
8171
  - **Accept**: application/json
7940
8172
 
7941
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
+
7942
8245
  ## global_unsubscribe
7943
8246
 
7944
8247
  > <EmailGlobalUnsubscribeResponse> global_unsubscribe(storefront_oid, unsubscribe)
@@ -12007,6 +12310,76 @@ end
12007
12310
  - **Accept**: application/json
12008
12311
 
12009
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
+
12010
12383
  ## validate_ruler
12011
12384
 
12012
12385
  > <RulerValidationResponse> validate_ruler(ruler_validate_request)
@@ -300,6 +300,70 @@ module UltracartClient
300
300
  return data, status_code, headers
301
301
  end
302
302
 
303
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
304
+ # 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.
305
+ # @param external_id [String] The external id to match against.
306
+ # @param [Hash] opts the optional parameters
307
+ # @return [ItemDigitalItemsResponse]
308
+ def get_digital_items_by_external_id(external_id, opts = {})
309
+ data, _status_code, _headers = get_digital_items_by_external_id_with_http_info(external_id, opts)
310
+ data
311
+ end
312
+
313
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
314
+ # 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.
315
+ # @param external_id [String] The external id to match against.
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [Array<(ItemDigitalItemsResponse, Integer, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
318
+ def get_digital_items_by_external_id_with_http_info(external_id, opts = {})
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items_by_external_id ...'
321
+ end
322
+ # verify the required parameter 'external_id' is set
323
+ if @api_client.config.client_side_validation && external_id.nil?
324
+ fail ArgumentError, "Missing the required parameter 'external_id' when calling ItemApi.get_digital_items_by_external_id"
325
+ end
326
+ # resource path
327
+ local_var_path = '/item/digital_library/by_external/{external_id}'.sub('{' + 'external_id' + '}', CGI.escape(external_id.to_s))
328
+
329
+ # query parameters
330
+ query_params = opts[:query_params] || {}
331
+
332
+ # header parameters
333
+ header_params = opts[:header_params] || {}
334
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
335
+ # HTTP header 'Accept' (if needed)
336
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
337
+
338
+ # form parameters
339
+ form_params = opts[:form_params] || {}
340
+
341
+ # http body (model)
342
+ post_body = opts[:debug_body]
343
+
344
+ # return_type
345
+ return_type = opts[:debug_return_type] || 'ItemDigitalItemsResponse'
346
+
347
+ # auth_names
348
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
349
+
350
+ new_options = opts.merge(
351
+ :operation => :"ItemApi.get_digital_items_by_external_id",
352
+ :header_params => header_params,
353
+ :query_params => query_params,
354
+ :form_params => form_params,
355
+ :body => post_body,
356
+ :auth_names => auth_names,
357
+ :return_type => return_type
358
+ )
359
+
360
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
361
+ if @api_client.config.debugging
362
+ @api_client.config.logger.debug "API called: ItemApi#get_digital_items_by_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
363
+ end
364
+ return data, status_code, headers
365
+ end
366
+
303
367
  # Retrieve an item
304
368
  # Retrieves a single item using the specified item oid.
305
369
  # @param merchant_item_oid [Integer] The item oid to retrieve.
@@ -583,6 +647,82 @@ module UltracartClient
583
647
  return data, status_code, headers
584
648
  end
585
649
 
650
+ # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
651
+ # 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.
652
+ # @param [Hash] opts the optional parameters
653
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
654
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
655
+ # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
656
+ # @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.
657
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
658
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
659
+ # @return [ItemDigitalItemsResponse]
660
+ def get_unassociated_digital_items(opts = {})
661
+ data, _status_code, _headers = get_unassociated_digital_items_with_http_info(opts)
662
+ data
663
+ end
664
+
665
+ # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
666
+ # 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.
667
+ # @param [Hash] opts the optional parameters
668
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
669
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
670
+ # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
671
+ # @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.
672
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
673
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
674
+ # @return [Array<(ItemDigitalItemsResponse, Integer, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
675
+ def get_unassociated_digital_items_with_http_info(opts = {})
676
+ if @api_client.config.debugging
677
+ @api_client.config.logger.debug 'Calling API: ItemApi.get_unassociated_digital_items ...'
678
+ end
679
+ # resource path
680
+ local_var_path = '/item/digital_library/unassociated'
681
+
682
+ # query parameters
683
+ query_params = opts[:query_params] || {}
684
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
685
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
686
+ query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
687
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
688
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
689
+ query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
690
+
691
+ # header parameters
692
+ header_params = opts[:header_params] || {}
693
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
694
+ # HTTP header 'Accept' (if needed)
695
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
696
+
697
+ # form parameters
698
+ form_params = opts[:form_params] || {}
699
+
700
+ # http body (model)
701
+ post_body = opts[:debug_body]
702
+
703
+ # return_type
704
+ return_type = opts[:debug_return_type] || 'ItemDigitalItemsResponse'
705
+
706
+ # auth_names
707
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
708
+
709
+ new_options = opts.merge(
710
+ :operation => :"ItemApi.get_unassociated_digital_items",
711
+ :header_params => header_params,
712
+ :query_params => query_params,
713
+ :form_params => form_params,
714
+ :body => post_body,
715
+ :auth_names => auth_names,
716
+ :return_type => return_type
717
+ )
718
+
719
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
720
+ if @api_client.config.debugging
721
+ @api_client.config.logger.debug "API called: ItemApi#get_unassociated_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
722
+ end
723
+ return data, status_code, headers
724
+ end
725
+
586
726
  # Create a file within the digital library
587
727
  # 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.
588
728
  # @param digital_item [ItemDigitalItem] Digital item to create