ultracart_api 3.10.117 → 3.10.118
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/docs/ConversationApi.md +50 -0
- data/lib/ultracart_api/api/conversation_api.rb +54 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2a1e12c962ef45d3a3abdd0c2d436029ed9955b6017086ee23bb1c0162a60ff2
|
4
|
+
data.tar.gz: 32d4887c8eefe35d745959c1d5b7b32aa03f6fd3b852531b23931c172cf43d2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ec19b5df3ef7cce59ac26e5aa6a8930d32207e024f73b804ed8fafe942a3c0a37ab2684cbaf4914bfddfafa4c63018785a51301613a6dc842fd2a368d5a441b0
|
7
|
+
data.tar.gz: e1b971890362d6502fa47bc9050eaa34f9c107619e41f380d31be876c7c3718ae8216af4b87b1144c6efa49d9bd00b9029dc63c6e8de63ba851e7cd0de9832d7
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.118
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.118.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.118.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.118'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -159,6 +159,7 @@ Class | Method | HTTP request | Description
|
|
159
159
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
160
160
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
161
161
|
*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
162
|
+
*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
162
163
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
163
164
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
164
165
|
*UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
@@ -1301,6 +1302,7 @@ Not every change is committed to every SDK.
|
|
1301
1302
|
|
1302
1303
|
| Version | Date | Comments |
|
1303
1304
|
| --: | :-: | --- |
|
1305
|
+
| 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
|
1304
1306
|
| 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
|
1305
1307
|
| 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
|
1306
1308
|
| 3.10.115 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
data/docs/ConversationApi.md
CHANGED
@@ -32,6 +32,7 @@ Method | HTTP request | Description
|
|
32
32
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
33
33
|
[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
34
34
|
[**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
35
|
+
[**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
35
36
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
36
37
|
[**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
37
38
|
[**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
@@ -1405,6 +1406,55 @@ Name | Type | Description | Notes
|
|
1405
1406
|
|
1406
1407
|
|
1407
1408
|
|
1409
|
+
# **sms_unsubscribe_conversation**
|
1410
|
+
> sms_unsubscribe_conversation(conversation_uuid)
|
1411
|
+
|
1412
|
+
Unsubscribe any SMS participants in this conversation
|
1413
|
+
|
1414
|
+
Unsubscribe any SMS participants in this conversation
|
1415
|
+
|
1416
|
+
### Example
|
1417
|
+
```ruby
|
1418
|
+
# load the gem
|
1419
|
+
require 'ultracart_api'
|
1420
|
+
|
1421
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1422
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1423
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1424
|
+
|
1425
|
+
|
1426
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
1427
|
+
|
1428
|
+
|
1429
|
+
begin
|
1430
|
+
#Unsubscribe any SMS participants in this conversation
|
1431
|
+
api_instance.sms_unsubscribe_conversation(conversation_uuid)
|
1432
|
+
rescue UltracartClient::ApiError => e
|
1433
|
+
puts "Exception when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
|
1434
|
+
end
|
1435
|
+
```
|
1436
|
+
|
1437
|
+
### Parameters
|
1438
|
+
|
1439
|
+
Name | Type | Description | Notes
|
1440
|
+
------------- | ------------- | ------------- | -------------
|
1441
|
+
**conversation_uuid** | **String**| |
|
1442
|
+
|
1443
|
+
### Return type
|
1444
|
+
|
1445
|
+
nil (empty response body)
|
1446
|
+
|
1447
|
+
### Authorization
|
1448
|
+
|
1449
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1450
|
+
|
1451
|
+
### HTTP request headers
|
1452
|
+
|
1453
|
+
- **Content-Type**: application/json
|
1454
|
+
- **Accept**: application/json
|
1455
|
+
|
1456
|
+
|
1457
|
+
|
1408
1458
|
# **start_conversation**
|
1409
1459
|
> ConversationStartResponse start_conversation(start_request)
|
1410
1460
|
|
@@ -1525,6 +1525,60 @@ module UltracartClient
|
|
1525
1525
|
end
|
1526
1526
|
return data, status_code, headers
|
1527
1527
|
end
|
1528
|
+
# Unsubscribe any SMS participants in this conversation
|
1529
|
+
# Unsubscribe any SMS participants in this conversation
|
1530
|
+
# @param conversation_uuid
|
1531
|
+
# @param [Hash] opts the optional parameters
|
1532
|
+
# @return [nil]
|
1533
|
+
def sms_unsubscribe_conversation(conversation_uuid, opts = {})
|
1534
|
+
sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
|
1535
|
+
nil
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# Unsubscribe any SMS participants in this conversation
|
1539
|
+
# Unsubscribe any SMS participants in this conversation
|
1540
|
+
# @param conversation_uuid
|
1541
|
+
# @param [Hash] opts the optional parameters
|
1542
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1543
|
+
def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
|
1544
|
+
if @api_client.config.debugging
|
1545
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
|
1546
|
+
end
|
1547
|
+
# verify the required parameter 'conversation_uuid' is set
|
1548
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
1549
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
|
1550
|
+
end
|
1551
|
+
# resource path
|
1552
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
|
1553
|
+
|
1554
|
+
# query parameters
|
1555
|
+
query_params = {}
|
1556
|
+
|
1557
|
+
# header parameters
|
1558
|
+
header_params = {}
|
1559
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1560
|
+
# HTTP header 'Accept' (if needed)
|
1561
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1562
|
+
# HTTP header 'Content-Type'
|
1563
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1564
|
+
|
1565
|
+
# form parameters
|
1566
|
+
form_params = {}
|
1567
|
+
|
1568
|
+
# http body (model)
|
1569
|
+
post_body = nil
|
1570
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1571
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1572
|
+
:header_params => header_params,
|
1573
|
+
:query_params => query_params,
|
1574
|
+
:form_params => form_params,
|
1575
|
+
:body => post_body,
|
1576
|
+
:auth_names => auth_names)
|
1577
|
+
if @api_client.config.debugging
|
1578
|
+
@api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1579
|
+
end
|
1580
|
+
return data, status_code, headers
|
1581
|
+
end
|
1528
1582
|
# Start a conversation
|
1529
1583
|
# Start a new conversation
|
1530
1584
|
# @param start_request Start request
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.10.
|
4
|
+
version: 3.10.118
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-02-
|
11
|
+
date: 2023-02-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|