ultracart_api 4.1.73 → 4.1.76
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 +12 -2
- data/docs/AutoOrderApi.md +57 -0
- data/docs/AutoOrderItemCancelRequest.md +20 -0
- data/docs/ConversationEmbedApi.md +226 -0
- data/docs/ConversationEmbedPbxAuthResponse.md +28 -0
- data/docs/OrderFormat.md +3 -1
- data/lib/ultracart_api/api/auto_order_api.rb +80 -0
- data/lib/ultracart_api/api/conversation_embed_api.rb +330 -0
- data/lib/ultracart_api/models/auto_order_item_cancel_request.rb +264 -0
- data/lib/ultracart_api/models/conversation_embed_pbx_auth_response.rb +270 -0
- data/lib/ultracart_api/models/order_format.rb +14 -4
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: df302e3898f3fc0fa6dbc0e010e3001f627be73444d6a91535e80a7002e92b76
|
|
4
|
+
data.tar.gz: 36525ac1da31cb0764b677a015e71e9cd62276dcc491e49bca2ae57d1605f03b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a2341264abced64fb369ae0c4bbb1155411d6f59febd1f988e621e8ffd969305233dc310935bd7a186e7b215fb7ca26e0844ec64fc9a53f7e040fa1e7e9a5deb
|
|
7
|
+
data.tar.gz: beee16e4700e309ee68e985b187b97e80b3505bebb2dabf713581d4bc1b806f4be23436cb5648c8e8cadb489771e28ecbc747b3b6354a419146d751fb5f18b9e
|
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.76
|
|
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.76'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -84,6 +84,7 @@ Class | Method | HTTP request | Description
|
|
|
84
84
|
------------ | ------------- | ------------- | -------------
|
|
85
85
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
|
86
86
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
|
87
|
+
*UltracartClient::AutoOrderApi* | [**cancel_auto_order_item_by_reference_order_id**](docs/AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order
|
|
87
88
|
*UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
|
|
88
89
|
*UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
|
|
89
90
|
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
|
@@ -261,6 +262,10 @@ Class | Method | HTTP request | Description
|
|
|
261
262
|
*UltracartClient::ConversationApi* | [**update_user_pbx_audio**](docs/ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio
|
|
262
263
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
|
|
263
264
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
|
265
|
+
*UltracartClient::ConversationEmbedApi* | [**embed_oauth_device_authorize**](docs/ConversationEmbedApi.md#embed_oauth_device_authorize) | **POST** /conversation_embed/oauth/device/authorize | Initiate a device authorization flow for an embed widget.
|
|
266
|
+
*UltracartClient::ConversationEmbedApi* | [**embed_oauth_revoke**](docs/ConversationEmbedApi.md#embed_oauth_revoke) | **POST** /conversation_embed/oauth/device/revoke | Revoke an embed widget access or refresh token.
|
|
267
|
+
*UltracartClient::ConversationEmbedApi* | [**embed_oauth_token**](docs/ConversationEmbedApi.md#embed_oauth_token) | **POST** /conversation_embed/oauth/device/token | Exchange a device_code or refresh_token for an access token (embed widget).
|
|
268
|
+
*UltracartClient::ConversationEmbedApi* | [**get_embed_pbx_auth**](docs/ConversationEmbedApi.md#get_embed_pbx_auth) | **PUT** /conversation_embed/pbx-auth | Get PBX authorization for the embedded softphone widget.
|
|
264
269
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
265
270
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
|
266
271
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
|
@@ -691,6 +696,7 @@ Class | Method | HTTP request | Description
|
|
|
691
696
|
- [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
|
|
692
697
|
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
|
693
698
|
- [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
|
|
699
|
+
- [UltracartClient::AutoOrderItemCancelRequest](docs/AutoOrderItemCancelRequest.md)
|
|
694
700
|
- [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
|
|
695
701
|
- [UltracartClient::AutoOrderItemOption](docs/AutoOrderItemOption.md)
|
|
696
702
|
- [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
|
|
@@ -813,6 +819,7 @@ Class | Method | HTTP request | Description
|
|
|
813
819
|
- [UltracartClient::ConversationDepartmentMembersResponse](docs/ConversationDepartmentMembersResponse.md)
|
|
814
820
|
- [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
|
|
815
821
|
- [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
|
|
822
|
+
- [UltracartClient::ConversationEmbedPbxAuthResponse](docs/ConversationEmbedPbxAuthResponse.md)
|
|
816
823
|
- [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
|
|
817
824
|
- [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
|
|
818
825
|
- [UltracartClient::ConversationEngagementEquationFunction](docs/ConversationEngagementEquationFunction.md)
|
|
@@ -1690,6 +1697,9 @@ Not every change is committed to every SDK.
|
|
|
1690
1697
|
|
|
1691
1698
|
| Version | Date | Comments |
|
|
1692
1699
|
| --: | :-: | --- |
|
|
1700
|
+
| 4.1.76 | 04/17/2026 | conversation - embed oauth methods |
|
|
1701
|
+
| 4.1.75 | 04/17/2026 | conversation - embed oauth methods |
|
|
1702
|
+
| 4.1.74 | 04/15/2026 | auto order - new method cancelAutoOrderItemByReferenceOrderId |
|
|
1693
1703
|
| 4.1.73 | 04/13/2026 | conversation pbx - queue configuration for ai summary and call record zoho desk |
|
|
1694
1704
|
| 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
|
|
1695
1705
|
| 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**cancel_auto_order_item_by_reference_order_id**](AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order |
|
|
7
8
|
| [**consolidate_auto_orders**](AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders |
|
|
8
9
|
| [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id |
|
|
9
10
|
| [**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid |
|
|
@@ -20,6 +21,62 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
20
21
|
| [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
|
|
21
22
|
|
|
22
23
|
|
|
24
|
+
## cancel_auto_order_item_by_reference_order_id
|
|
25
|
+
|
|
26
|
+
> <AutoOrderResponse> cancel_auto_order_item_by_reference_order_id(reference_order_id, original_item_id, opts)
|
|
27
|
+
|
|
28
|
+
Cancel a single item on an auto order
|
|
29
|
+
|
|
30
|
+
Cancels a single item on an auto order identified by the original order id and the item's original_item_id. The request body may specify mode=_end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Examples
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
(No example for this operation).
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
#### Using the cancel_auto_order_item_by_reference_order_id_with_http_info variant
|
|
40
|
+
|
|
41
|
+
This returns an Array which contains the response data, status code and headers.
|
|
42
|
+
|
|
43
|
+
> <Array(<AutoOrderResponse>, Integer, Hash)> cancel_auto_order_item_by_reference_order_id_with_http_info(reference_order_id, original_item_id, opts)
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
begin
|
|
47
|
+
# Cancel a single item on an auto order
|
|
48
|
+
data, status_code, headers = api_instance.cancel_auto_order_item_by_reference_order_id_with_http_info(reference_order_id, original_item_id, opts)
|
|
49
|
+
p status_code # => 2xx
|
|
50
|
+
p headers # => { ... }
|
|
51
|
+
p data # => <AutoOrderResponse>
|
|
52
|
+
rescue UltracartClient::ApiError => e
|
|
53
|
+
puts "Error when calling AutoOrderApi->cancel_auto_order_item_by_reference_order_id_with_http_info: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
| Name | Type | Description | Notes |
|
|
60
|
+
| ---- | ---- | ----------- | ----- |
|
|
61
|
+
| **reference_order_id** | **String** | The reference order id (original_order_id) of the auto order. | |
|
|
62
|
+
| **original_item_id** | **String** | The original_item_id (SKU) of the item to cancel. | |
|
|
63
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
64
|
+
| **auto_order_item_cancel_request** | [**AutoOrderItemCancelRequest**](AutoOrderItemCancelRequest.md) | Cancel request. Body is optional; omit for default mode=_end. | [optional] |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
23
80
|
## consolidate_auto_orders
|
|
24
81
|
|
|
25
82
|
> <AutoOrderResponse> consolidate_auto_orders(auto_order_oid, auto_order_consolidate, opts)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderItemCancelRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. | [optional] |
|
|
8
|
+
| **mode** | **String** | Cancellation mode. 'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting. 'remove' hard-deletes the item from the auto order. Defaults to 'end' (the less destructive option) when omitted. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::AutoOrderItemCancelRequest.new(
|
|
16
|
+
auto_order_item_oid: null,
|
|
17
|
+
mode: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# UltracartClient::ConversationEmbedApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**embed_oauth_device_authorize**](ConversationEmbedApi.md#embed_oauth_device_authorize) | **POST** /conversation_embed/oauth/device/authorize | Initiate a device authorization flow for an embed widget. |
|
|
8
|
+
| [**embed_oauth_revoke**](ConversationEmbedApi.md#embed_oauth_revoke) | **POST** /conversation_embed/oauth/device/revoke | Revoke an embed widget access or refresh token. |
|
|
9
|
+
| [**embed_oauth_token**](ConversationEmbedApi.md#embed_oauth_token) | **POST** /conversation_embed/oauth/device/token | Exchange a device_code or refresh_token for an access token (embed widget). |
|
|
10
|
+
| [**get_embed_pbx_auth**](ConversationEmbedApi.md#get_embed_pbx_auth) | **PUT** /conversation_embed/pbx-auth | Get PBX authorization for the embedded softphone widget. |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## embed_oauth_device_authorize
|
|
14
|
+
|
|
15
|
+
> embed_oauth_device_authorize(client_id, scope)
|
|
16
|
+
|
|
17
|
+
Initiate a device authorization flow for an embed widget.
|
|
18
|
+
|
|
19
|
+
RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted.
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
(No example for this operation).
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
#### Using the embed_oauth_device_authorize_with_http_info variant
|
|
29
|
+
|
|
30
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
31
|
+
|
|
32
|
+
> <Array(nil, Integer, Hash)> embed_oauth_device_authorize_with_http_info(client_id, scope)
|
|
33
|
+
|
|
34
|
+
```ruby
|
|
35
|
+
begin
|
|
36
|
+
# Initiate a device authorization flow for an embed widget.
|
|
37
|
+
data, status_code, headers = api_instance.embed_oauth_device_authorize_with_http_info(client_id, scope)
|
|
38
|
+
p status_code # => 2xx
|
|
39
|
+
p headers # => { ... }
|
|
40
|
+
p data # => nil
|
|
41
|
+
rescue UltracartClient::ApiError => e
|
|
42
|
+
puts "Error when calling ConversationEmbedApi->embed_oauth_device_authorize_with_http_info: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
| Name | Type | Description | Notes |
|
|
49
|
+
| ---- | ---- | ----------- | ----- |
|
|
50
|
+
| **client_id** | **String** | The embed widget OAuth client_id. | |
|
|
51
|
+
| **scope** | **String** | The application-level scope (must be 'crm_embed'). | |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
nil (empty response body)
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## embed_oauth_revoke
|
|
68
|
+
|
|
69
|
+
> embed_oauth_revoke(client_id, token)
|
|
70
|
+
|
|
71
|
+
Revoke an embed widget access or refresh token.
|
|
72
|
+
|
|
73
|
+
RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the 'token' parameter.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### Examples
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
(No example for this operation).
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
#### Using the embed_oauth_revoke_with_http_info variant
|
|
83
|
+
|
|
84
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
85
|
+
|
|
86
|
+
> <Array(nil, Integer, Hash)> embed_oauth_revoke_with_http_info(client_id, token)
|
|
87
|
+
|
|
88
|
+
```ruby
|
|
89
|
+
begin
|
|
90
|
+
# Revoke an embed widget access or refresh token.
|
|
91
|
+
data, status_code, headers = api_instance.embed_oauth_revoke_with_http_info(client_id, token)
|
|
92
|
+
p status_code # => 2xx
|
|
93
|
+
p headers # => { ... }
|
|
94
|
+
p data # => nil
|
|
95
|
+
rescue UltracartClient::ApiError => e
|
|
96
|
+
puts "Error when calling ConversationEmbedApi->embed_oauth_revoke_with_http_info: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
| Name | Type | Description | Notes |
|
|
103
|
+
| ---- | ---- | ----------- | ----- |
|
|
104
|
+
| **client_id** | **String** | The embed widget OAuth client_id. | |
|
|
105
|
+
| **token** | **String** | The token to revoke (access token or refresh token). | |
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
nil (empty response body)
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
## embed_oauth_token
|
|
122
|
+
|
|
123
|
+
> embed_oauth_token(client_id, grant_type, opts)
|
|
124
|
+
|
|
125
|
+
Exchange a device_code or refresh_token for an access token (embed widget).
|
|
126
|
+
|
|
127
|
+
Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
### Examples
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
(No example for this operation).
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
#### Using the embed_oauth_token_with_http_info variant
|
|
137
|
+
|
|
138
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
139
|
+
|
|
140
|
+
> <Array(nil, Integer, Hash)> embed_oauth_token_with_http_info(client_id, grant_type, opts)
|
|
141
|
+
|
|
142
|
+
```ruby
|
|
143
|
+
begin
|
|
144
|
+
# Exchange a device_code or refresh_token for an access token (embed widget).
|
|
145
|
+
data, status_code, headers = api_instance.embed_oauth_token_with_http_info(client_id, grant_type, opts)
|
|
146
|
+
p status_code # => 2xx
|
|
147
|
+
p headers # => { ... }
|
|
148
|
+
p data # => nil
|
|
149
|
+
rescue UltracartClient::ApiError => e
|
|
150
|
+
puts "Error when calling ConversationEmbedApi->embed_oauth_token_with_http_info: #{e}"
|
|
151
|
+
end
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
| Name | Type | Description | Notes |
|
|
157
|
+
| ---- | ---- | ----------- | ----- |
|
|
158
|
+
| **client_id** | **String** | The embed widget OAuth client_id. | |
|
|
159
|
+
| **grant_type** | **String** | Grant type. | |
|
|
160
|
+
| **device_code** | **String** | The device code received from /oauth/device/authorize (required for device_code grant). | [optional] |
|
|
161
|
+
| **refresh_token** | **String** | The refresh token (required for refresh_token grant). | [optional] |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
nil (empty response body)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
## get_embed_pbx_auth
|
|
178
|
+
|
|
179
|
+
> <ConversationEmbedPbxAuthResponse> get_embed_pbx_auth
|
|
180
|
+
|
|
181
|
+
Get PBX authorization for the embedded softphone widget.
|
|
182
|
+
|
|
183
|
+
Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### Examples
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
(No example for this operation).
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
#### Using the get_embed_pbx_auth_with_http_info variant
|
|
193
|
+
|
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
|
195
|
+
|
|
196
|
+
> <Array(<ConversationEmbedPbxAuthResponse>, Integer, Hash)> get_embed_pbx_auth_with_http_info
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
begin
|
|
200
|
+
# Get PBX authorization for the embedded softphone widget.
|
|
201
|
+
data, status_code, headers = api_instance.get_embed_pbx_auth_with_http_info
|
|
202
|
+
p status_code # => 2xx
|
|
203
|
+
p headers # => { ... }
|
|
204
|
+
p data # => <ConversationEmbedPbxAuthResponse>
|
|
205
|
+
rescue UltracartClient::ApiError => e
|
|
206
|
+
puts "Error when calling ConversationEmbedApi->get_embed_pbx_auth_with_http_info: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
This endpoint does not need any parameter.
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**ConversationEmbedPbxAuthResponse**](ConversationEmbedPbxAuthResponse.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
[ultraCartOauth](../README.md#ultraCartOauth)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::ConversationEmbedPbxAuthResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **merchant_id** | **String** | Merchant identifier the agent belongs to. | [optional] |
|
|
8
|
+
| **pbx_admin** | **Boolean** | True if this agent has PBX admin privileges. | [optional] |
|
|
9
|
+
| **pbx_jwt** | **String** | JWT used by the softphone widget to authenticate to the PBX WebSocket relay. | [optional] |
|
|
10
|
+
| **pbx_supervisor** | **Boolean** | True if this agent has PBX supervisor privileges. | [optional] |
|
|
11
|
+
| **pbx_user** | **Boolean** | True if this agent has baseline PBX access. | [optional] |
|
|
12
|
+
| **pbx_voice_identity** | **String** | Voice identity string identifying this agent to the PBX (e.g., client:user_123). | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::ConversationEmbedPbxAuthResponse.new(
|
|
20
|
+
merchant_id: null,
|
|
21
|
+
pbx_admin: null,
|
|
22
|
+
pbx_jwt: null,
|
|
23
|
+
pbx_supervisor: null,
|
|
24
|
+
pbx_user: null,
|
|
25
|
+
pbx_voice_identity: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/OrderFormat.md
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
| **show_non_sensitive_payment_info** | **Boolean** | True to show non-sensitive payment information | [optional] |
|
|
21
21
|
| **show_payment_info** | **Boolean** | True to show payment information | [optional] |
|
|
22
22
|
| **translate** | **Boolean** | True to translate the order into the native language of the customer | [optional] |
|
|
23
|
+
| **use_phone_number_web_component** | **Boolean** | True to render phone numbers as <phone-number-format> web components in the HTML output. Only honored by the div format. Default false preserves legacy scalar rendering for receipts and unauthenticated consumers. | [optional] |
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -42,7 +43,8 @@ instance = UltracartClient::OrderFormat.new(
|
|
|
42
43
|
show_merchant_notes: null,
|
|
43
44
|
show_non_sensitive_payment_info: null,
|
|
44
45
|
show_payment_info: null,
|
|
45
|
-
translate: null
|
|
46
|
+
translate: null,
|
|
47
|
+
use_phone_number_web_component: null
|
|
46
48
|
)
|
|
47
49
|
```
|
|
48
50
|
|
|
@@ -32,6 +32,86 @@ module UltracartClient
|
|
|
32
32
|
UltracartClient::AutoOrderApi.new(api_client)
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# Cancel a single item on an auto order
|
|
36
|
+
# Cancels a single item on an auto order identified by the original order id and the item's original_item_id. The request body may specify mode=_end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
|
|
37
|
+
# @param reference_order_id [String] The reference order id (original_order_id) of the auto order.
|
|
38
|
+
# @param original_item_id [String] The original_item_id (SKU) of the item to cancel.
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
41
|
+
# @option opts [AutoOrderItemCancelRequest] :auto_order_item_cancel_request Cancel request. Body is optional; omit for default mode=_end.
|
|
42
|
+
# @return [AutoOrderResponse]
|
|
43
|
+
def cancel_auto_order_item_by_reference_order_id(reference_order_id, original_item_id, opts = {})
|
|
44
|
+
data, _status_code, _headers = cancel_auto_order_item_by_reference_order_id_with_http_info(reference_order_id, original_item_id, opts)
|
|
45
|
+
data
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Cancel a single item on an auto order
|
|
49
|
+
# Cancels a single item on an auto order identified by the original order id and the item's original_item_id. The request body may specify mode=_end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
|
|
50
|
+
# @param reference_order_id [String] The reference order id (original_order_id) of the auto order.
|
|
51
|
+
# @param original_item_id [String] The original_item_id (SKU) of the item to cancel.
|
|
52
|
+
# @param [Hash] opts the optional parameters
|
|
53
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
54
|
+
# @option opts [AutoOrderItemCancelRequest] :auto_order_item_cancel_request Cancel request. Body is optional; omit for default mode=_end.
|
|
55
|
+
# @return [Array<(AutoOrderResponse, Integer, Hash)>] AutoOrderResponse data, response status code and response headers
|
|
56
|
+
def cancel_auto_order_item_by_reference_order_id_with_http_info(reference_order_id, original_item_id, opts = {})
|
|
57
|
+
if @api_client.config.debugging
|
|
58
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.cancel_auto_order_item_by_reference_order_id ...'
|
|
59
|
+
end
|
|
60
|
+
# verify the required parameter 'reference_order_id' is set
|
|
61
|
+
if @api_client.config.client_side_validation && reference_order_id.nil?
|
|
62
|
+
fail ArgumentError, "Missing the required parameter 'reference_order_id' when calling AutoOrderApi.cancel_auto_order_item_by_reference_order_id"
|
|
63
|
+
end
|
|
64
|
+
# verify the required parameter 'original_item_id' is set
|
|
65
|
+
if @api_client.config.client_side_validation && original_item_id.nil?
|
|
66
|
+
fail ArgumentError, "Missing the required parameter 'original_item_id' when calling AutoOrderApi.cancel_auto_order_item_by_reference_order_id"
|
|
67
|
+
end
|
|
68
|
+
# resource path
|
|
69
|
+
local_var_path = '/auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel'.sub('{' + 'reference_order_id' + '}', CGI.escape(reference_order_id.to_s)).sub('{' + 'original_item_id' + '}', CGI.escape(original_item_id.to_s))
|
|
70
|
+
|
|
71
|
+
# query parameters
|
|
72
|
+
query_params = opts[:query_params] || {}
|
|
73
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
74
|
+
|
|
75
|
+
# header parameters
|
|
76
|
+
header_params = opts[:header_params] || {}
|
|
77
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
78
|
+
# HTTP header 'Accept' (if needed)
|
|
79
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
80
|
+
# HTTP header 'Content-Type'
|
|
81
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
82
|
+
if !content_type.nil?
|
|
83
|
+
header_params['Content-Type'] = content_type
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# form parameters
|
|
87
|
+
form_params = opts[:form_params] || {}
|
|
88
|
+
|
|
89
|
+
# http body (model)
|
|
90
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'auto_order_item_cancel_request'])
|
|
91
|
+
|
|
92
|
+
# return_type
|
|
93
|
+
return_type = opts[:debug_return_type] || 'AutoOrderResponse'
|
|
94
|
+
|
|
95
|
+
# auth_names
|
|
96
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
97
|
+
|
|
98
|
+
new_options = opts.merge(
|
|
99
|
+
:operation => :"AutoOrderApi.cancel_auto_order_item_by_reference_order_id",
|
|
100
|
+
:header_params => header_params,
|
|
101
|
+
:query_params => query_params,
|
|
102
|
+
:form_params => form_params,
|
|
103
|
+
:body => post_body,
|
|
104
|
+
:auth_names => auth_names,
|
|
105
|
+
:return_type => return_type
|
|
106
|
+
)
|
|
107
|
+
|
|
108
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
109
|
+
if @api_client.config.debugging
|
|
110
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#cancel_auto_order_item_by_reference_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
111
|
+
end
|
|
112
|
+
return data, status_code, headers
|
|
113
|
+
end
|
|
114
|
+
|
|
35
115
|
# Consolidates multiple auto orders
|
|
36
116
|
# Consolidates mutliple auto orders on the UltraCart account.
|
|
37
117
|
# @param auto_order_oid [Integer] The auto order oid to consolidate into.
|