ultracart_api 4.1.183 → 4.1.185
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +40 -2
- data/docs/AutoOrderApi.md +28 -1
- data/docs/OrderApi.md +107 -3
- data/docs/SfvbApi.md +941 -50
- data/docs/SfvbLibraryAiReview.md +28 -0
- data/docs/SfvbLibraryContentManifest.md +26 -0
- data/docs/SfvbLibraryDeleteResult.md +20 -0
- data/docs/SfvbLibraryEntry.md +28 -0
- data/docs/SfvbLibraryEntryRequest.md +30 -0
- data/docs/SfvbLibraryFacet.md +2 -2
- data/docs/SfvbLibraryHistoryEntry.md +24 -0
- data/docs/SfvbLibraryHistoryResponse.md +18 -0
- data/docs/SfvbLibraryInstallConflict.md +22 -0
- data/docs/SfvbLibraryInstallReceipt.md +32 -0
- data/docs/SfvbLibraryInstallRecord.md +32 -0
- data/docs/SfvbLibraryInstallRequest.md +22 -0
- data/docs/SfvbLibraryInstallsResponse.md +18 -0
- data/docs/SfvbLibraryParameter.md +26 -0
- data/docs/SfvbLibraryPublishRequest.md +20 -0
- data/docs/SfvbLibraryScreenshotRequest.md +22 -0
- data/docs/SfvbLibraryShareRequest.md +18 -0
- data/docs/SfvbLibraryShareTarget.md +20 -0
- data/docs/SfvbLibraryShareTargetsResponse.md +18 -0
- data/docs/SfvbLibraryTaxonomy.md +24 -0
- data/docs/SfvbLibraryTaxonomyCatalog.md +18 -0
- data/docs/SfvbLibraryUnshareResult.md +22 -0
- data/docs/SfvbWhoamiResponse.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1334 -118
- data/lib/ultracart_api/models/sfvb_library_ai_review.rb +304 -0
- data/lib/ultracart_api/models/sfvb_library_content_manifest.rb +259 -0
- data/lib/ultracart_api/models/sfvb_library_delete_result.rb +264 -0
- data/lib/ultracart_api/models/sfvb_library_entry.rb +177 -1
- data/lib/ultracart_api/models/sfvb_library_entry_request.rb +280 -0
- data/lib/ultracart_api/models/sfvb_library_facet.rb +2 -2
- data/lib/ultracart_api/models/sfvb_library_history_entry.rb +250 -0
- data/lib/ultracart_api/models/sfvb_library_history_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_install_conflict.rb +240 -0
- data/lib/ultracart_api/models/sfvb_library_install_receipt.rb +297 -0
- data/lib/ultracart_api/models/sfvb_library_install_record.rb +290 -0
- data/lib/ultracart_api/models/sfvb_library_install_request.rb +274 -0
- data/lib/ultracart_api/models/sfvb_library_installs_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_parameter.rb +260 -0
- data/lib/ultracart_api/models/sfvb_library_publish_request.rb +264 -0
- data/lib/ultracart_api/models/sfvb_library_screenshot_request.rb +274 -0
- data/lib/ultracart_api/models/sfvb_library_share_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_library_share_target.rb +230 -0
- data/lib/ultracart_api/models/sfvb_library_share_targets_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_taxonomy.rb +258 -0
- data/lib/ultracart_api/models/sfvb_library_taxonomy_catalog.rb +220 -0
- data/lib/ultracart_api/models/sfvb_library_unshare_result.rb +242 -0
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +20 -0
- metadata +41 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 86b7a31c2fdb79ed422a7453170ecae04ef97d4a4837011901dcad91aa75f34f
|
|
4
|
+
data.tar.gz: ddc0dcab82f022fa9767b190b1c67038cbae1e40b04b86af7b39c4e832e3f7bc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ae9905c86955c3a0c66f6ce939af9d13fb8e63fba6eb35a476428ec9e58b2bd1979cace9a11e41c6f97a13c498b209414a1763bb2dd8e01e8a79ddc5902c5596
|
|
7
|
+
data.tar.gz: 714438367f915197c9de9cf3dbaa7606ad03113834ed635e6e67ee9d44c49fd8c2dea07a569a74033e4fb2a77757139e3108c9d734d53758f68a7f7b33c4c8d0
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.185
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.185'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -480,24 +480,29 @@ Class | Method | HTTP request | Description
|
|
|
480
480
|
*UltracartClient::SfvbApi* | [**add_sfvb_page_items**](docs/SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page
|
|
481
481
|
*UltracartClient::SfvbApi* | [**archive_sfvb_upsell_path**](docs/SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path
|
|
482
482
|
*UltracartClient::SfvbApi* | [**attach_sfvb_blog_post_image**](docs/SfvbApi.md#attach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/attach | Attach an image to a blog post
|
|
483
|
+
*UltracartClient::SfvbApi* | [**clear_sfvb_library_screenshot**](docs/SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot
|
|
483
484
|
*UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
|
|
485
|
+
*UltracartClient::SfvbApi* | [**create_sfvb_library_entry**](docs/SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library
|
|
484
486
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
|
|
485
487
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
486
488
|
*UltracartClient::SfvbApi* | [**delete_sfvb_blog_post**](docs/SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post
|
|
487
489
|
*UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
|
|
488
490
|
*UltracartClient::SfvbApi* | [**delete_sfvb_item_attribute**](docs/SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item
|
|
489
491
|
*UltracartClient::SfvbApi* | [**delete_sfvb_item_multimedia**](docs/SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item
|
|
492
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_library_entry**](docs/SfvbApi.md#delete_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Delete or retire a library entry
|
|
490
493
|
*UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
|
|
491
494
|
*UltracartClient::SfvbApi* | [**delete_sfvb_preview_session**](docs/SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session
|
|
492
495
|
*UltracartClient::SfvbApi* | [**detach_sfvb_blog_post_image**](docs/SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post
|
|
493
496
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_offer**](docs/SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer
|
|
494
497
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_path**](docs/SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path
|
|
495
498
|
*UltracartClient::SfvbApi* | [**download_sfvb_file**](docs/SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes
|
|
499
|
+
*UltracartClient::SfvbApi* | [**duplicate_sfvb_library_entry**](docs/SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry
|
|
496
500
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_page**](docs/SfvbApi.md#duplicate_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/duplicate | Copy a page to a new path
|
|
497
501
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_theme**](docs/SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme
|
|
498
502
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_upsell_offer**](docs/SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer
|
|
499
503
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_upsell_path**](docs/SfvbApi.md#duplicate_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/duplicate | Duplicate an upsell path or one of its variations
|
|
500
504
|
*UltracartClient::SfvbApi* | [**end_sfvb_experiment**](docs/SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment
|
|
505
|
+
*UltracartClient::SfvbApi* | [**favorite_sfvb_library_entry**](docs/SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry
|
|
501
506
|
*UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
|
|
502
507
|
*UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
|
|
503
508
|
*UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
|
|
@@ -509,6 +514,9 @@ Class | Method | HTTP request | Description
|
|
|
509
514
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
|
|
510
515
|
*UltracartClient::SfvbApi* | [**get_sfvb_item**](docs/SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content
|
|
511
516
|
*UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
|
|
517
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_library_history**](docs/SfvbApi.md#get_sfvb_library_history) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/history | List a library entry's published revisions
|
|
518
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_library_share_targets**](docs/SfvbApi.md#get_sfvb_library_share_targets) | **GET** /sfvb/storefronts/{storefront_oid}/library/share_targets | List the accounts a library entry can be shared with
|
|
519
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_library_taxonomy**](docs/SfvbApi.md#get_sfvb_library_taxonomy) | **GET** /sfvb/storefronts/{storefront_oid}/library/taxonomy | List the allowed library tags
|
|
512
520
|
*UltracartClient::SfvbApi* | [**get_sfvb_menu**](docs/SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries
|
|
513
521
|
*UltracartClient::SfvbApi* | [**get_sfvb_menus**](docs/SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus
|
|
514
522
|
*UltracartClient::SfvbApi* | [**get_sfvb_page**](docs/SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images
|
|
@@ -540,6 +548,7 @@ Class | Method | HTTP request | Description
|
|
|
540
548
|
*UltracartClient::SfvbApi* | [**list_sfvb_file_versions**](docs/SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file
|
|
541
549
|
*UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
|
|
542
550
|
*UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
|
|
551
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_library_installs**](docs/SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront
|
|
543
552
|
*UltracartClient::SfvbApi* | [**list_sfvb_pages**](docs/SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages
|
|
544
553
|
*UltracartClient::SfvbApi* | [**list_sfvb_server_logs**](docs/SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs
|
|
545
554
|
*UltracartClient::SfvbApi* | [**list_sfvb_storefronts**](docs/SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts
|
|
@@ -548,6 +557,7 @@ Class | Method | HTTP request | Description
|
|
|
548
557
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
|
|
549
558
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_paths**](docs/SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths
|
|
550
559
|
*UltracartClient::SfvbApi* | [**move_sfvb_upsell_path**](docs/SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path
|
|
560
|
+
*UltracartClient::SfvbApi* | [**publish_sfvb_library_entry**](docs/SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft
|
|
551
561
|
*UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
|
|
552
562
|
*UltracartClient::SfvbApi* | [**put_sfvb_experiment_variation**](docs/SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation
|
|
553
563
|
*UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
|
|
@@ -574,9 +584,15 @@ Class | Method | HTTP request | Description
|
|
|
574
584
|
*UltracartClient::SfvbApi* | [**revert_sfvb_file**](docs/SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version
|
|
575
585
|
*UltracartClient::SfvbApi* | [**search_sfvb_files**](docs/SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files
|
|
576
586
|
*UltracartClient::SfvbApi* | [**search_sfvb_library**](docs/SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library
|
|
587
|
+
*UltracartClient::SfvbApi* | [**set_sfvb_library_screenshot**](docs/SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot
|
|
588
|
+
*UltracartClient::SfvbApi* | [**share_sfvb_library_entry**](docs/SfvbApi.md#share_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares | Share a published library entry with a linked account
|
|
577
589
|
*UltracartClient::SfvbApi* | [**start_sfvb_experiment**](docs/SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment
|
|
578
590
|
*UltracartClient::SfvbApi* | [**unarchive_sfvb_upsell_path**](docs/SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path
|
|
591
|
+
*UltracartClient::SfvbApi* | [**unfavorite_sfvb_library_entry**](docs/SfvbApi.md#unfavorite_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Remove a library entry from favorites
|
|
592
|
+
*UltracartClient::SfvbApi* | [**unpublish_sfvb_library_entry**](docs/SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry
|
|
593
|
+
*UltracartClient::SfvbApi* | [**unshare_sfvb_library_entry**](docs/SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account
|
|
579
594
|
*UltracartClient::SfvbApi* | [**update_sfvb_blog_post**](docs/SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post
|
|
595
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
|
|
580
596
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_offer**](docs/SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer
|
|
581
597
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_path**](docs/SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path
|
|
582
598
|
*UltracartClient::SfvbApi* | [**upload_sfvb_file**](docs/SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded
|
|
@@ -1857,9 +1873,29 @@ Class | Method | HTTP request | Description
|
|
|
1857
1873
|
- [UltracartClient::SfvbItemResponse](docs/SfvbItemResponse.md)
|
|
1858
1874
|
- [UltracartClient::SfvbItemSeo](docs/SfvbItemSeo.md)
|
|
1859
1875
|
- [UltracartClient::SfvbItemSeoRequest](docs/SfvbItemSeoRequest.md)
|
|
1876
|
+
- [UltracartClient::SfvbLibraryAiReview](docs/SfvbLibraryAiReview.md)
|
|
1877
|
+
- [UltracartClient::SfvbLibraryContentManifest](docs/SfvbLibraryContentManifest.md)
|
|
1878
|
+
- [UltracartClient::SfvbLibraryDeleteResult](docs/SfvbLibraryDeleteResult.md)
|
|
1860
1879
|
- [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
|
|
1880
|
+
- [UltracartClient::SfvbLibraryEntryRequest](docs/SfvbLibraryEntryRequest.md)
|
|
1861
1881
|
- [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
|
|
1882
|
+
- [UltracartClient::SfvbLibraryHistoryEntry](docs/SfvbLibraryHistoryEntry.md)
|
|
1883
|
+
- [UltracartClient::SfvbLibraryHistoryResponse](docs/SfvbLibraryHistoryResponse.md)
|
|
1884
|
+
- [UltracartClient::SfvbLibraryInstallConflict](docs/SfvbLibraryInstallConflict.md)
|
|
1885
|
+
- [UltracartClient::SfvbLibraryInstallReceipt](docs/SfvbLibraryInstallReceipt.md)
|
|
1886
|
+
- [UltracartClient::SfvbLibraryInstallRecord](docs/SfvbLibraryInstallRecord.md)
|
|
1887
|
+
- [UltracartClient::SfvbLibraryInstallRequest](docs/SfvbLibraryInstallRequest.md)
|
|
1888
|
+
- [UltracartClient::SfvbLibraryInstallsResponse](docs/SfvbLibraryInstallsResponse.md)
|
|
1889
|
+
- [UltracartClient::SfvbLibraryParameter](docs/SfvbLibraryParameter.md)
|
|
1890
|
+
- [UltracartClient::SfvbLibraryPublishRequest](docs/SfvbLibraryPublishRequest.md)
|
|
1862
1891
|
- [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
|
|
1892
|
+
- [UltracartClient::SfvbLibraryScreenshotRequest](docs/SfvbLibraryScreenshotRequest.md)
|
|
1893
|
+
- [UltracartClient::SfvbLibraryShareRequest](docs/SfvbLibraryShareRequest.md)
|
|
1894
|
+
- [UltracartClient::SfvbLibraryShareTarget](docs/SfvbLibraryShareTarget.md)
|
|
1895
|
+
- [UltracartClient::SfvbLibraryShareTargetsResponse](docs/SfvbLibraryShareTargetsResponse.md)
|
|
1896
|
+
- [UltracartClient::SfvbLibraryTaxonomy](docs/SfvbLibraryTaxonomy.md)
|
|
1897
|
+
- [UltracartClient::SfvbLibraryTaxonomyCatalog](docs/SfvbLibraryTaxonomyCatalog.md)
|
|
1898
|
+
- [UltracartClient::SfvbLibraryUnshareResult](docs/SfvbLibraryUnshareResult.md)
|
|
1863
1899
|
- [UltracartClient::SfvbMenu](docs/SfvbMenu.md)
|
|
1864
1900
|
- [UltracartClient::SfvbMenuItem](docs/SfvbMenuItem.md)
|
|
1865
1901
|
- [UltracartClient::SfvbMenuWriteRequest](docs/SfvbMenuWriteRequest.md)
|
|
@@ -2115,6 +2151,8 @@ Not every change is committed to every SDK.
|
|
|
2115
2151
|
|
|
2116
2152
|
| Version | Date | Comments |
|
|
2117
2153
|
| --: | :-: | --- |
|
|
2154
|
+
| 4.1.185 | 10/05/2026 | sfvb internal testing |
|
|
2155
|
+
| 4.1.184 | 10/05/2026 | sfvb internal testing |
|
|
2118
2156
|
| 4.1.183 | 10/05/2026 | OrderApi rma endpoints |
|
|
2119
2157
|
| 4.1.182 | 10/02/2026 | sfvb internal testing |
|
|
2120
2158
|
| 4.1.181 | 10/02/2026 | sfvb internal testing |
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -775,8 +775,35 @@ Generates the url a customer can use to update the billing information on this a
|
|
|
775
775
|
|
|
776
776
|
### Examples
|
|
777
777
|
|
|
778
|
+
```ruby
|
|
779
|
+
require 'ultracart_api'
|
|
780
|
+
require_relative '../constants'
|
|
778
781
|
|
|
779
|
-
(
|
|
782
|
+
# AutoOrderApi.get_auto_order_update_billing_url() generates the url a customer can use to update the
|
|
783
|
+
# billing information on an auto order. This is the same url sent in the auto order update billing email.
|
|
784
|
+
# Requires the auto_order_write permission, because the url carries a customer access token.
|
|
785
|
+
|
|
786
|
+
auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY)
|
|
787
|
+
|
|
788
|
+
auto_order_oid = 123456789 # If you don't know the oid, use getAutoOrdersByQuery for retrieving auto orders
|
|
789
|
+
|
|
790
|
+
begin
|
|
791
|
+
api_response = auto_order_api.get_auto_order_update_billing_url(auto_order_oid)
|
|
792
|
+
|
|
793
|
+
# Check for errors
|
|
794
|
+
if api_response.error
|
|
795
|
+
puts "Developer Message: #{api_response.error.developer_message}"
|
|
796
|
+
puts "User Message: #{api_response.error.user_message}"
|
|
797
|
+
exit
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
# WARNING: The update billing url is sensitive. It grants access to the customer's billing information.
|
|
801
|
+
# Do not log it or expose it publicly in production. Deliver it only to the customer who owns the auto order.
|
|
802
|
+
puts "Update billing url: #{api_response.update_billing_url}"
|
|
803
|
+
rescue StandardError => e
|
|
804
|
+
puts "An error occurred: #{e.message}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
780
807
|
|
|
781
808
|
|
|
782
809
|
#### Using the get_auto_order_update_billing_url_with_http_info variant
|
data/docs/OrderApi.md
CHANGED
|
@@ -139,8 +139,46 @@ Associates an RMA number with an order. Any existing RMA on the order is replac
|
|
|
139
139
|
|
|
140
140
|
### Examples
|
|
141
141
|
|
|
142
|
+
```ruby
|
|
143
|
+
require 'ultracart_api'
|
|
144
|
+
require_relative '../constants'
|
|
142
145
|
|
|
143
|
-
(
|
|
146
|
+
# OrderApi.assign_rma() associates an RMA (return merchandise authorization) number with an order.
|
|
147
|
+
# The rma is required, may be at most 30 characters, and is trimmed of whitespace.
|
|
148
|
+
# Any existing RMA on the order is replaced, and a merchant note is added to the order recording the change.
|
|
149
|
+
# The optional _expand parameter controls how much of the updated order is returned.
|
|
150
|
+
# Requires the order_write permission.
|
|
151
|
+
|
|
152
|
+
order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
|
|
153
|
+
|
|
154
|
+
order_id = 'DEMO-0009104390'
|
|
155
|
+
|
|
156
|
+
assign_rma_request = UltracartClient::OrderAssignRmaRequest.new
|
|
157
|
+
assign_rma_request.rma = 'RMA-12345'
|
|
158
|
+
|
|
159
|
+
# see www.ultracart.com/api/ for all the expansion fields available
|
|
160
|
+
opts = {
|
|
161
|
+
'_expand' => 'item,summary'
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
begin
|
|
165
|
+
api_response = order_api.assign_rma(order_id, assign_rma_request, opts)
|
|
166
|
+
|
|
167
|
+
# Check for errors
|
|
168
|
+
if api_response.error
|
|
169
|
+
puts "Developer Message: #{api_response.error.developer_message}"
|
|
170
|
+
puts "User Message: #{api_response.error.user_message}"
|
|
171
|
+
exit
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
order = api_response.order
|
|
175
|
+
|
|
176
|
+
puts "RMA #{assign_rma_request.rma} assigned to order #{order.order_id}"
|
|
177
|
+
puts order.inspect
|
|
178
|
+
rescue StandardError => e
|
|
179
|
+
puts "An error occurred: #{e.message}"
|
|
180
|
+
end
|
|
181
|
+
```
|
|
144
182
|
|
|
145
183
|
|
|
146
184
|
#### Using the assign_rma_with_http_info variant
|
|
@@ -2257,8 +2295,45 @@ Retrieves the orders associated with the specified RMA number. The RMA must be
|
|
|
2257
2295
|
|
|
2258
2296
|
### Examples
|
|
2259
2297
|
|
|
2298
|
+
```ruby
|
|
2299
|
+
require 'ultracart_api'
|
|
2300
|
+
require_relative '../constants'
|
|
2301
|
+
|
|
2302
|
+
# OrderApi.get_orders_by_rma() retrieves the orders associated with an RMA number.
|
|
2303
|
+
# The RMA must be an exact match; wildcards such as * are not permitted and will return a 400 error.
|
|
2304
|
+
# Multiple orders can share the same RMA, so this call returns a list of orders.
|
|
2305
|
+
# This lookup is backed by a search index, so an RMA that was just assigned may take a short time to appear.
|
|
2306
|
+
# Requires the order_read permission.
|
|
2260
2307
|
|
|
2261
|
-
|
|
2308
|
+
order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
|
|
2309
|
+
|
|
2310
|
+
rma = 'RMA-12345'
|
|
2311
|
+
|
|
2312
|
+
# see www.ultracart.com/api/ for all the expansion fields available
|
|
2313
|
+
opts = {
|
|
2314
|
+
'_expand' => 'item,summary,billing,shipping'
|
|
2315
|
+
}
|
|
2316
|
+
|
|
2317
|
+
begin
|
|
2318
|
+
api_response = order_api.get_orders_by_rma(rma, opts)
|
|
2319
|
+
|
|
2320
|
+
# Check for errors
|
|
2321
|
+
if api_response.error
|
|
2322
|
+
puts "Developer Message: #{api_response.error.developer_message}"
|
|
2323
|
+
puts "User Message: #{api_response.error.user_message}"
|
|
2324
|
+
exit
|
|
2325
|
+
end
|
|
2326
|
+
|
|
2327
|
+
orders = api_response.orders
|
|
2328
|
+
|
|
2329
|
+
puts "Found #{orders.length} order(s) with RMA #{rma}"
|
|
2330
|
+
orders.each do |order|
|
|
2331
|
+
puts order.inspect
|
|
2332
|
+
end
|
|
2333
|
+
rescue StandardError => e
|
|
2334
|
+
puts "An error occurred: #{e.message}"
|
|
2335
|
+
end
|
|
2336
|
+
```
|
|
2262
2337
|
|
|
2263
2338
|
|
|
2264
2339
|
#### Using the get_orders_by_rma_with_http_info variant
|
|
@@ -2311,8 +2386,37 @@ Generates the url a customer can use to update the billing information on the au
|
|
|
2311
2386
|
|
|
2312
2387
|
### Examples
|
|
2313
2388
|
|
|
2389
|
+
```ruby
|
|
2390
|
+
require 'ultracart_api'
|
|
2391
|
+
require_relative '../constants'
|
|
2314
2392
|
|
|
2315
|
-
(
|
|
2393
|
+
# OrderApi.get_update_billing_url() generates the url a customer can use to update the billing information
|
|
2394
|
+
# on the auto order associated with an order. This is the same url sent in the auto order update billing email.
|
|
2395
|
+
# The order must belong to an auto order, otherwise a 400 error is returned. Either the original order
|
|
2396
|
+
# or any rebill order of the auto order may be used.
|
|
2397
|
+
# Requires the order_write permission, because the url carries a customer access token.
|
|
2398
|
+
|
|
2399
|
+
order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
|
|
2400
|
+
|
|
2401
|
+
order_id = 'DEMO-0009104390'
|
|
2402
|
+
|
|
2403
|
+
begin
|
|
2404
|
+
api_response = order_api.get_update_billing_url(order_id)
|
|
2405
|
+
|
|
2406
|
+
# Check for errors
|
|
2407
|
+
if api_response.error
|
|
2408
|
+
puts "Developer Message: #{api_response.error.developer_message}"
|
|
2409
|
+
puts "User Message: #{api_response.error.user_message}"
|
|
2410
|
+
exit
|
|
2411
|
+
end
|
|
2412
|
+
|
|
2413
|
+
# WARNING: The update billing url is sensitive. It grants access to the customer's billing information.
|
|
2414
|
+
# Do not log it or expose it publicly in production. Deliver it only to the customer who owns the auto order.
|
|
2415
|
+
puts "Update billing url: #{api_response.update_billing_url}"
|
|
2416
|
+
rescue StandardError => e
|
|
2417
|
+
puts "An error occurred: #{e.message}"
|
|
2418
|
+
end
|
|
2419
|
+
```
|
|
2316
2420
|
|
|
2317
2421
|
|
|
2318
2422
|
#### Using the get_update_billing_url_with_http_info variant
|