ultracart_api 4.0.200 → 4.0.202
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 +88 -4
- data/docs/ConversationApi.md +3565 -549
- data/docs/ConversationPbxAgent.md +34 -0
- data/docs/ConversationPbxAgentResponse.md +26 -0
- data/docs/ConversationPbxAgentsResponse.md +26 -0
- data/docs/ConversationPbxAudio.md +34 -0
- data/docs/ConversationPbxAudioResponse.md +26 -0
- data/docs/ConversationPbxAudiosResponse.md +26 -0
- data/docs/ConversationPbxCustomerSnapshotRequest.md +32 -0
- data/docs/ConversationPbxCustomerSnapshotResponse.md +30 -0
- data/docs/ConversationPbxMenu.md +36 -0
- data/docs/ConversationPbxMenuMapping.md +24 -0
- data/docs/ConversationPbxMenuResponse.md +26 -0
- data/docs/ConversationPbxMenusResponse.md +26 -0
- data/docs/ConversationPbxPhoneNumber.md +26 -0
- data/docs/ConversationPbxPhoneNumberResponse.md +26 -0
- data/docs/ConversationPbxPhoneNumbersResponse.md +26 -0
- data/docs/ConversationPbxQueue.md +52 -0
- data/docs/ConversationPbxQueueMembers.md +20 -0
- data/docs/ConversationPbxQueueResponse.md +26 -0
- data/docs/ConversationPbxQueuesResponse.md +26 -0
- data/docs/ConversationPbxTimeBased.md +24 -0
- data/docs/ConversationPbxTimeBasedMapping.md +24 -0
- data/docs/ConversationPbxTimeBasedMappingConfig.md +20 -0
- data/docs/ConversationPbxTimeBasedResponse.md +26 -0
- data/docs/ConversationPbxTimeBasedsResponse.md +26 -0
- data/docs/ConversationPbxTimeRange.md +26 -0
- data/docs/ConversationPbxTimeRangeConfig.md +28 -0
- data/docs/ConversationPbxTimeRangeResponse.md +26 -0
- data/docs/ConversationPbxTimeRangesResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMailbox.md +38 -0
- data/docs/ConversationPbxVoicemailMailboxResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMailboxesResponse.md +26 -0
- data/docs/EmailSmsOrder.md +24 -0
- data/docs/EmailSmsOrdersResponse.md +26 -0
- data/docs/EmailSmsStat.md +76 -0
- data/docs/EmailStatSmsSummaryRequest.md +20 -0
- data/docs/EmailStatSmsSummaryResponse.md +26 -0
- data/docs/PricingTier.md +2 -0
- data/docs/StorefrontApi.md +152 -0
- data/docs/WorkflowApi.md +69 -0
- data/docs/WorkflowTaskTagsResponse.md +26 -0
- data/lib/ultracart_api/api/conversation_api.rb +3422 -649
- data/lib/ultracart_api/api/storefront_api.rb +156 -0
- data/lib/ultracart_api/api/workflow_api.rb +58 -0
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +360 -0
- data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_audio.rb +390 -0
- data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +283 -0
- data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +278 -0
- data/lib/ultracart_api/models/conversation_pbx_menu.rb +402 -0
- data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +250 -0
- data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +335 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +539 -0
- data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +232 -0
- data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based.rb +246 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +310 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +231 -0
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range.rb +322 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +270 -0
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +440 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +258 -0
- data/lib/ultracart_api/models/email_sms_order.rb +249 -0
- data/lib/ultracart_api/models/email_sms_orders_response.rb +258 -0
- data/lib/ultracart_api/models/email_sms_stat.rb +511 -0
- data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +230 -0
- data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +258 -0
- data/lib/ultracart_api/models/pricing_tier.rb +11 -1
- data/lib/ultracart_api/models/workflow_task_tags_response.rb +259 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +37 -0
- metadata +76 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e939a6711a94c20f3f4210b4c3a327d16fd53c492226a2bb7d12956d416e5a7
|
4
|
+
data.tar.gz: dd888c02f5c6df31e4f711ea06e87643a4899a1fa6a6889a922fb8136f3c97e6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d6f11387fe4b45c7714eda8c849f56ebe8cb9f4ce55c376b5e53b01f50ee2e884a7c5aee881cbf3889fa40e1c8c37736451f855f4871cc3ab0029035c7f434f
|
7
|
+
data.tar.gz: c829fb8296b79c36e0aff60a6031b7827279fcaeb3a7c58c35aff565648bf44a3b9ff437c7ce18dd4d2d0226d1ebaab1c38196f04453df428bdb378de3d4372f
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
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.0.
|
10
|
+
- Package version: 4.0.202
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.202.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.202.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.202'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -141,6 +141,14 @@ Class | Method | HTTP request | Description
|
|
141
141
|
*UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
142
142
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
143
143
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
144
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
145
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
146
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
147
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
148
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
|
149
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
150
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
|
151
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
144
152
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
145
153
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
146
154
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
@@ -153,15 +161,41 @@ Class | Method | HTTP request | Description
|
|
153
161
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
154
162
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
155
163
|
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
164
|
+
*UltracartClient::ConversationApi* | [**get_conversation_pbx_audio_upload_url**](docs/ConversationApi.md#get_conversation_pbx_audio_upload_url) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
|
165
|
+
*UltracartClient::ConversationApi* | [**get_conversation_pbx_customer_snapshot**](docs/ConversationApi.md#get_conversation_pbx_customer_snapshot) | **POST** /conversation/pbx/customer_snapshot | Get orders and customer information for a phone number
|
156
166
|
*UltracartClient::ConversationApi* | [**get_conversation_permissions**](docs/ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
|
157
167
|
*UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
158
168
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
159
169
|
*UltracartClient::ConversationApi* | [**get_conversations_autocomplete**](docs/ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
|
160
170
|
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
161
171
|
*UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
|
172
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
|
173
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
|
174
|
+
*UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
175
|
+
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
176
|
+
*UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
|
177
|
+
*UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
|
178
|
+
*UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
179
|
+
*UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
180
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
181
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queues**](docs/ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
|
182
|
+
*UltracartClient::ConversationApi* | [**get_pbx_time_based**](docs/ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
|
183
|
+
*UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
184
|
+
*UltracartClient::ConversationApi* | [**get_pbx_time_range**](docs/ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
|
185
|
+
*UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
186
|
+
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
187
|
+
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
162
188
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
163
189
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
164
190
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
191
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_agent**](docs/ConversationApi.md#insert_pbx_agent) | **POST** /conversation/pbx/agent | Insert pbx agent
|
192
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
|
193
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
|
194
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_phone_number**](docs/ConversationApi.md#insert_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Insert pbx phoneNumber
|
195
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
|
196
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
|
197
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_time_range**](docs/ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
|
198
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
165
199
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
166
200
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
167
201
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
@@ -173,6 +207,14 @@ Class | Method | HTTP request | Description
|
|
173
207
|
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
174
208
|
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
175
209
|
*UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
210
|
+
*UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
|
211
|
+
*UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
|
212
|
+
*UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
|
213
|
+
*UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
|
214
|
+
*UltracartClient::ConversationApi* | [**update_pbx_queue**](docs/ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
|
215
|
+
*UltracartClient::ConversationApi* | [**update_pbx_time_based**](docs/ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
|
216
|
+
*UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
|
217
|
+
*UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
|
176
218
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
177
219
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
178
220
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
@@ -342,6 +384,7 @@ Class | Method | HTTP request | Description
|
|
342
384
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
343
385
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
344
386
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
387
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_sms_stats**](docs/StorefrontApi.md#get_email_commseq_sms_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats | Get email communication sequence sms stats
|
345
388
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
346
389
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
347
390
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
@@ -383,6 +426,7 @@ Class | Method | HTTP request | Description
|
|
383
426
|
*UltracartClient::StorefrontApi* | [**get_email_sending_domain_status**](docs/StorefrontApi.md#get_email_sending_domain_status) | **POST** /storefront/email/sending_domains/{domain}/status | Get email sending domain status
|
384
427
|
*UltracartClient::StorefrontApi* | [**get_email_sending_domains**](docs/StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains
|
385
428
|
*UltracartClient::StorefrontApi* | [**get_email_settings**](docs/StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings
|
429
|
+
*UltracartClient::StorefrontApi* | [**get_email_sms_orders**](docs/StorefrontApi.md#get_email_sms_orders) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders | Get email sms orders
|
386
430
|
*UltracartClient::StorefrontApi* | [**get_email_template**](docs/StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template
|
387
431
|
*UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
388
432
|
*UltracartClient::StorefrontApi* | [**get_email_third_party_providers**](docs/StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
|
@@ -524,6 +568,7 @@ Class | Method | HTTP request | Description
|
|
524
568
|
*UltracartClient::WorkflowApi* | [**get_workflow_task**](docs/WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task
|
525
569
|
*UltracartClient::WorkflowApi* | [**get_workflow_task_attachment_upload_url**](docs/WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL
|
526
570
|
*UltracartClient::WorkflowApi* | [**get_workflow_task_by_object_type**](docs/WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id
|
571
|
+
*UltracartClient::WorkflowApi* | [**get_workflow_task_tags**](docs/WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags
|
527
572
|
*UltracartClient::WorkflowApi* | [**get_workflow_tasks**](docs/WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks
|
528
573
|
*UltracartClient::WorkflowApi* | [**insert_workflow_task**](docs/WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task
|
529
574
|
*UltracartClient::WorkflowApi* | [**update_workflow_task**](docs/WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task
|
@@ -699,6 +744,37 @@ Class | Method | HTTP request | Description
|
|
699
744
|
- [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
|
700
745
|
- [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
|
701
746
|
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
747
|
+
- [UltracartClient::ConversationPbxAgent](docs/ConversationPbxAgent.md)
|
748
|
+
- [UltracartClient::ConversationPbxAgentResponse](docs/ConversationPbxAgentResponse.md)
|
749
|
+
- [UltracartClient::ConversationPbxAgentsResponse](docs/ConversationPbxAgentsResponse.md)
|
750
|
+
- [UltracartClient::ConversationPbxAudio](docs/ConversationPbxAudio.md)
|
751
|
+
- [UltracartClient::ConversationPbxAudioResponse](docs/ConversationPbxAudioResponse.md)
|
752
|
+
- [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
|
753
|
+
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
754
|
+
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
755
|
+
- [UltracartClient::ConversationPbxMenu](docs/ConversationPbxMenu.md)
|
756
|
+
- [UltracartClient::ConversationPbxMenuMapping](docs/ConversationPbxMenuMapping.md)
|
757
|
+
- [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
|
758
|
+
- [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
|
759
|
+
- [UltracartClient::ConversationPbxPhoneNumber](docs/ConversationPbxPhoneNumber.md)
|
760
|
+
- [UltracartClient::ConversationPbxPhoneNumberResponse](docs/ConversationPbxPhoneNumberResponse.md)
|
761
|
+
- [UltracartClient::ConversationPbxPhoneNumbersResponse](docs/ConversationPbxPhoneNumbersResponse.md)
|
762
|
+
- [UltracartClient::ConversationPbxQueue](docs/ConversationPbxQueue.md)
|
763
|
+
- [UltracartClient::ConversationPbxQueueMembers](docs/ConversationPbxQueueMembers.md)
|
764
|
+
- [UltracartClient::ConversationPbxQueueResponse](docs/ConversationPbxQueueResponse.md)
|
765
|
+
- [UltracartClient::ConversationPbxQueuesResponse](docs/ConversationPbxQueuesResponse.md)
|
766
|
+
- [UltracartClient::ConversationPbxTimeBased](docs/ConversationPbxTimeBased.md)
|
767
|
+
- [UltracartClient::ConversationPbxTimeBasedMapping](docs/ConversationPbxTimeBasedMapping.md)
|
768
|
+
- [UltracartClient::ConversationPbxTimeBasedMappingConfig](docs/ConversationPbxTimeBasedMappingConfig.md)
|
769
|
+
- [UltracartClient::ConversationPbxTimeBasedResponse](docs/ConversationPbxTimeBasedResponse.md)
|
770
|
+
- [UltracartClient::ConversationPbxTimeBasedsResponse](docs/ConversationPbxTimeBasedsResponse.md)
|
771
|
+
- [UltracartClient::ConversationPbxTimeRange](docs/ConversationPbxTimeRange.md)
|
772
|
+
- [UltracartClient::ConversationPbxTimeRangeConfig](docs/ConversationPbxTimeRangeConfig.md)
|
773
|
+
- [UltracartClient::ConversationPbxTimeRangeResponse](docs/ConversationPbxTimeRangeResponse.md)
|
774
|
+
- [UltracartClient::ConversationPbxTimeRangesResponse](docs/ConversationPbxTimeRangesResponse.md)
|
775
|
+
- [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
|
776
|
+
- [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
|
777
|
+
- [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
|
702
778
|
- [UltracartClient::ConversationPermissions](docs/ConversationPermissions.md)
|
703
779
|
- [UltracartClient::ConversationPermissionsResponse](docs/ConversationPermissionsResponse.md)
|
704
780
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
@@ -921,9 +997,14 @@ Class | Method | HTTP request | Description
|
|
921
997
|
- [UltracartClient::EmailSendingDomainsResponse](docs/EmailSendingDomainsResponse.md)
|
922
998
|
- [UltracartClient::EmailSettings](docs/EmailSettings.md)
|
923
999
|
- [UltracartClient::EmailSettingsResponse](docs/EmailSettingsResponse.md)
|
1000
|
+
- [UltracartClient::EmailSmsOrder](docs/EmailSmsOrder.md)
|
1001
|
+
- [UltracartClient::EmailSmsOrdersResponse](docs/EmailSmsOrdersResponse.md)
|
1002
|
+
- [UltracartClient::EmailSmsStat](docs/EmailSmsStat.md)
|
924
1003
|
- [UltracartClient::EmailStat](docs/EmailStat.md)
|
925
1004
|
- [UltracartClient::EmailStatPostcardSummaryRequest](docs/EmailStatPostcardSummaryRequest.md)
|
926
1005
|
- [UltracartClient::EmailStatPostcardSummaryResponse](docs/EmailStatPostcardSummaryResponse.md)
|
1006
|
+
- [UltracartClient::EmailStatSmsSummaryRequest](docs/EmailStatSmsSummaryRequest.md)
|
1007
|
+
- [UltracartClient::EmailStatSmsSummaryResponse](docs/EmailStatSmsSummaryResponse.md)
|
927
1008
|
- [UltracartClient::EmailStatSummaryRequest](docs/EmailStatSummaryRequest.md)
|
928
1009
|
- [UltracartClient::EmailStatSummaryResponse](docs/EmailStatSummaryResponse.md)
|
929
1010
|
- [UltracartClient::EmailStepStat](docs/EmailStepStat.md)
|
@@ -1326,6 +1407,7 @@ Class | Method | HTTP request | Description
|
|
1326
1407
|
- [UltracartClient::WorkflowTask](docs/WorkflowTask.md)
|
1327
1408
|
- [UltracartClient::WorkflowTaskHistory](docs/WorkflowTaskHistory.md)
|
1328
1409
|
- [UltracartClient::WorkflowTaskResponse](docs/WorkflowTaskResponse.md)
|
1410
|
+
- [UltracartClient::WorkflowTaskTagsResponse](docs/WorkflowTaskTagsResponse.md)
|
1329
1411
|
- [UltracartClient::WorkflowTasksRequest](docs/WorkflowTasksRequest.md)
|
1330
1412
|
- [UltracartClient::WorkflowTasksResponse](docs/WorkflowTasksResponse.md)
|
1331
1413
|
- [UltracartClient::WorkflowUser](docs/WorkflowUser.md)
|
@@ -1406,6 +1488,8 @@ Not every change is committed to every SDK.
|
|
1406
1488
|
|
1407
1489
|
| Version | Date | Comments |
|
1408
1490
|
| --: | :-: | --- |
|
1491
|
+
| 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
|
1492
|
+
| 4.0.201 | 02/27/2024 | esp - sms statistic layer |
|
1409
1493
|
| 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
|
1410
1494
|
| 4.0.199 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
|
1411
1495
|
| 4.0.198 | 01/12/2024 | workflow task - add properties array |
|