ultracart_api 4.1.67 → 4.1.69
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 +11 -2
- data/docs/ConversationApi.md +269 -0
- data/docs/OauthApi.md +56 -0
- data/docs/OauthDeviceAuthorizationResponse.md +28 -0
- data/docs/PointOfSaleLocation.md +3 -1
- data/lib/ultracart_api/api/conversation_api.rb +330 -0
- data/lib/ultracart_api/api/oauth_api.rb +80 -0
- data/lib/ultracart_api/models/oauth_device_authorization_response.rb +270 -0
- data/lib/ultracart_api/models/point_of_sale_location.rb +29 -4
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e481d72fdb9738e46385d225e85885a2f5eef1d5adf3184d9c0c91bcfe7ce5e6
|
|
4
|
+
data.tar.gz: a8c6c2a8e07465c0f7fca61546290144b22ff43825955a96a2ade115ceb88bee
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c93744277b4d469e168a557f7f4681bee3e084c9658c5ead3895b1d3f9b309a5e234fcb7fcca259fb55a5dbd73c9fe8ac603f2a14ea45b31fc0a5312c691623f
|
|
7
|
+
data.tar.gz: dfb4dc33f05e7d93b7c7a87150aa99fb540c004c7a0784726b1187689e40f459e06efe8cdd86e548cad160945d0dc4c3d7b64e26c3d109bf01c6da89423c5d50
|
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.69
|
|
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.69'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -149,6 +149,7 @@ Class | Method | HTTP request | Description
|
|
|
149
149
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
|
150
150
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
|
|
151
151
|
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
|
152
|
+
*UltracartClient::ConversationApi* | [**delete_user_pbx_audio**](docs/ConversationApi.md#delete_user_pbx_audio) | **DELETE** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Delete user pbx audio
|
|
152
153
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
153
154
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
154
155
|
*UltracartClient::ConversationApi* | [**get_agent_profile_knowledge_base**](docs/ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile
|
|
@@ -206,6 +207,8 @@ Class | Method | HTTP request | Description
|
|
|
206
207
|
*UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
|
207
208
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
|
208
209
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
|
210
|
+
*UltracartClient::ConversationApi* | [**get_user_pbx_audio**](docs/ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio
|
|
211
|
+
*UltracartClient::ConversationApi* | [**get_user_pbx_audios**](docs/ConversationApi.md#get_user_pbx_audios) | **GET** /conversation/pbx/audio/user | Get user pbx audios
|
|
209
212
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
210
213
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
211
214
|
*UltracartClient::ConversationApi* | [**insert_agent_profile_knowledge_base_document**](docs/ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
|
|
@@ -222,6 +225,7 @@ Class | Method | HTTP request | Description
|
|
|
222
225
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
|
|
223
226
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_range**](docs/ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
|
|
224
227
|
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
|
228
|
+
*UltracartClient::ConversationApi* | [**insert_user_pbx_audio**](docs/ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio
|
|
225
229
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
226
230
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
227
231
|
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
|
@@ -253,6 +257,7 @@ Class | Method | HTTP request | Description
|
|
|
253
257
|
*UltracartClient::ConversationApi* | [**update_pbx_time_based**](docs/ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
|
|
254
258
|
*UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
|
|
255
259
|
*UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
|
|
260
|
+
*UltracartClient::ConversationApi* | [**update_user_pbx_audio**](docs/ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio
|
|
256
261
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
|
|
257
262
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
|
258
263
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
@@ -375,6 +380,7 @@ Class | Method | HTTP request | Description
|
|
|
375
380
|
*UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
|
376
381
|
*UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
|
377
382
|
*UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
|
|
383
|
+
*UltracartClient::OauthApi* | [**oauth_device_authorize**](docs/OauthApi.md#oauth_device_authorize) | **POST** /oauth/device/authorize | Initiate a device authorization flow.
|
|
378
384
|
*UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
|
|
379
385
|
*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
|
|
380
386
|
*UltracartClient::OrderApi* | [**assign_to_affiliate**](docs/OrderApi.md#assign_to_affiliate) | **POST** /order/orders/{order_id}/assignToAffiliate | Assigns an order to an affiliate
|
|
@@ -1349,6 +1355,7 @@ Class | Method | HTTP request | Description
|
|
|
1349
1355
|
- [UltracartClient::Mailgun](docs/Mailgun.md)
|
|
1350
1356
|
- [UltracartClient::Metric](docs/Metric.md)
|
|
1351
1357
|
- [UltracartClient::Notification](docs/Notification.md)
|
|
1358
|
+
- [UltracartClient::OauthDeviceAuthorizationResponse](docs/OauthDeviceAuthorizationResponse.md)
|
|
1352
1359
|
- [UltracartClient::OauthRevokeSuccessResponse](docs/OauthRevokeSuccessResponse.md)
|
|
1353
1360
|
- [UltracartClient::OauthTokenResponse](docs/OauthTokenResponse.md)
|
|
1354
1361
|
- [UltracartClient::Order](docs/Order.md)
|
|
@@ -1679,6 +1686,8 @@ Not every change is committed to every SDK.
|
|
|
1679
1686
|
|
|
1680
1687
|
| Version | Date | Comments |
|
|
1681
1688
|
| --: | :-: | --- |
|
|
1689
|
+
| 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
|
|
1690
|
+
| 4.1.68 | 03/31/2026 | oauth - device support |
|
|
1682
1691
|
| 4.1.67 | 02/24/2026 | customer activity - sms and sms_stop fields added |
|
|
1683
1692
|
| 4.1.66 | 02/18/2026 | conversations - agent auth customer_profile flag |
|
|
1684
1693
|
| 4.1.65 | 02/16/2026 | item - include variant pricing in the response |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
21
21
|
| [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
|
|
22
22
|
| [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange |
|
|
23
23
|
| [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox |
|
|
24
|
+
| [**delete_user_pbx_audio**](ConversationApi.md#delete_user_pbx_audio) | **DELETE** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Delete user pbx audio |
|
|
24
25
|
| [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive |
|
|
25
26
|
| [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile |
|
|
26
27
|
| [**get_agent_profile_knowledge_base**](ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile |
|
|
@@ -78,6 +79,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
78
79
|
| [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges |
|
|
79
80
|
| [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox |
|
|
80
81
|
| [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes |
|
|
82
|
+
| [**get_user_pbx_audio**](ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio |
|
|
83
|
+
| [**get_user_pbx_audios**](ConversationApi.md#get_user_pbx_audios) | **GET** /conversation/pbx/audio/user | Get user pbx audios |
|
|
81
84
|
| [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget |
|
|
82
85
|
| [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities |
|
|
83
86
|
| [**insert_agent_profile_knowledge_base_document**](ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document |
|
|
@@ -94,6 +97,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
94
97
|
| [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased |
|
|
95
98
|
| [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange |
|
|
96
99
|
| [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox |
|
|
100
|
+
| [**insert_user_pbx_audio**](ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio |
|
|
97
101
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
|
98
102
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
|
99
103
|
| [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
|
|
@@ -125,6 +129,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
125
129
|
| [**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased |
|
|
126
130
|
| [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange |
|
|
127
131
|
| [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox |
|
|
132
|
+
| [**update_user_pbx_audio**](ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio |
|
|
128
133
|
| [**update_virtual_agent_budget**](ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget |
|
|
129
134
|
| [**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities |
|
|
130
135
|
|
|
@@ -1045,6 +1050,59 @@ end
|
|
|
1045
1050
|
- **Accept**: application/json
|
|
1046
1051
|
|
|
1047
1052
|
|
|
1053
|
+
## delete_user_pbx_audio
|
|
1054
|
+
|
|
1055
|
+
> <ConversationPbxAudioResponse> delete_user_pbx_audio(conversation_pbx_audio_uuid)
|
|
1056
|
+
|
|
1057
|
+
Delete user pbx audio
|
|
1058
|
+
|
|
1059
|
+
Delete a pbx audio file owned by the authenticated user
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
### Examples
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
(No example for this operation).
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
#### Using the delete_user_pbx_audio_with_http_info variant
|
|
1069
|
+
|
|
1070
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1071
|
+
|
|
1072
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
1073
|
+
|
|
1074
|
+
```ruby
|
|
1075
|
+
begin
|
|
1076
|
+
# Delete user pbx audio
|
|
1077
|
+
data, status_code, headers = api_instance.delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
1078
|
+
p status_code # => 2xx
|
|
1079
|
+
p headers # => { ... }
|
|
1080
|
+
p data # => <ConversationPbxAudioResponse>
|
|
1081
|
+
rescue UltracartClient::ApiError => e
|
|
1082
|
+
puts "Error when calling ConversationApi->delete_user_pbx_audio_with_http_info: #{e}"
|
|
1083
|
+
end
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
### Parameters
|
|
1087
|
+
|
|
1088
|
+
| Name | Type | Description | Notes |
|
|
1089
|
+
| ---- | ---- | ----------- | ----- |
|
|
1090
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
1091
|
+
|
|
1092
|
+
### Return type
|
|
1093
|
+
|
|
1094
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
1095
|
+
|
|
1096
|
+
### Authorization
|
|
1097
|
+
|
|
1098
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1099
|
+
|
|
1100
|
+
### HTTP request headers
|
|
1101
|
+
|
|
1102
|
+
- **Content-Type**: Not defined
|
|
1103
|
+
- **Accept**: application/json
|
|
1104
|
+
|
|
1105
|
+
|
|
1048
1106
|
## get_agent_keep_alive
|
|
1049
1107
|
|
|
1050
1108
|
> get_agent_keep_alive
|
|
@@ -4072,6 +4130,110 @@ This endpoint does not need any parameter.
|
|
|
4072
4130
|
- **Accept**: application/json
|
|
4073
4131
|
|
|
4074
4132
|
|
|
4133
|
+
## get_user_pbx_audio
|
|
4134
|
+
|
|
4135
|
+
> <ConversationPbxAudioResponse> get_user_pbx_audio(conversation_pbx_audio_uuid)
|
|
4136
|
+
|
|
4137
|
+
Get user pbx audio
|
|
4138
|
+
|
|
4139
|
+
Retrieve a pbx audio file owned by the authenticated user
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
### Examples
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
(No example for this operation).
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
#### Using the get_user_pbx_audio_with_http_info variant
|
|
4149
|
+
|
|
4150
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4151
|
+
|
|
4152
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
4153
|
+
|
|
4154
|
+
```ruby
|
|
4155
|
+
begin
|
|
4156
|
+
# Get user pbx audio
|
|
4157
|
+
data, status_code, headers = api_instance.get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
4158
|
+
p status_code # => 2xx
|
|
4159
|
+
p headers # => { ... }
|
|
4160
|
+
p data # => <ConversationPbxAudioResponse>
|
|
4161
|
+
rescue UltracartClient::ApiError => e
|
|
4162
|
+
puts "Error when calling ConversationApi->get_user_pbx_audio_with_http_info: #{e}"
|
|
4163
|
+
end
|
|
4164
|
+
```
|
|
4165
|
+
|
|
4166
|
+
### Parameters
|
|
4167
|
+
|
|
4168
|
+
| Name | Type | Description | Notes |
|
|
4169
|
+
| ---- | ---- | ----------- | ----- |
|
|
4170
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
4171
|
+
|
|
4172
|
+
### Return type
|
|
4173
|
+
|
|
4174
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
4175
|
+
|
|
4176
|
+
### Authorization
|
|
4177
|
+
|
|
4178
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4179
|
+
|
|
4180
|
+
### HTTP request headers
|
|
4181
|
+
|
|
4182
|
+
- **Content-Type**: Not defined
|
|
4183
|
+
- **Accept**: application/json
|
|
4184
|
+
|
|
4185
|
+
|
|
4186
|
+
## get_user_pbx_audios
|
|
4187
|
+
|
|
4188
|
+
> <ConversationPbxAudiosResponse> get_user_pbx_audios
|
|
4189
|
+
|
|
4190
|
+
Get user pbx audios
|
|
4191
|
+
|
|
4192
|
+
Retrieve pbx audio files owned by the authenticated user
|
|
4193
|
+
|
|
4194
|
+
|
|
4195
|
+
### Examples
|
|
4196
|
+
|
|
4197
|
+
|
|
4198
|
+
(No example for this operation).
|
|
4199
|
+
|
|
4200
|
+
|
|
4201
|
+
#### Using the get_user_pbx_audios_with_http_info variant
|
|
4202
|
+
|
|
4203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4204
|
+
|
|
4205
|
+
> <Array(<ConversationPbxAudiosResponse>, Integer, Hash)> get_user_pbx_audios_with_http_info
|
|
4206
|
+
|
|
4207
|
+
```ruby
|
|
4208
|
+
begin
|
|
4209
|
+
# Get user pbx audios
|
|
4210
|
+
data, status_code, headers = api_instance.get_user_pbx_audios_with_http_info
|
|
4211
|
+
p status_code # => 2xx
|
|
4212
|
+
p headers # => { ... }
|
|
4213
|
+
p data # => <ConversationPbxAudiosResponse>
|
|
4214
|
+
rescue UltracartClient::ApiError => e
|
|
4215
|
+
puts "Error when calling ConversationApi->get_user_pbx_audios_with_http_info: #{e}"
|
|
4216
|
+
end
|
|
4217
|
+
```
|
|
4218
|
+
|
|
4219
|
+
### Parameters
|
|
4220
|
+
|
|
4221
|
+
This endpoint does not need any parameter.
|
|
4222
|
+
|
|
4223
|
+
### Return type
|
|
4224
|
+
|
|
4225
|
+
[**ConversationPbxAudiosResponse**](ConversationPbxAudiosResponse.md)
|
|
4226
|
+
|
|
4227
|
+
### Authorization
|
|
4228
|
+
|
|
4229
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4230
|
+
|
|
4231
|
+
### HTTP request headers
|
|
4232
|
+
|
|
4233
|
+
- **Content-Type**: Not defined
|
|
4234
|
+
- **Accept**: application/json
|
|
4235
|
+
|
|
4236
|
+
|
|
4075
4237
|
## get_virtual_agent_budget
|
|
4076
4238
|
|
|
4077
4239
|
> <ConversationVirtualAgentBudgetResponse> get_virtual_agent_budget
|
|
@@ -4927,6 +5089,59 @@ end
|
|
|
4927
5089
|
- **Accept**: application/json
|
|
4928
5090
|
|
|
4929
5091
|
|
|
5092
|
+
## insert_user_pbx_audio
|
|
5093
|
+
|
|
5094
|
+
> <ConversationPbxAudioResponse> insert_user_pbx_audio(pbx_audio)
|
|
5095
|
+
|
|
5096
|
+
Insert user pbx audio
|
|
5097
|
+
|
|
5098
|
+
Insert a pbx audio file for the authenticated user
|
|
5099
|
+
|
|
5100
|
+
|
|
5101
|
+
### Examples
|
|
5102
|
+
|
|
5103
|
+
|
|
5104
|
+
(No example for this operation).
|
|
5105
|
+
|
|
5106
|
+
|
|
5107
|
+
#### Using the insert_user_pbx_audio_with_http_info variant
|
|
5108
|
+
|
|
5109
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5110
|
+
|
|
5111
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> insert_user_pbx_audio_with_http_info(pbx_audio)
|
|
5112
|
+
|
|
5113
|
+
```ruby
|
|
5114
|
+
begin
|
|
5115
|
+
# Insert user pbx audio
|
|
5116
|
+
data, status_code, headers = api_instance.insert_user_pbx_audio_with_http_info(pbx_audio)
|
|
5117
|
+
p status_code # => 2xx
|
|
5118
|
+
p headers # => { ... }
|
|
5119
|
+
p data # => <ConversationPbxAudioResponse>
|
|
5120
|
+
rescue UltracartClient::ApiError => e
|
|
5121
|
+
puts "Error when calling ConversationApi->insert_user_pbx_audio_with_http_info: #{e}"
|
|
5122
|
+
end
|
|
5123
|
+
```
|
|
5124
|
+
|
|
5125
|
+
### Parameters
|
|
5126
|
+
|
|
5127
|
+
| Name | Type | Description | Notes |
|
|
5128
|
+
| ---- | ---- | ----------- | ----- |
|
|
5129
|
+
| **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) | Pbx Audio | |
|
|
5130
|
+
|
|
5131
|
+
### Return type
|
|
5132
|
+
|
|
5133
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
5134
|
+
|
|
5135
|
+
### Authorization
|
|
5136
|
+
|
|
5137
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5138
|
+
|
|
5139
|
+
### HTTP request headers
|
|
5140
|
+
|
|
5141
|
+
- **Content-Type**: application/json
|
|
5142
|
+
- **Accept**: application/json
|
|
5143
|
+
|
|
5144
|
+
|
|
4930
5145
|
## join_conversation
|
|
4931
5146
|
|
|
4932
5147
|
> join_conversation(conversation_uuid, opts)
|
|
@@ -6621,6 +6836,60 @@ end
|
|
|
6621
6836
|
- **Accept**: application/json
|
|
6622
6837
|
|
|
6623
6838
|
|
|
6839
|
+
## update_user_pbx_audio
|
|
6840
|
+
|
|
6841
|
+
> <ConversationPbxAudioResponse> update_user_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
|
|
6842
|
+
|
|
6843
|
+
Update user pbx audio
|
|
6844
|
+
|
|
6845
|
+
Update a pbx audio file owned by the authenticated user
|
|
6846
|
+
|
|
6847
|
+
|
|
6848
|
+
### Examples
|
|
6849
|
+
|
|
6850
|
+
|
|
6851
|
+
(No example for this operation).
|
|
6852
|
+
|
|
6853
|
+
|
|
6854
|
+
#### Using the update_user_pbx_audio_with_http_info variant
|
|
6855
|
+
|
|
6856
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6857
|
+
|
|
6858
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio)
|
|
6859
|
+
|
|
6860
|
+
```ruby
|
|
6861
|
+
begin
|
|
6862
|
+
# Update user pbx audio
|
|
6863
|
+
data, status_code, headers = api_instance.update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio)
|
|
6864
|
+
p status_code # => 2xx
|
|
6865
|
+
p headers # => { ... }
|
|
6866
|
+
p data # => <ConversationPbxAudioResponse>
|
|
6867
|
+
rescue UltracartClient::ApiError => e
|
|
6868
|
+
puts "Error when calling ConversationApi->update_user_pbx_audio_with_http_info: #{e}"
|
|
6869
|
+
end
|
|
6870
|
+
```
|
|
6871
|
+
|
|
6872
|
+
### Parameters
|
|
6873
|
+
|
|
6874
|
+
| Name | Type | Description | Notes |
|
|
6875
|
+
| ---- | ---- | ----------- | ----- |
|
|
6876
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
6877
|
+
| **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) | Pbx Audio | |
|
|
6878
|
+
|
|
6879
|
+
### Return type
|
|
6880
|
+
|
|
6881
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
6882
|
+
|
|
6883
|
+
### Authorization
|
|
6884
|
+
|
|
6885
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6886
|
+
|
|
6887
|
+
### HTTP request headers
|
|
6888
|
+
|
|
6889
|
+
- **Content-Type**: application/json
|
|
6890
|
+
- **Accept**: application/json
|
|
6891
|
+
|
|
6892
|
+
|
|
6624
6893
|
## update_virtual_agent_budget
|
|
6625
6894
|
|
|
6626
6895
|
> <ConversationVirtualAgentBudgetResponse> update_virtual_agent_budget(virtual_agent_budget)
|
data/docs/OauthApi.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
|
| [**oauth_access_token**](OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token. |
|
|
8
|
+
| [**oauth_device_authorize**](OauthApi.md#oauth_device_authorize) | **POST** /oauth/device/authorize | Initiate a device authorization flow. |
|
|
8
9
|
| [**oauth_revoke**](OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application. |
|
|
9
10
|
|
|
10
11
|
|
|
@@ -107,6 +108,7 @@ end
|
|
|
107
108
|
| **code** | **String** | Authorization code received back from the browser redirect | [optional] |
|
|
108
109
|
| **redirect_uri** | **String** | The URI that you redirect the browser to start the authorization process | [optional] |
|
|
109
110
|
| **refresh_token** | **String** | The refresh token received during the original grant_type=authorization_code that can be used to return a new access token | [optional] |
|
|
111
|
+
| **device_code** | **String** | The device code received from /oauth/device/authorize | [optional] |
|
|
110
112
|
|
|
111
113
|
### Return type
|
|
112
114
|
|
|
@@ -122,6 +124,60 @@ end
|
|
|
122
124
|
- **Accept**: application/json
|
|
123
125
|
|
|
124
126
|
|
|
127
|
+
## oauth_device_authorize
|
|
128
|
+
|
|
129
|
+
> oauth_device_authorize(client_id, scope)
|
|
130
|
+
|
|
131
|
+
Initiate a device authorization flow.
|
|
132
|
+
|
|
133
|
+
Initiates the device authorization flow by returning a device code and user code. The device displays the user code to the merchant, who visits the verification URI to approve the request. RFC 8628.
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### Examples
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
(No example for this operation).
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
#### Using the oauth_device_authorize_with_http_info variant
|
|
143
|
+
|
|
144
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
145
|
+
|
|
146
|
+
> <Array(nil, Integer, Hash)> oauth_device_authorize_with_http_info(client_id, scope)
|
|
147
|
+
|
|
148
|
+
```ruby
|
|
149
|
+
begin
|
|
150
|
+
# Initiate a device authorization flow.
|
|
151
|
+
data, status_code, headers = api_instance.oauth_device_authorize_with_http_info(client_id, scope)
|
|
152
|
+
p status_code # => 2xx
|
|
153
|
+
p headers # => { ... }
|
|
154
|
+
p data # => nil
|
|
155
|
+
rescue UltracartClient::ApiError => e
|
|
156
|
+
puts "Error when calling OauthApi->oauth_device_authorize_with_http_info: #{e}"
|
|
157
|
+
end
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
| Name | Type | Description | Notes |
|
|
163
|
+
| ---- | ---- | ----------- | ----- |
|
|
164
|
+
| **client_id** | **String** | The OAuth application client_id. | |
|
|
165
|
+
| **scope** | **String** | The application-level scope (e.g., crm, ultraship). | |
|
|
166
|
+
|
|
167
|
+
### Return type
|
|
168
|
+
|
|
169
|
+
nil (empty response body)
|
|
170
|
+
|
|
171
|
+
### Authorization
|
|
172
|
+
|
|
173
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
174
|
+
|
|
175
|
+
### HTTP request headers
|
|
176
|
+
|
|
177
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
178
|
+
- **Accept**: application/json
|
|
179
|
+
|
|
180
|
+
|
|
125
181
|
## oauth_revoke
|
|
126
182
|
|
|
127
183
|
> <OauthRevokeSuccessResponse> oauth_revoke(client_id, token)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::OauthDeviceAuthorizationResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **device_code** | **String** | The device verification code | [optional] |
|
|
8
|
+
| **expires_in** | **Integer** | The lifetime in seconds of the device_code and user_code | [optional] |
|
|
9
|
+
| **interval** | **Integer** | The minimum amount of time in seconds the client should wait between polling requests | [optional] |
|
|
10
|
+
| **user_code** | **String** | The end-user verification code | [optional] |
|
|
11
|
+
| **verification_uri** | **String** | The end-user verification URI on the authorization server | [optional] |
|
|
12
|
+
| **verification_uri_complete** | **String** | The verification URI with the user code pre-filled | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::OauthDeviceAuthorizationResponse.new(
|
|
20
|
+
device_code: null,
|
|
21
|
+
expires_in: null,
|
|
22
|
+
interval: null,
|
|
23
|
+
user_code: null,
|
|
24
|
+
verification_uri: null,
|
|
25
|
+
verification_uri_complete: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/PointOfSaleLocation.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **pos_location_oid** | **Integer** | Object identifier of the point of sale location. | [optional] |
|
|
15
15
|
| **postal_code** | **String** | Postal code | [optional] |
|
|
16
16
|
| **state_province** | **String** | State/province | [optional] |
|
|
17
|
+
| **tax_county** | **String** | Tax county associated with this address. Need when a self managed tax configuration is being used. | [optional] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,7 +31,8 @@ instance = UltracartClient::PointOfSaleLocation.new(
|
|
|
30
31
|
merchant_id: null,
|
|
31
32
|
pos_location_oid: null,
|
|
32
33
|
postal_code: null,
|
|
33
|
-
state_province: null
|
|
34
|
+
state_province: null,
|
|
35
|
+
tax_county: null
|
|
34
36
|
)
|
|
35
37
|
```
|
|
36
38
|
|