ultracart_api 4.1.178 → 4.1.180

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: 75de5d6a801f97c0481e98f5c17fb66ac241af836f9d30ff9369229edb1bc23b
4
- data.tar.gz: 40a12b20d2798ca351030b2f9a6be99618d9ac3fb05b179e0a25326ae1a61463
3
+ metadata.gz: 4487eabe7a8df94f86f10d6069126892080a197bc997015975dbd927c0969a1e
4
+ data.tar.gz: '09fe31bea119b95c73c4217fbcbc7d6109fefade0176fbb532754baa654c8b0e'
5
5
  SHA512:
6
- metadata.gz: bd5a31348ed0119da97074917037d73a5389012834e82c6acf6fb514ffdb51c0710df2f4fc803aa18c11459a8c162852d697e86ccd763afba30e413f776e5b98
7
- data.tar.gz: a9f8101fae58933c68ccf127dda356da2f07f3865f81d7fd3330f30de655c32c759696703f521af12a18ef7e5550e99d70bfb9fae9eb37ae6fcf1ee50e6ac50b
6
+ metadata.gz: d44eabdb8eb6d8aa1c3cf6ef3aee69292edf68f101cae3a96e8b08f035c9f76022118991fa2eea6a4856d161e231429b4801aa86d13d973e2d75a5775a1c976f
7
+ data.tar.gz: 6e0354f889b517f359221b8597401cc0e950b32722c3a91346659e93b5597f039771fc897283495a2ea22289a8ee2a09cc11ed251123100a0c28affaa933f752
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.178
10
+ - Package version: 4.1.180
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.178'
19
+ gem 'ultracart_api', '4.1.180'
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
@@ -512,6 +516,8 @@ Class | Method | HTTP request | Description
512
516
  *UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
513
517
  *UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
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
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
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
515
521
  *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
516
522
  *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
517
523
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
@@ -1624,8 +1630,10 @@ Class | Method | HTTP request | Description
1624
1630
  - [UltracartClient::OrderAddItemsAndReleaseRequest](docs/OrderAddItemsAndReleaseRequest.md)
1625
1631
  - [UltracartClient::OrderAffiliate](docs/OrderAffiliate.md)
1626
1632
  - [UltracartClient::OrderAffiliateLedger](docs/OrderAffiliateLedger.md)
1633
+ - [UltracartClient::OrderAssignRmaRequest](docs/OrderAssignRmaRequest.md)
1627
1634
  - [UltracartClient::OrderAssignToAffiliateRequest](docs/OrderAssignToAffiliateRequest.md)
1628
1635
  - [UltracartClient::OrderAutoOrder](docs/OrderAutoOrder.md)
1636
+ - [UltracartClient::OrderAutoOrderUpdateBillingUrlResponse](docs/OrderAutoOrderUpdateBillingUrlResponse.md)
1629
1637
  - [UltracartClient::OrderBilling](docs/OrderBilling.md)
1630
1638
  - [UltracartClient::OrderBuysafe](docs/OrderBuysafe.md)
1631
1639
  - [UltracartClient::OrderByTokenQuery](docs/OrderByTokenQuery.md)
@@ -1881,6 +1889,12 @@ Class | Method | HTTP request | Description
1881
1889
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
1882
1890
  - [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
1883
1891
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
1892
+ - [UltracartClient::SfvbRecording](docs/SfvbRecording.md)
1893
+ - [UltracartClient::SfvbRecordingEvent](docs/SfvbRecordingEvent.md)
1894
+ - [UltracartClient::SfvbRecordingEventsResponse](docs/SfvbRecordingEventsResponse.md)
1895
+ - [UltracartClient::SfvbRecordingPageView](docs/SfvbRecordingPageView.md)
1896
+ - [UltracartClient::SfvbRecordingParameter](docs/SfvbRecordingParameter.md)
1897
+ - [UltracartClient::SfvbRecordingResponse](docs/SfvbRecordingResponse.md)
1884
1898
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
1885
1899
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
1886
1900
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2096,6 +2110,8 @@ Not every change is committed to every SDK.
2096
2110
 
2097
2111
  | Version | Date | Comments |
2098
2112
  | --: | :-: | --- |
2113
+ | 4.1.180 | 10/02/2026 | sfvb internal builder |
2114
+ | 4.1.179 | 10/01/2026 | sfvb internal testing |
2099
2115
  | 4.1.178 | 09/30/2026 | sfvb internal testing |
2100
2116
  | 4.1.177 | 09/30/2026 | sfvb internal testing |
2101
2117
  | 4.1.176 | 09/29/2026 | taxcloud tax provider 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
@@ -44,6 +44,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
44
44
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
45
45
  | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page&#39;s selectors |
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
+ | [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
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 |
47
49
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
48
50
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront&#39;s site attributes |
49
51
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
@@ -2284,6 +2286,115 @@ end
2284
2286
  - **Accept**: application/json
2285
2287
 
2286
2288
 
2289
+ ## get_sfvb_recording
2290
+
2291
+ > <SfvbRecordingResponse> get_sfvb_recording(storefront_oid, screen_recording_uuid)
2292
+
2293
+ Get a screen recording
2294
+
2295
+ One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
2296
+
2297
+
2298
+ ### Examples
2299
+
2300
+
2301
+ (No example for this operation).
2302
+
2303
+
2304
+ #### Using the get_sfvb_recording_with_http_info variant
2305
+
2306
+ This returns an Array which contains the response data, status code and headers.
2307
+
2308
+ > <Array(<SfvbRecordingResponse>, Integer, Hash)> get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
2309
+
2310
+ ```ruby
2311
+ begin
2312
+ # Get a screen recording
2313
+ data, status_code, headers = api_instance.get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
2314
+ p status_code # => 2xx
2315
+ p headers # => { ... }
2316
+ p data # => <SfvbRecordingResponse>
2317
+ rescue UltracartClient::ApiError => e
2318
+ puts "Error when calling SfvbApi->get_sfvb_recording_with_http_info: #{e}"
2319
+ end
2320
+ ```
2321
+
2322
+ ### Parameters
2323
+
2324
+ | Name | Type | Description | Notes |
2325
+ | ---- | ---- | ----------- | ----- |
2326
+ | **storefront_oid** | **Integer** | | |
2327
+ | **screen_recording_uuid** | **String** | | |
2328
+
2329
+ ### Return type
2330
+
2331
+ [**SfvbRecordingResponse**](SfvbRecordingResponse.md)
2332
+
2333
+ ### Authorization
2334
+
2335
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2336
+
2337
+ ### HTTP request headers
2338
+
2339
+ - **Content-Type**: Not defined
2340
+ - **Accept**: application/json
2341
+
2342
+
2343
+ ## get_sfvb_recording_page_view_events
2344
+
2345
+ > <SfvbRecordingEventsResponse> get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
2346
+
2347
+ Get one recorded page view's replay events
2348
+
2349
+ The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
2350
+
2351
+
2352
+ ### Examples
2353
+
2354
+
2355
+ (No example for this operation).
2356
+
2357
+
2358
+ #### Using the get_sfvb_recording_page_view_events_with_http_info variant
2359
+
2360
+ This returns an Array which contains the response data, status code and headers.
2361
+
2362
+ > <Array(<SfvbRecordingEventsResponse>, Integer, Hash)> get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
2363
+
2364
+ ```ruby
2365
+ begin
2366
+ # Get one recorded page view's replay events
2367
+ data, status_code, headers = api_instance.get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
2368
+ p status_code # => 2xx
2369
+ p headers # => { ... }
2370
+ p data # => <SfvbRecordingEventsResponse>
2371
+ rescue UltracartClient::ApiError => e
2372
+ puts "Error when calling SfvbApi->get_sfvb_recording_page_view_events_with_http_info: #{e}"
2373
+ end
2374
+ ```
2375
+
2376
+ ### Parameters
2377
+
2378
+ | Name | Type | Description | Notes |
2379
+ | ---- | ---- | ----------- | ----- |
2380
+ | **storefront_oid** | **Integer** | | |
2381
+ | **screen_recording_uuid** | **String** | | |
2382
+ | **screen_recording_page_view_uuid** | **String** | | |
2383
+
2384
+ ### Return type
2385
+
2386
+ [**SfvbRecordingEventsResponse**](SfvbRecordingEventsResponse.md)
2387
+
2388
+ ### Authorization
2389
+
2390
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2391
+
2392
+ ### HTTP request headers
2393
+
2394
+ - **Content-Type**: Not defined
2395
+ - **Accept**: application/json
2396
+
2397
+
2287
2398
  ## get_sfvb_server_log
2288
2399
 
2289
2400
  > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
@@ -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,60 @@
1
+ # UltracartClient::SfvbRecording
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ad_platform** | [**ScreenRecordingAdPlatform**](ScreenRecordingAdPlatform.md) | | [optional] |
8
+ | **browser** | **String** | Browser name from the user agent. | [optional] |
9
+ | **browser_version** | **String** | Browser version from the user agent. | [optional] |
10
+ | **converted** | **Boolean** | True when the session ended in an order. | [optional] |
11
+ | **device** | **String** | Device name from the user agent. | [optional] |
12
+ | **end_timestamp** | **String** | When the session ended, ISO-8601 in UTC. | [optional] |
13
+ | **geolocation_country** | **String** | Country the visitor was in. | [optional] |
14
+ | **geolocation_state** | **String** | State or region the visitor was in. | [optional] |
15
+ | **language_iso_code** | **String** | The browser language. | [optional] |
16
+ | **order_id** | **String** | The order placed during the session, when there was one. | [optional] |
17
+ | **os** | **String** | Operating system from the user agent. | [optional] |
18
+ | **page_view_count** | **Integer** | How many pages the visitor viewed. | [optional] |
19
+ | **page_views** | [**Array&lt;SfvbRecordingPageView&gt;**](SfvbRecordingPageView.md) | The pages viewed, in order. | [optional] |
20
+ | **referrer_domain** | **String** | The domain that referred the visitor. | [optional] |
21
+ | **rrweb_version** | **String** | The rrweb version that recorded the session. Replay with the same version. | [optional] |
22
+ | **screen_recording_uuid** | **String** | Identifies the recording. | [optional] |
23
+ | **start_timestamp** | **String** | When the session started, ISO-8601 in UTC. | [optional] |
24
+ | **time_on_site** | **Integer** | Seconds the visitor spent on the site. | [optional] |
25
+ | **utm_campaign** | **String** | utm_campaign on arrival. | [optional] |
26
+ | **utm_source** | **String** | utm_source on arrival. | [optional] |
27
+ | **window_height** | **Integer** | Browser window height in pixels. | [optional] |
28
+ | **window_width** | **Integer** | Browser window width in pixels. | [optional] |
29
+
30
+ ## Example
31
+
32
+ ```ruby
33
+ require 'ultracart_api'
34
+
35
+ instance = UltracartClient::SfvbRecording.new(
36
+ ad_platform: null,
37
+ browser: null,
38
+ browser_version: null,
39
+ converted: null,
40
+ device: null,
41
+ end_timestamp: null,
42
+ geolocation_country: null,
43
+ geolocation_state: null,
44
+ language_iso_code: null,
45
+ order_id: null,
46
+ os: null,
47
+ page_view_count: null,
48
+ page_views: null,
49
+ referrer_domain: null,
50
+ rrweb_version: null,
51
+ screen_recording_uuid: null,
52
+ start_timestamp: null,
53
+ time_on_site: null,
54
+ utm_campaign: null,
55
+ utm_source: null,
56
+ window_height: null,
57
+ window_width: null
58
+ )
59
+ ```
60
+