ultracart_api 4.1.137 → 4.1.140
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 +86 -2
- data/docs/ConversationApi.md +52 -0
- data/docs/ConversationPbxPayConnector.md +32 -0
- data/docs/ConversationPbxPayConnectorsResponse.md +26 -0
- data/docs/SfvbApi.md +1933 -0
- data/docs/SfvbCompileRequest.md +26 -0
- data/docs/SfvbCompileResponse.md +28 -0
- data/docs/SfvbContainerResponse.md +36 -0
- data/docs/SfvbContainerRevertRequest.md +20 -0
- data/docs/SfvbContainerVersion.md +40 -0
- data/docs/SfvbContainerVersionsResponse.md +18 -0
- data/docs/SfvbContainerWriteRequest.md +24 -0
- data/docs/SfvbElement.md +20 -0
- data/docs/SfvbElementSchemaResponse.md +20 -0
- data/docs/SfvbElementsResponse.md +22 -0
- data/docs/SfvbErrorDetail.md +36 -0
- data/docs/SfvbFileContentResponse.md +38 -0
- data/docs/SfvbFileEntry.md +46 -0
- data/docs/SfvbFileRevertRequest.md +22 -0
- data/docs/SfvbFileSearchRequest.md +48 -0
- data/docs/SfvbFileSearchResponse.md +32 -0
- data/docs/SfvbFileVersion.md +34 -0
- data/docs/SfvbFileVersionsResponse.md +22 -0
- data/docs/SfvbFileWriteRequest.md +22 -0
- data/docs/SfvbFileWriteResponse.md +28 -0
- data/docs/SfvbFilesResponse.md +28 -0
- data/docs/SfvbLibraryEntry.md +38 -0
- data/docs/SfvbLibraryFacet.md +22 -0
- data/docs/SfvbLibraryResponse.md +28 -0
- data/docs/SfvbPreviewSessionRequest.md +20 -0
- data/docs/SfvbPreviewSessionResponse.md +30 -0
- data/docs/SfvbPreviewUrlResponse.md +30 -0
- data/docs/SfvbRenderRequest.md +40 -0
- data/docs/SfvbRenderResponse.md +28 -0
- data/docs/SfvbStorefront.md +22 -0
- data/docs/SfvbStorefrontsResponse.md +18 -0
- data/docs/SfvbTheme.md +36 -0
- data/docs/SfvbThemeDuplicateRequest.md +22 -0
- data/docs/SfvbThemeJobResponse.md +40 -0
- data/docs/SfvbThemesResponse.md +20 -0
- data/docs/SfvbUpsellOffer.md +34 -0
- data/docs/SfvbUpsellOffersResponse.md +18 -0
- data/docs/SfvbValidateRequest.md +26 -0
- data/docs/SfvbValidationResponse.md +24 -0
- data/docs/SfvbVelocityValidateRequest.md +20 -0
- data/docs/SfvbVersionResponse.md +36 -0
- data/docs/SfvbWhoamiResponse.md +36 -0
- data/docs/SfvbWidgetIdsResponse.md +22 -0
- data/lib/ultracart_api/api/conversation_api.rb +58 -0
- data/lib/ultracart_api/api/sfvb_api.rb +2565 -0
- data/lib/ultracart_api/models/conversation_pbx_pay_connector.rb +426 -0
- data/lib/ultracart_api/models/conversation_pbx_pay_connectors_response.rb +258 -0
- data/lib/ultracart_api/models/sfvb_compile_request.rb +260 -0
- data/lib/ultracart_api/models/sfvb_compile_response.rb +273 -0
- data/lib/ultracart_api/models/sfvb_container_response.rb +344 -0
- data/lib/ultracart_api/models/sfvb_container_revert_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_container_version.rb +376 -0
- data/lib/ultracart_api/models/sfvb_container_versions_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_container_write_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_element.rb +230 -0
- data/lib/ultracart_api/models/sfvb_element_schema_response.rb +230 -0
- data/lib/ultracart_api/models/sfvb_elements_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_error_detail.rb +346 -0
- data/lib/ultracart_api/models/sfvb_file_content_response.rb +320 -0
- data/lib/ultracart_api/models/sfvb_file_entry.rb +360 -0
- data/lib/ultracart_api/models/sfvb_file_revert_request.rb +240 -0
- data/lib/ultracart_api/models/sfvb_file_search_request.rb +370 -0
- data/lib/ultracart_api/models/sfvb_file_search_response.rb +292 -0
- data/lib/ultracart_api/models/sfvb_file_version.rb +300 -0
- data/lib/ultracart_api/models/sfvb_file_versions_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_file_write_request.rb +240 -0
- data/lib/ultracart_api/models/sfvb_file_write_response.rb +268 -0
- data/lib/ultracart_api/models/sfvb_files_response.rb +272 -0
- data/lib/ultracart_api/models/sfvb_library_entry.rb +322 -0
- data/lib/ultracart_api/models/sfvb_library_facet.rb +242 -0
- data/lib/ultracart_api/models/sfvb_library_response.rb +274 -0
- data/lib/ultracart_api/models/sfvb_preview_session_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_preview_session_response.rb +284 -0
- data/lib/ultracart_api/models/sfvb_preview_url_response.rb +280 -0
- data/lib/ultracart_api/models/sfvb_render_request.rb +330 -0
- data/lib/ultracart_api/models/sfvb_render_response.rb +274 -0
- data/lib/ultracart_api/models/sfvb_storefront.rb +240 -0
- data/lib/ultracart_api/models/sfvb_storefronts_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_theme.rb +310 -0
- data/lib/ultracart_api/models/sfvb_theme_duplicate_request.rb +240 -0
- data/lib/ultracart_api/models/sfvb_theme_job_response.rb +364 -0
- data/lib/ultracart_api/models/sfvb_themes_response.rb +232 -0
- data/lib/ultracart_api/models/sfvb_upsell_offer.rb +300 -0
- data/lib/ultracart_api/models/sfvb_upsell_offers_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_validate_request.rb +294 -0
- data/lib/ultracart_api/models/sfvb_validation_response.rb +256 -0
- data/lib/ultracart_api/models/sfvb_velocity_validate_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_version_response.rb +344 -0
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +314 -0
- data/lib/ultracart_api/models/sfvb_widget_ids_response.rb +242 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +46 -0
- metadata +94 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bcdc3b354754da2c491b5b7d9af9979b8856f67c4531520dc6283d9d1885176b
|
|
4
|
+
data.tar.gz: c90371f1862973695b52984023e108e5707ba6ec6ebceb6784a71e4004f6b0e5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f5bbcf0e361be5e4d5b99eae547067b5202f7ce4587c5217d9f61b584def30528b733407eeec07aac6def0a3b9f502826dd0de85462d3ae6b74b66baec88c3c2
|
|
7
|
+
data.tar.gz: 369920399ef1e1015742e9b3a80b04842ab3eb4bae9b0bcad9f6d4f2c261660fd5af6652f95469251a7a42d2dd04a1fae5d5373059f8bf28803732c87c16fd8a
|
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.140
|
|
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.140'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -218,6 +218,7 @@ Class | Method | HTTP request | Description
|
|
|
218
218
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
|
|
219
219
|
*UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
|
|
220
220
|
*UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
|
|
221
|
+
*UltracartClient::ConversationApi* | [**get_pbx_pay_connectors**](docs/ConversationApi.md#get_pbx_pay_connectors) | **GET** /conversation/pbx/pay_connector | Get pbx pay connectors
|
|
221
222
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
|
222
223
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
|
223
224
|
*UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
|
@@ -469,6 +470,41 @@ Class | Method | HTTP request | Description
|
|
|
469
470
|
*UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
|
|
470
471
|
*UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
|
|
471
472
|
*UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
|
|
473
|
+
*UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
|
|
474
|
+
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
475
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
|
|
476
|
+
*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
|
|
477
|
+
*UltracartClient::SfvbApi* | [**duplicate_sfvb_theme**](docs/SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme
|
|
478
|
+
*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
|
|
479
|
+
*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
|
|
480
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry
|
|
481
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema for one element type
|
|
482
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
483
|
+
*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
|
|
484
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
|
|
485
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
486
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_theme_job**](docs/SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job
|
|
487
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
|
|
488
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
|
|
489
|
+
*UltracartClient::SfvbApi* | [**install_sfvb_library_entry**](docs/SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront
|
|
490
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_container_versions**](docs/SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system
|
|
491
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
|
|
492
|
+
*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
|
|
493
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
|
|
494
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_storefronts**](docs/SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts
|
|
495
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
|
|
496
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
|
|
497
|
+
*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
|
|
498
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
|
|
499
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
|
|
500
|
+
*UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
|
|
501
|
+
*UltracartClient::SfvbApi* | [**reserve_sfvb_widget_ids**](docs/SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids
|
|
502
|
+
*UltracartClient::SfvbApi* | [**revert_sfvb_container**](docs/SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system
|
|
503
|
+
*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
|
|
504
|
+
*UltracartClient::SfvbApi* | [**search_sfvb_files**](docs/SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files
|
|
505
|
+
*UltracartClient::SfvbApi* | [**search_sfvb_library**](docs/SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library
|
|
506
|
+
*UltracartClient::SfvbApi* | [**validate_sfvb_cjson**](docs/SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON
|
|
507
|
+
*UltracartClient::SfvbApi* | [**validate_sfvb_velocity**](docs/SfvbApi.md#validate_sfvb_velocity) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/velocity/validate | Validate a Velocity template against a theme
|
|
472
508
|
*UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
|
|
473
509
|
*UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
|
|
474
510
|
*UltracartClient::SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
|
|
@@ -1001,6 +1037,8 @@ Class | Method | HTTP request | Description
|
|
|
1001
1037
|
- [UltracartClient::ConversationPbxMenuMapping](docs/ConversationPbxMenuMapping.md)
|
|
1002
1038
|
- [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
|
|
1003
1039
|
- [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
|
|
1040
|
+
- [UltracartClient::ConversationPbxPayConnector](docs/ConversationPbxPayConnector.md)
|
|
1041
|
+
- [UltracartClient::ConversationPbxPayConnectorsResponse](docs/ConversationPbxPayConnectorsResponse.md)
|
|
1004
1042
|
- [UltracartClient::ConversationPbxPhoneManufacturer](docs/ConversationPbxPhoneManufacturer.md)
|
|
1005
1043
|
- [UltracartClient::ConversationPbxPhoneManufacturersResponse](docs/ConversationPbxPhoneManufacturersResponse.md)
|
|
1006
1044
|
- [UltracartClient::ConversationPbxPhoneModel](docs/ConversationPbxPhoneModel.md)
|
|
@@ -1678,6 +1716,49 @@ Class | Method | HTTP request | Description
|
|
|
1678
1716
|
- [UltracartClient::ScreenRecordingUserProperty](docs/ScreenRecordingUserProperty.md)
|
|
1679
1717
|
- [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
|
|
1680
1718
|
- [UltracartClient::SelfConfig](docs/SelfConfig.md)
|
|
1719
|
+
- [UltracartClient::SfvbCompileRequest](docs/SfvbCompileRequest.md)
|
|
1720
|
+
- [UltracartClient::SfvbCompileResponse](docs/SfvbCompileResponse.md)
|
|
1721
|
+
- [UltracartClient::SfvbContainerResponse](docs/SfvbContainerResponse.md)
|
|
1722
|
+
- [UltracartClient::SfvbContainerRevertRequest](docs/SfvbContainerRevertRequest.md)
|
|
1723
|
+
- [UltracartClient::SfvbContainerVersion](docs/SfvbContainerVersion.md)
|
|
1724
|
+
- [UltracartClient::SfvbContainerVersionsResponse](docs/SfvbContainerVersionsResponse.md)
|
|
1725
|
+
- [UltracartClient::SfvbContainerWriteRequest](docs/SfvbContainerWriteRequest.md)
|
|
1726
|
+
- [UltracartClient::SfvbElement](docs/SfvbElement.md)
|
|
1727
|
+
- [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
|
|
1728
|
+
- [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
|
|
1729
|
+
- [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
|
|
1730
|
+
- [UltracartClient::SfvbFileContentResponse](docs/SfvbFileContentResponse.md)
|
|
1731
|
+
- [UltracartClient::SfvbFileEntry](docs/SfvbFileEntry.md)
|
|
1732
|
+
- [UltracartClient::SfvbFileRevertRequest](docs/SfvbFileRevertRequest.md)
|
|
1733
|
+
- [UltracartClient::SfvbFileSearchRequest](docs/SfvbFileSearchRequest.md)
|
|
1734
|
+
- [UltracartClient::SfvbFileSearchResponse](docs/SfvbFileSearchResponse.md)
|
|
1735
|
+
- [UltracartClient::SfvbFileVersion](docs/SfvbFileVersion.md)
|
|
1736
|
+
- [UltracartClient::SfvbFileVersionsResponse](docs/SfvbFileVersionsResponse.md)
|
|
1737
|
+
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
1738
|
+
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
1739
|
+
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
1740
|
+
- [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
|
|
1741
|
+
- [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
|
|
1742
|
+
- [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
|
|
1743
|
+
- [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
|
|
1744
|
+
- [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
|
|
1745
|
+
- [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
|
|
1746
|
+
- [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
|
|
1747
|
+
- [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
|
|
1748
|
+
- [UltracartClient::SfvbStorefront](docs/SfvbStorefront.md)
|
|
1749
|
+
- [UltracartClient::SfvbStorefrontsResponse](docs/SfvbStorefrontsResponse.md)
|
|
1750
|
+
- [UltracartClient::SfvbTheme](docs/SfvbTheme.md)
|
|
1751
|
+
- [UltracartClient::SfvbThemeDuplicateRequest](docs/SfvbThemeDuplicateRequest.md)
|
|
1752
|
+
- [UltracartClient::SfvbThemeJobResponse](docs/SfvbThemeJobResponse.md)
|
|
1753
|
+
- [UltracartClient::SfvbThemesResponse](docs/SfvbThemesResponse.md)
|
|
1754
|
+
- [UltracartClient::SfvbUpsellOffer](docs/SfvbUpsellOffer.md)
|
|
1755
|
+
- [UltracartClient::SfvbUpsellOffersResponse](docs/SfvbUpsellOffersResponse.md)
|
|
1756
|
+
- [UltracartClient::SfvbValidateRequest](docs/SfvbValidateRequest.md)
|
|
1757
|
+
- [UltracartClient::SfvbValidationResponse](docs/SfvbValidationResponse.md)
|
|
1758
|
+
- [UltracartClient::SfvbVelocityValidateRequest](docs/SfvbVelocityValidateRequest.md)
|
|
1759
|
+
- [UltracartClient::SfvbVersionResponse](docs/SfvbVersionResponse.md)
|
|
1760
|
+
- [UltracartClient::SfvbWhoamiResponse](docs/SfvbWhoamiResponse.md)
|
|
1761
|
+
- [UltracartClient::SfvbWidgetIdsResponse](docs/SfvbWidgetIdsResponse.md)
|
|
1681
1762
|
- [UltracartClient::SimpleValue](docs/SimpleValue.md)
|
|
1682
1763
|
- [UltracartClient::SingleSignOnAuthorizeRequest](docs/SingleSignOnAuthorizeRequest.md)
|
|
1683
1764
|
- [UltracartClient::SingleSignOnAuthorizeResponse](docs/SingleSignOnAuthorizeResponse.md)
|
|
@@ -1841,6 +1922,9 @@ Not every change is committed to every SDK.
|
|
|
1841
1922
|
|
|
1842
1923
|
| Version | Date | Comments |
|
|
1843
1924
|
| --: | :-: | --- |
|
|
1925
|
+
| 4.1.140 | 08/26/2026 | sfvb - internal testing |
|
|
1926
|
+
| 4.1.139 | 08/26/2026 | sfvb - internal testing |
|
|
1927
|
+
| 4.1.138 | 08/26/2026 | sfvb - internal testing |
|
|
1844
1928
|
| 4.1.137 | 08/24/2026 | order api - arbitrary pricing tier for order creation |
|
|
1845
1929
|
| 4.1.136 | 08/24/2026 | customer api - adjust method for loyalty points |
|
|
1846
1930
|
| 4.1.135 | 08/21/2026 | conversation pbx - support send text operation as a menu item froma different phone number |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -73,6 +73,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
73
73
|
| [**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones |
|
|
74
74
|
| [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu |
|
|
75
75
|
| [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus |
|
|
76
|
+
| [**get_pbx_pay_connectors**](ConversationApi.md#get_pbx_pay_connectors) | **GET** /conversation/pbx/pay_connector | Get pbx pay connectors |
|
|
76
77
|
| [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber |
|
|
77
78
|
| [**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers |
|
|
78
79
|
| [**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue |
|
|
@@ -3825,6 +3826,57 @@ This endpoint does not need any parameter.
|
|
|
3825
3826
|
- **Accept**: application/json
|
|
3826
3827
|
|
|
3827
3828
|
|
|
3829
|
+
## get_pbx_pay_connectors
|
|
3830
|
+
|
|
3831
|
+
> <ConversationPbxPayConnectorsResponse> get_pbx_pay_connectors
|
|
3832
|
+
|
|
3833
|
+
Get pbx pay connectors
|
|
3834
|
+
|
|
3835
|
+
Retrieve the Twilio Pay Connectors installed in the Twilio account for this merchant. This list is refreshed each time the PBX configuration is deployed.
|
|
3836
|
+
|
|
3837
|
+
|
|
3838
|
+
### Examples
|
|
3839
|
+
|
|
3840
|
+
|
|
3841
|
+
(No example for this operation).
|
|
3842
|
+
|
|
3843
|
+
|
|
3844
|
+
#### Using the get_pbx_pay_connectors_with_http_info variant
|
|
3845
|
+
|
|
3846
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3847
|
+
|
|
3848
|
+
> <Array(<ConversationPbxPayConnectorsResponse>, Integer, Hash)> get_pbx_pay_connectors_with_http_info
|
|
3849
|
+
|
|
3850
|
+
```ruby
|
|
3851
|
+
begin
|
|
3852
|
+
# Get pbx pay connectors
|
|
3853
|
+
data, status_code, headers = api_instance.get_pbx_pay_connectors_with_http_info
|
|
3854
|
+
p status_code # => 2xx
|
|
3855
|
+
p headers # => { ... }
|
|
3856
|
+
p data # => <ConversationPbxPayConnectorsResponse>
|
|
3857
|
+
rescue UltracartClient::ApiError => e
|
|
3858
|
+
puts "Error when calling ConversationApi->get_pbx_pay_connectors_with_http_info: #{e}"
|
|
3859
|
+
end
|
|
3860
|
+
```
|
|
3861
|
+
|
|
3862
|
+
### Parameters
|
|
3863
|
+
|
|
3864
|
+
This endpoint does not need any parameter.
|
|
3865
|
+
|
|
3866
|
+
### Return type
|
|
3867
|
+
|
|
3868
|
+
[**ConversationPbxPayConnectorsResponse**](ConversationPbxPayConnectorsResponse.md)
|
|
3869
|
+
|
|
3870
|
+
### Authorization
|
|
3871
|
+
|
|
3872
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3873
|
+
|
|
3874
|
+
### HTTP request headers
|
|
3875
|
+
|
|
3876
|
+
- **Content-Type**: Not defined
|
|
3877
|
+
- **Accept**: application/json
|
|
3878
|
+
|
|
3879
|
+
|
|
3828
3880
|
## get_pbx_phone_number
|
|
3829
3881
|
|
|
3830
3882
|
> <ConversationPbxPhoneNumberResponse> get_pbx_phone_number(conversation_pbx_phone_number_uuid)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxPayConnector
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | Description of the connector | [optional] |
|
|
8
|
+
| **environment** | **String** | Environment the connector points at. Only live connectors are returned. Sandbox and unconfigured connectors are ignored. | [optional] |
|
|
9
|
+
| **friendly_name** | **String** | Friendly name of the connector as shown in the Twilio console | [optional] |
|
|
10
|
+
| **merchant_id** | **String** | Merchant Id | [optional] |
|
|
11
|
+
| **processor** | **String** | Payment processor behind this connector | [optional] |
|
|
12
|
+
| **processor_account_id** | **String** | The processor account this connector is bound to (Stripe connected account id or Braintree merchant id). A payment captured with this connector can only be charged within this account. | [optional] |
|
|
13
|
+
| **sid** | **String** | Twilio installed add-on SID for this connector | [optional] |
|
|
14
|
+
| **unique_name** | **String** | Unique name of the connector. This is the value used for the paymentConnector attribute of the Twilio Pay verb. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::ConversationPbxPayConnector.new(
|
|
22
|
+
description: null,
|
|
23
|
+
environment: null,
|
|
24
|
+
friendly_name: null,
|
|
25
|
+
merchant_id: null,
|
|
26
|
+
processor: null,
|
|
27
|
+
processor_account_id: null,
|
|
28
|
+
sid: null,
|
|
29
|
+
unique_name: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxPayConnectorsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
9
|
+
| **pay_connectors** | [**Array<ConversationPbxPayConnector>**](ConversationPbxPayConnector.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationPbxPayConnectorsResponse.new(
|
|
19
|
+
error: null,
|
|
20
|
+
metadata: null,
|
|
21
|
+
pay_connectors: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|