ultracart_api 4.1.179 → 4.1.181

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7be2900314bb7fd6dbb8b131e2ec81241b554295c1f0e0a8f358351c85bd2fc9
4
- data.tar.gz: ed5d67d6b4a183517fcba0bb7648dbbcd3c04e50f37e1a4d8615069763eea627
3
+ metadata.gz: c49da69ae79ac178e5eb8df20bfbd7ad6ea2944c667682f55da9f57c2fe36caa
4
+ data.tar.gz: 18e587c811bda2b7b7a059dabf819ed9b60593441b111e411e13877f7f0ae624
5
5
  SHA512:
6
- metadata.gz: 8d0665e462f12b907302102007ff4a4cbde6f01fa071d0159d5b8e93b9f7444558493651ce13ed0bea8bf8280a88877f97f79fab86b4d3dbc9cb667a713da00f
7
- data.tar.gz: '086081a72686f31419a1644b82921ba67f4b4736e64870be4c8554ef61850f4e8df6b9bcc903b075aca724cab43f3c975d9abc8991a82e7b67a9cb1e45796a6b'
6
+ metadata.gz: e0067df7231120a1fb45d026b1c247e037e47be43625bbbf5fd7b40987fa53971b87e68cf378620c64af9dbe02a0cc1bb017cc8e39b50ca5ff1d65751c495c30
7
+ data.tar.gz: dd5170307f30f1a7f20e6ff0b8891ff6e1748d8a631cecfd919e794a7bfcbf6230ec24dbd3359b53957591b5aec0509ca23474244fa958757d9daa9ed78ae955
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.179
10
+ - Package version: 4.1.181
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.179'
19
+ gem 'ultracart_api', '4.1.181'
20
20
  ```
21
21
 
22
22
  install:
@@ -99,6 +99,7 @@ Class | Method | HTTP request | Description
99
99
  *UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
100
100
  *UltracartClient::AutoOrderApi* | [**get_auto_order_cancel_reasons**](docs/AutoOrderApi.md#get_auto_order_cancel_reasons) | **GET** /auto_order/auto_orders/cancel_reasons | Retrieve auto order cancel reasons.
101
101
  *UltracartClient::AutoOrderApi* | [**get_auto_order_emails**](docs/AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order.
102
+ *UltracartClient::AutoOrderApi* | [**get_auto_order_update_billing_url**](docs/AutoOrderApi.md#get_auto_order_update_billing_url) | **GET** /auto_order/auto_orders/{auto_order_oid}/update_billing_url | Generate an auto order update billing url
102
103
  *UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
103
104
  *UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
104
105
  *UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
@@ -434,6 +435,7 @@ Class | Method | HTTP request | Description
434
435
  *UltracartClient::OauthApi* | [**oauth_me**](docs/OauthApi.md#oauth_me) | **GET** /oauth/me | Identify the merchant account this access token belongs to.
435
436
  *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
436
437
  *UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
438
+ *UltracartClient::OrderApi* | [**assign_rma**](docs/OrderApi.md#assign_rma) | **POST** /order/orders/{order_id}/rma | Associates an RMA with an order
437
439
  *UltracartClient::OrderApi* | [**assign_to_affiliate**](docs/OrderApi.md#assign_to_affiliate) | **POST** /order/orders/{order_id}/assignToAffiliate | Assigns an order to an affiliate
438
440
  *UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
439
441
  *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
@@ -458,6 +460,8 @@ Class | Method | HTTP request | Description
458
460
  *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
459
461
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
460
462
  *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
463
+ *UltracartClient::OrderApi* | [**get_orders_by_rma**](docs/OrderApi.md#get_orders_by_rma) | **GET** /order/orders/rma/{rma} | Retrieve orders by RMA
464
+ *UltracartClient::OrderApi* | [**get_update_billing_url**](docs/OrderApi.md#get_update_billing_url) | **GET** /order/orders/{order_id}/auto_order_update_billing_url | Generate an auto order update billing url
461
465
  *UltracartClient::OrderApi* | [**held_order_add_items_and_release**](docs/OrderApi.md#held_order_add_items_and_release) | **PUT** /order/orders/{order_id}/hold/add_items_and_release | Add items and release a held order
462
466
  *UltracartClient::OrderApi* | [**held_order_release**](docs/OrderApi.md#held_order_release) | **PUT** /order/orders/{order_id}/hold/release | Release a held order
463
467
  *UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
@@ -514,6 +518,7 @@ Class | Method | HTTP request | Description
514
518
  *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
515
519
  *UltracartClient::SfvbApi* | [**get_sfvb_recording**](docs/SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording
516
520
  *UltracartClient::SfvbApi* | [**get_sfvb_recording_page_view_events**](docs/SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events
521
+ *UltracartClient::SfvbApi* | [**get_sfvb_recording_settings**](docs/SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings
517
522
  *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
518
523
  *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
519
524
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
@@ -556,6 +561,7 @@ Class | Method | HTTP request | Description
556
561
  *UltracartClient::SfvbApi* | [**put_sfvb_page_selectors**](docs/SfvbApi.md#put_sfvb_page_selectors) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/selectors | Replace a page's selectors
557
562
  *UltracartClient::SfvbApi* | [**put_sfvb_page_settings**](docs/SfvbApi.md#put_sfvb_page_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/settings | Change a page's settings
558
563
  *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
564
+ *UltracartClient::SfvbApi* | [**put_sfvb_recording_settings**](docs/SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront's screen recording on or off
559
565
  *UltracartClient::SfvbApi* | [**put_sfvb_site_attributes**](docs/SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes
560
566
  *UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
561
567
  *UltracartClient::SfvbApi* | [**refresh_sfvb_page**](docs/SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy
@@ -1626,8 +1632,10 @@ Class | Method | HTTP request | Description
1626
1632
  - [UltracartClient::OrderAddItemsAndReleaseRequest](docs/OrderAddItemsAndReleaseRequest.md)
1627
1633
  - [UltracartClient::OrderAffiliate](docs/OrderAffiliate.md)
1628
1634
  - [UltracartClient::OrderAffiliateLedger](docs/OrderAffiliateLedger.md)
1635
+ - [UltracartClient::OrderAssignRmaRequest](docs/OrderAssignRmaRequest.md)
1629
1636
  - [UltracartClient::OrderAssignToAffiliateRequest](docs/OrderAssignToAffiliateRequest.md)
1630
1637
  - [UltracartClient::OrderAutoOrder](docs/OrderAutoOrder.md)
1638
+ - [UltracartClient::OrderAutoOrderUpdateBillingUrlResponse](docs/OrderAutoOrderUpdateBillingUrlResponse.md)
1631
1639
  - [UltracartClient::OrderBilling](docs/OrderBilling.md)
1632
1640
  - [UltracartClient::OrderBuysafe](docs/OrderBuysafe.md)
1633
1641
  - [UltracartClient::OrderByTokenQuery](docs/OrderByTokenQuery.md)
@@ -1889,6 +1897,9 @@ Class | Method | HTTP request | Description
1889
1897
  - [UltracartClient::SfvbRecordingPageView](docs/SfvbRecordingPageView.md)
1890
1898
  - [UltracartClient::SfvbRecordingParameter](docs/SfvbRecordingParameter.md)
1891
1899
  - [UltracartClient::SfvbRecordingResponse](docs/SfvbRecordingResponse.md)
1900
+ - [UltracartClient::SfvbRecordingSettings](docs/SfvbRecordingSettings.md)
1901
+ - [UltracartClient::SfvbRecordingSettingsRequest](docs/SfvbRecordingSettingsRequest.md)
1902
+ - [UltracartClient::SfvbRecordingSettingsResponse](docs/SfvbRecordingSettingsResponse.md)
1892
1903
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
1893
1904
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
1894
1905
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2104,6 +2115,8 @@ Not every change is committed to every SDK.
2104
2115
 
2105
2116
  | Version | Date | Comments |
2106
2117
  | --: | :-: | --- |
2118
+ | 4.1.181 | 10/02/2026 | sfvb internal testing |
2119
+ | 4.1.180 | 10/02/2026 | sfvb internal builder |
2107
2120
  | 4.1.179 | 10/01/2026 | sfvb internal testing |
2108
2121
  | 4.1.178 | 09/30/2026 | sfvb internal testing |
2109
2122
  | 4.1.177 | 09/30/2026 | sfvb internal testing |
data/docs/AutoOrderApi.md CHANGED
@@ -13,6 +13,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
13
13
  | [**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id |
14
14
  | [**get_auto_order_cancel_reasons**](AutoOrderApi.md#get_auto_order_cancel_reasons) | **GET** /auto_order/auto_orders/cancel_reasons | Retrieve auto order cancel reasons. |
15
15
  | [**get_auto_order_emails**](AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order. |
16
+ | [**get_auto_order_update_billing_url**](AutoOrderApi.md#get_auto_order_update_billing_url) | **GET** /auto_order/auto_orders/{auto_order_oid}/update_billing_url | Generate an auto order update billing url |
16
17
  | [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders |
17
18
  | [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch |
18
19
  | [**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query |
@@ -763,6 +764,59 @@ end
763
764
  - **Accept**: application/json
764
765
 
765
766
 
767
+ ## get_auto_order_update_billing_url
768
+
769
+ > <OrderAutoOrderUpdateBillingUrlResponse> get_auto_order_update_billing_url(auto_order_oid)
770
+
771
+ Generate an auto order update billing url
772
+
773
+ Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
774
+
775
+
776
+ ### Examples
777
+
778
+
779
+ (No example for this operation).
780
+
781
+
782
+ #### Using the get_auto_order_update_billing_url_with_http_info variant
783
+
784
+ This returns an Array which contains the response data, status code and headers.
785
+
786
+ > <Array(<OrderAutoOrderUpdateBillingUrlResponse>, Integer, Hash)> get_auto_order_update_billing_url_with_http_info(auto_order_oid)
787
+
788
+ ```ruby
789
+ begin
790
+ # Generate an auto order update billing url
791
+ data, status_code, headers = api_instance.get_auto_order_update_billing_url_with_http_info(auto_order_oid)
792
+ p status_code # => 2xx
793
+ p headers # => { ... }
794
+ p data # => <OrderAutoOrderUpdateBillingUrlResponse>
795
+ rescue UltracartClient::ApiError => e
796
+ puts "Error when calling AutoOrderApi->get_auto_order_update_billing_url_with_http_info: #{e}"
797
+ end
798
+ ```
799
+
800
+ ### Parameters
801
+
802
+ | Name | Type | Description | Notes |
803
+ | ---- | ---- | ----------- | ----- |
804
+ | **auto_order_oid** | **Integer** | The auto order oid to generate the update billing url for. | |
805
+
806
+ ### Return type
807
+
808
+ [**OrderAutoOrderUpdateBillingUrlResponse**](OrderAutoOrderUpdateBillingUrlResponse.md)
809
+
810
+ ### Authorization
811
+
812
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
813
+
814
+ ### HTTP request headers
815
+
816
+ - **Content-Type**: Not defined
817
+ - **Accept**: application/json
818
+
819
+
766
820
  ## get_auto_orders
767
821
 
768
822
  > <AutoOrdersResponse> get_auto_orders(opts)
data/docs/OrderApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total |
8
+ | [**assign_rma**](OrderApi.md#assign_rma) | **POST** /order/orders/{order_id}/rma | Associates an RMA with an order |
8
9
  | [**assign_to_affiliate**](OrderApi.md#assign_to_affiliate) | **POST** /order/orders/{order_id}/assignToAffiliate | Assigns an order to an affiliate |
9
10
  | [**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order |
10
11
  | [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order |
@@ -29,6 +30,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
29
30
  | [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders |
30
31
  | [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch |
31
32
  | [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query |
33
+ | [**get_orders_by_rma**](OrderApi.md#get_orders_by_rma) | **GET** /order/orders/rma/{rma} | Retrieve orders by RMA |
34
+ | [**get_update_billing_url**](OrderApi.md#get_update_billing_url) | **GET** /order/orders/{order_id}/auto_order_update_billing_url | Generate an auto order update billing url |
32
35
  | [**held_order_add_items_and_release**](OrderApi.md#held_order_add_items_and_release) | **PUT** /order/orders/{order_id}/hold/add_items_and_release | Add items and release a held order |
33
36
  | [**held_order_release**](OrderApi.md#held_order_release) | **PUT** /order/orders/{order_id}/hold/release | Release a held order |
34
37
  | [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order |
@@ -125,6 +128,61 @@ end
125
128
  - **Accept**: application/json
126
129
 
127
130
 
131
+ ## assign_rma
132
+
133
+ > <OrderResponse> assign_rma(order_id, assign_rma_request, opts)
134
+
135
+ Associates an RMA with an order
136
+
137
+ Associates an RMA number with an order. Any existing RMA on the order is replaced.
138
+
139
+
140
+ ### Examples
141
+
142
+
143
+ (No example for this operation).
144
+
145
+
146
+ #### Using the assign_rma_with_http_info variant
147
+
148
+ This returns an Array which contains the response data, status code and headers.
149
+
150
+ > <Array(<OrderResponse>, Integer, Hash)> assign_rma_with_http_info(order_id, assign_rma_request, opts)
151
+
152
+ ```ruby
153
+ begin
154
+ # Associates an RMA with an order
155
+ data, status_code, headers = api_instance.assign_rma_with_http_info(order_id, assign_rma_request, opts)
156
+ p status_code # => 2xx
157
+ p headers # => { ... }
158
+ p data # => <OrderResponse>
159
+ rescue UltracartClient::ApiError => e
160
+ puts "Error when calling OrderApi->assign_rma_with_http_info: #{e}"
161
+ end
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ | Name | Type | Description | Notes |
167
+ | ---- | ---- | ----------- | ----- |
168
+ | **order_id** | **String** | The order id to associate the RMA with. | |
169
+ | **assign_rma_request** | [**OrderAssignRmaRequest**](OrderAssignRmaRequest.md) | Assign RMA request | |
170
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
171
+
172
+ ### Return type
173
+
174
+ [**OrderResponse**](OrderResponse.md)
175
+
176
+ ### Authorization
177
+
178
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: application/json
183
+ - **Accept**: application/json
184
+
185
+
128
186
  ## assign_to_affiliate
129
187
 
130
188
  > <OrderResponse> assign_to_affiliate(order_id, assign_to_affiliate_request, opts)
@@ -2188,6 +2246,113 @@ end
2188
2246
  - **Accept**: application/json
2189
2247
 
2190
2248
 
2249
+ ## get_orders_by_rma
2250
+
2251
+ > <OrdersResponse> get_orders_by_rma(rma, opts)
2252
+
2253
+ Retrieve orders by RMA
2254
+
2255
+ Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
2256
+
2257
+
2258
+ ### Examples
2259
+
2260
+
2261
+ (No example for this operation).
2262
+
2263
+
2264
+ #### Using the get_orders_by_rma_with_http_info variant
2265
+
2266
+ This returns an Array which contains the response data, status code and headers.
2267
+
2268
+ > <Array(<OrdersResponse>, Integer, Hash)> get_orders_by_rma_with_http_info(rma, opts)
2269
+
2270
+ ```ruby
2271
+ begin
2272
+ # Retrieve orders by RMA
2273
+ data, status_code, headers = api_instance.get_orders_by_rma_with_http_info(rma, opts)
2274
+ p status_code # => 2xx
2275
+ p headers # => { ... }
2276
+ p data # => <OrdersResponse>
2277
+ rescue UltracartClient::ApiError => e
2278
+ puts "Error when calling OrderApi->get_orders_by_rma_with_http_info: #{e}"
2279
+ end
2280
+ ```
2281
+
2282
+ ### Parameters
2283
+
2284
+ | Name | Type | Description | Notes |
2285
+ | ---- | ---- | ----------- | ----- |
2286
+ | **rma** | **String** | The RMA number to search for. | |
2287
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
2288
+
2289
+ ### Return type
2290
+
2291
+ [**OrdersResponse**](OrdersResponse.md)
2292
+
2293
+ ### Authorization
2294
+
2295
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2296
+
2297
+ ### HTTP request headers
2298
+
2299
+ - **Content-Type**: Not defined
2300
+ - **Accept**: application/json
2301
+
2302
+
2303
+ ## get_update_billing_url
2304
+
2305
+ > <OrderAutoOrderUpdateBillingUrlResponse> get_update_billing_url(order_id)
2306
+
2307
+ Generate an auto order update billing url
2308
+
2309
+ Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
2310
+
2311
+
2312
+ ### Examples
2313
+
2314
+
2315
+ (No example for this operation).
2316
+
2317
+
2318
+ #### Using the get_update_billing_url_with_http_info variant
2319
+
2320
+ This returns an Array which contains the response data, status code and headers.
2321
+
2322
+ > <Array(<OrderAutoOrderUpdateBillingUrlResponse>, Integer, Hash)> get_update_billing_url_with_http_info(order_id)
2323
+
2324
+ ```ruby
2325
+ begin
2326
+ # Generate an auto order update billing url
2327
+ data, status_code, headers = api_instance.get_update_billing_url_with_http_info(order_id)
2328
+ p status_code # => 2xx
2329
+ p headers # => { ... }
2330
+ p data # => <OrderAutoOrderUpdateBillingUrlResponse>
2331
+ rescue UltracartClient::ApiError => e
2332
+ puts "Error when calling OrderApi->get_update_billing_url_with_http_info: #{e}"
2333
+ end
2334
+ ```
2335
+
2336
+ ### Parameters
2337
+
2338
+ | Name | Type | Description | Notes |
2339
+ | ---- | ---- | ----------- | ----- |
2340
+ | **order_id** | **String** | The order id to generate the update billing url for. | |
2341
+
2342
+ ### Return type
2343
+
2344
+ [**OrderAutoOrderUpdateBillingUrlResponse**](OrderAutoOrderUpdateBillingUrlResponse.md)
2345
+
2346
+ ### Authorization
2347
+
2348
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2349
+
2350
+ ### HTTP request headers
2351
+
2352
+ - **Content-Type**: Not defined
2353
+ - **Accept**: application/json
2354
+
2355
+
2191
2356
  ## held_order_add_items_and_release
2192
2357
 
2193
2358
  > <OrderResponse> held_order_add_items_and_release(order_id, add_items_and_release_request, opts)
@@ -0,0 +1,18 @@
1
+ # UltracartClient::OrderAssignRmaRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rma** | **String** | RMA number to associate with the order | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::OrderAssignRmaRequest.new(
15
+ rma: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::OrderAutoOrderUpdateBillingUrlResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
10
+ | **update_billing_url** | **String** | The url the customer can use to update the billing information on their auto order | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::OrderAutoOrderUpdateBillingUrlResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ success: null,
22
+ update_billing_url: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/SfvbApi.md CHANGED
@@ -46,6 +46,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
46
46
  | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
47
47
  | [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
48
48
  | [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view&#39;s replay events |
49
+ | [**get_sfvb_recording_settings**](SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront&#39;s screen recording settings |
49
50
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
50
51
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront&#39;s site attributes |
51
52
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
@@ -88,6 +89,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
88
89
  | [**put_sfvb_page_selectors**](SfvbApi.md#put_sfvb_page_selectors) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/selectors | Replace a page&#39;s selectors |
89
90
  | [**put_sfvb_page_settings**](SfvbApi.md#put_sfvb_page_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/settings | Change a page&#39;s settings |
90
91
  | [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
92
+ | [**put_sfvb_recording_settings**](SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront&#39;s screen recording on or off |
91
93
  | [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront&#39;s site attributes |
92
94
  | [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme&#39;s colors, fonts and settings |
93
95
  | [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page&#39;s cached copy |
@@ -2395,6 +2397,59 @@ end
2395
2397
  - **Accept**: application/json
2396
2398
 
2397
2399
 
2400
+ ## get_sfvb_recording_settings
2401
+
2402
+ > <SfvbRecordingSettingsResponse> get_sfvb_recording_settings(storefront_oid)
2403
+
2404
+ Get the storefront's screen recording settings
2405
+
2406
+ Whether real shoppers' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods. Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
2407
+
2408
+
2409
+ ### Examples
2410
+
2411
+
2412
+ (No example for this operation).
2413
+
2414
+
2415
+ #### Using the get_sfvb_recording_settings_with_http_info variant
2416
+
2417
+ This returns an Array which contains the response data, status code and headers.
2418
+
2419
+ > <Array(<SfvbRecordingSettingsResponse>, Integer, Hash)> get_sfvb_recording_settings_with_http_info(storefront_oid)
2420
+
2421
+ ```ruby
2422
+ begin
2423
+ # Get the storefront's screen recording settings
2424
+ data, status_code, headers = api_instance.get_sfvb_recording_settings_with_http_info(storefront_oid)
2425
+ p status_code # => 2xx
2426
+ p headers # => { ... }
2427
+ p data # => <SfvbRecordingSettingsResponse>
2428
+ rescue UltracartClient::ApiError => e
2429
+ puts "Error when calling SfvbApi->get_sfvb_recording_settings_with_http_info: #{e}"
2430
+ end
2431
+ ```
2432
+
2433
+ ### Parameters
2434
+
2435
+ | Name | Type | Description | Notes |
2436
+ | ---- | ---- | ----------- | ----- |
2437
+ | **storefront_oid** | **Integer** | | |
2438
+
2439
+ ### Return type
2440
+
2441
+ [**SfvbRecordingSettingsResponse**](SfvbRecordingSettingsResponse.md)
2442
+
2443
+ ### Authorization
2444
+
2445
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2446
+
2447
+ ### HTTP request headers
2448
+
2449
+ - **Content-Type**: Not defined
2450
+ - **Accept**: application/json
2451
+
2452
+
2398
2453
  ## get_sfvb_server_log
2399
2454
 
2400
2455
  > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
@@ -4706,6 +4761,60 @@ end
4706
4761
  - **Accept**: application/json
4707
4762
 
4708
4763
 
4764
+ ## put_sfvb_recording_settings
4765
+
4766
+ > <SfvbRecordingSettingsResponse> put_sfvb_recording_settings(storefront_oid, recording_settings_request)
4767
+
4768
+ Turn the storefront's screen recording on or off
4769
+
4770
+ Turning it on records real shoppers' sessions from that moment, with no history before it. The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000. Only change it when the merchant has asked for it. Asking for the state it is already in changes nothing, and changed comes back false. Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded. Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
4771
+
4772
+
4773
+ ### Examples
4774
+
4775
+
4776
+ (No example for this operation).
4777
+
4778
+
4779
+ #### Using the put_sfvb_recording_settings_with_http_info variant
4780
+
4781
+ This returns an Array which contains the response data, status code and headers.
4782
+
4783
+ > <Array(<SfvbRecordingSettingsResponse>, Integer, Hash)> put_sfvb_recording_settings_with_http_info(storefront_oid, recording_settings_request)
4784
+
4785
+ ```ruby
4786
+ begin
4787
+ # Turn the storefront's screen recording on or off
4788
+ data, status_code, headers = api_instance.put_sfvb_recording_settings_with_http_info(storefront_oid, recording_settings_request)
4789
+ p status_code # => 2xx
4790
+ p headers # => { ... }
4791
+ p data # => <SfvbRecordingSettingsResponse>
4792
+ rescue UltracartClient::ApiError => e
4793
+ puts "Error when calling SfvbApi->put_sfvb_recording_settings_with_http_info: #{e}"
4794
+ end
4795
+ ```
4796
+
4797
+ ### Parameters
4798
+
4799
+ | Name | Type | Description | Notes |
4800
+ | ---- | ---- | ----------- | ----- |
4801
+ | **storefront_oid** | **Integer** | | |
4802
+ | **recording_settings_request** | [**SfvbRecordingSettingsRequest**](SfvbRecordingSettingsRequest.md) | Whether to record | |
4803
+
4804
+ ### Return type
4805
+
4806
+ [**SfvbRecordingSettingsResponse**](SfvbRecordingSettingsResponse.md)
4807
+
4808
+ ### Authorization
4809
+
4810
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4811
+
4812
+ ### HTTP request headers
4813
+
4814
+ - **Content-Type**: application/json; charset=UTF-8
4815
+ - **Accept**: application/json
4816
+
4817
+
4709
4818
  ## put_sfvb_site_attributes
4710
4819
 
4711
4820
  > <SfvbSiteAttributesResponse> put_sfvb_site_attributes(storefront_oid, site_attribute_update_request)
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **allow_comments** | **Boolean** | Whether shoppers may comment. | [optional] |
7
+ | **allow_comments** | **Boolean** | Whether shoppers may comment. Like every false value here, false is left out of the response. | [optional] |
8
8
  | **author** | **String** | The post author. | [optional] |
9
9
  | **blog_post_oid** | **Integer** | The blog post&#39;s oid. This is what a page&#39;s blog post assignment names. | [optional] |
10
10
  | **body** | **String** | The post body as HTML, exactly as stored. | [optional] |
@@ -13,7 +13,10 @@
13
13
  | **images** | [**Array&lt;SfvbBlogPostImage&gt;**](SfvbBlogPostImage.md) | The post&#39;s images, the default image first. | [optional] |
14
14
  | **last_modified_dts** | **String** | When the post was last changed (ISO 8601, UTC), or null if it never was. | [optional] |
15
15
  | **publication_dts** | **String** | When the post is published (ISO 8601, UTC), or null for a draft. | [optional] |
16
- | **tags** | **Array&lt;String&gt;** | The post&#39;s tags. | [optional] |
16
+ | **seo_description** | **String** | The meta description (storefrontSEODescription). Absent when not set. | [optional] |
17
+ | **seo_keywords** | **String** | The meta keywords (storefrontSEOKeywords). Absent when not set. | [optional] |
18
+ | **seo_title** | **String** | The page head title (storefrontSEOTitle). Absent when not set, and the head then uses the post title. | [optional] |
19
+ | **tags** | **Array&lt;String&gt;** | The post&#39;s tags, in alphabetical order. The order they were sent in is not kept. | [optional] |
17
20
  | **title** | **String** | The post title. | [optional] |
18
21
  | **unassigned** | **Boolean** | True when no page shows this post yet. | [optional] |
19
22
  | **url_part** | **String** | The post&#39;s name in its URL. | [optional] |
@@ -35,6 +38,9 @@ instance = UltracartClient::SfvbBlogPostDetail.new(
35
38
  images: null,
36
39
  last_modified_dts: null,
37
40
  publication_dts: null,
41
+ seo_description: null,
42
+ seo_keywords: null,
43
+ seo_title: null,
38
44
  tags: null,
39
45
  title: null,
40
46
  unassigned: null,
@@ -9,6 +9,9 @@
9
9
  | **body** | **String** | The post body as HTML, up to 1 MB, rendered exactly as stored. Refused with sfvb.unsafe_html if it could run script - script and other executable tags, on attributes, links that are not http, https, mailto, tel or relative, and iframes other than YouTube or Vimeo players. Reference an attached image by the url the post&#39;s images report. | [optional] |
10
10
  | **excerpt** | **String** | The post excerpt as HTML, up to 256 KB. Held to the same rule as body. | [optional] |
11
11
  | **publication_dts** | **String** | When the post is published, as an ISO 8601 UTC time in the same form publication_dts reads back. Refused on a draft. A post made public without one is published now. | [optional] |
12
+ | **seo_description** | **String** | The meta description (storefrontSEODescription), the search result snippet. Plain text with no angle brackets or double quotes, up to 1000 characters. Left out, it is unchanged; an empty string clears it, and the head falls back to the site&#39;s description. | [optional] |
13
+ | **seo_keywords** | **String** | The meta keywords (storefrontSEOKeywords). Plain text with no angle brackets or double quotes, up to 1000 characters. Left out, it is unchanged; an empty string clears it, and the head falls back to the site&#39;s keywords. | [optional] |
14
+ | **seo_title** | **String** | The page head title (storefrontSEOTitle), used in place of the post title in the browser tab and search results. Plain text with no angle brackets or double quotes, up to 1000 characters. Left out, it is unchanged; an empty string clears it, and the head falls back to the post title. | [optional] |
12
15
  | **tags** | **Array&lt;String&gt;** | The post&#39;s tags as plain text, up to 100 characters each, with no quotes or angle brackets and no repeats. On an update the list replaces every tag, and an empty list clears them. | [optional] |
13
16
  | **title** | **String** | The post title, up to 1000 characters. Required on create. | [optional] |
14
17
  | **url_part** | **String** | The post&#39;s name in its URL, which is the page path followed by this and .html. Letters, digits, hyphens and underscores, up to 150. Must not be used by another post on the storefront, compared without regard to case, and must not be an item id or an item&#39;s url part, because the storefront checks blog posts first and the post would replace the item&#39;s page. index and index-N are reserved. Required on create. | [optional] |
@@ -25,6 +28,9 @@ instance = UltracartClient::SfvbBlogPostRequest.new(
25
28
  body: null,
26
29
  excerpt: null,
27
30
  publication_dts: null,
31
+ seo_description: null,
32
+ seo_keywords: null,
33
+ seo_title: null,
28
34
  tags: null,
29
35
  title: null,
30
36
  url_part: null,
@@ -0,0 +1,34 @@
1
+ # UltracartClient::SfvbRecordingSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cost_per_thousand** | **Float** | What 1,000 recorded sessions cost after the trial, in US dollars. | [optional] |
8
+ | **enabled** | **Boolean** | True when real shoppers&#39; sessions on this storefront are being recorded. | [optional] |
9
+ | **retention_interval** | **String** | How long recordings are kept, such as 1 year. | [optional] |
10
+ | **sessions_current_billing_period** | **Integer** | Sessions recorded so far in the current billing period. | [optional] |
11
+ | **sessions_last_billing_period** | **Integer** | Sessions recorded in the previous billing period. | [optional] |
12
+ | **sessions_trial_billing_period** | **Integer** | Sessions recorded during the free trial. | [optional] |
13
+ | **trial_expiration** | **String** | When the free trial ends, as an ISO-8601 time. Absent until the trial has started. | [optional] |
14
+ | **trial_expired** | **Boolean** | True when the free trial is over and recorded sessions are billed. | [optional] |
15
+ | **trial_started** | **Boolean** | True once recording has been turned on at least once, which starts a 14 day free trial. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::SfvbRecordingSettings.new(
23
+ cost_per_thousand: null,
24
+ enabled: null,
25
+ retention_interval: null,
26
+ sessions_current_billing_period: null,
27
+ sessions_last_billing_period: null,
28
+ sessions_trial_billing_period: null,
29
+ trial_expiration: null,
30
+ trial_expired: null,
31
+ trial_started: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbRecordingSettingsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | True to record real shoppers&#39; sessions, false to stop. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::SfvbRecordingSettingsRequest.new(
15
+ enabled: null
16
+ )
17
+ ```
18
+