ultracart_api 4.0.134 → 4.0.135
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 +71 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -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: 957070c75bab53ffcaec29cf1bea74ca2cfaa1b3e945d766662faa31d89155a9
|
4
|
+
data.tar.gz: f8c2d6d4d3ab71f1910c8b97c172b0407c305501e9ce1336924a4b4da60efafd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 93eddbcce4641a622f687671fc6e290ba01681219421cd62df36fd77b5ffaabe3105123dedfa2c3418e4925116f825b06c3e179426b5a8086892258a251b31e8
|
7
|
+
data.tar.gz: 5eadc726d7dc3e19090cc04a73404aa256efa7eacbcc13cd7125e17cab61f42ed8db2d2269cf9ba3eeee894e9eaebd61ba5b40283cfdee162ccb9871adf56e90
|
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.135
|
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.135.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.135.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.135'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
165
165
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
166
166
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
167
167
|
*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
|
168
|
+
*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
|
168
169
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
169
170
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
170
171
|
*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
|
@@ -1309,6 +1310,7 @@ Not every change is committed to every SDK.
|
|
1309
1310
|
|
1310
1311
|
| Version | Date | Comments |
|
1311
1312
|
| --: | :-: | --- |
|
1313
|
+
| 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
|
1312
1314
|
| 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
|
1313
1315
|
| 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
|
1314
1316
|
| 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
data/docs/ConversationApi.md
CHANGED
@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 |
|
@@ -2013,6 +2014,76 @@ end
|
|
2013
2014
|
- **Accept**: application/json
|
2014
2015
|
|
2015
2016
|
|
2017
|
+
## sms_unsubscribe_conversation
|
2018
|
+
|
2019
|
+
> sms_unsubscribe_conversation(conversation_uuid)
|
2020
|
+
|
2021
|
+
Unsubscribe any SMS participants in this conversation
|
2022
|
+
|
2023
|
+
Unsubscribe any SMS participants in this conversation
|
2024
|
+
|
2025
|
+
### Examples
|
2026
|
+
|
2027
|
+
```ruby
|
2028
|
+
require 'time'
|
2029
|
+
require 'ultracart_api'
|
2030
|
+
require 'json'
|
2031
|
+
require 'yaml'
|
2032
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2033
|
+
|
2034
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2035
|
+
# As such, this might not be the best way to use this object.
|
2036
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2037
|
+
|
2038
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2039
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
2040
|
+
|
2041
|
+
begin
|
2042
|
+
# Unsubscribe any SMS participants in this conversation
|
2043
|
+
api_instance.sms_unsubscribe_conversation(conversation_uuid)
|
2044
|
+
rescue UltracartClient::ApiError => e
|
2045
|
+
puts "Error when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
|
2046
|
+
end
|
2047
|
+
```
|
2048
|
+
|
2049
|
+
#### Using the sms_unsubscribe_conversation_with_http_info variant
|
2050
|
+
|
2051
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2052
|
+
|
2053
|
+
> <Array(nil, Integer, Hash)> sms_unsubscribe_conversation_with_http_info(conversation_uuid)
|
2054
|
+
|
2055
|
+
```ruby
|
2056
|
+
begin
|
2057
|
+
# Unsubscribe any SMS participants in this conversation
|
2058
|
+
data, status_code, headers = api_instance.sms_unsubscribe_conversation_with_http_info(conversation_uuid)
|
2059
|
+
p status_code # => 2xx
|
2060
|
+
p headers # => { ... }
|
2061
|
+
p data # => nil
|
2062
|
+
rescue UltracartClient::ApiError => e
|
2063
|
+
puts "Error when calling ConversationApi->sms_unsubscribe_conversation_with_http_info: #{e}"
|
2064
|
+
end
|
2065
|
+
```
|
2066
|
+
|
2067
|
+
### Parameters
|
2068
|
+
|
2069
|
+
| Name | Type | Description | Notes |
|
2070
|
+
| ---- | ---- | ----------- | ----- |
|
2071
|
+
| **conversation_uuid** | **String** | | |
|
2072
|
+
|
2073
|
+
### Return type
|
2074
|
+
|
2075
|
+
nil (empty response body)
|
2076
|
+
|
2077
|
+
### Authorization
|
2078
|
+
|
2079
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2080
|
+
|
2081
|
+
### HTTP request headers
|
2082
|
+
|
2083
|
+
- **Content-Type**: Not defined
|
2084
|
+
- **Accept**: application/json
|
2085
|
+
|
2086
|
+
|
2016
2087
|
## start_conversation
|
2017
2088
|
|
2018
2089
|
> <ConversationStartResponse> start_conversation(start_request)
|
@@ -1819,6 +1819,70 @@ module UltracartClient
|
|
1819
1819
|
return data, status_code, headers
|
1820
1820
|
end
|
1821
1821
|
|
1822
|
+
# Unsubscribe any SMS participants in this conversation
|
1823
|
+
# Unsubscribe any SMS participants in this conversation
|
1824
|
+
# @param conversation_uuid [String]
|
1825
|
+
# @param [Hash] opts the optional parameters
|
1826
|
+
# @return [nil]
|
1827
|
+
def sms_unsubscribe_conversation(conversation_uuid, opts = {})
|
1828
|
+
sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
|
1829
|
+
nil
|
1830
|
+
end
|
1831
|
+
|
1832
|
+
# Unsubscribe any SMS participants in this conversation
|
1833
|
+
# Unsubscribe any SMS participants in this conversation
|
1834
|
+
# @param conversation_uuid [String]
|
1835
|
+
# @param [Hash] opts the optional parameters
|
1836
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1837
|
+
def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
|
1838
|
+
if @api_client.config.debugging
|
1839
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
|
1840
|
+
end
|
1841
|
+
# verify the required parameter 'conversation_uuid' is set
|
1842
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
1843
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
|
1844
|
+
end
|
1845
|
+
# resource path
|
1846
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
|
1847
|
+
|
1848
|
+
# query parameters
|
1849
|
+
query_params = opts[:query_params] || {}
|
1850
|
+
|
1851
|
+
# header parameters
|
1852
|
+
header_params = opts[:header_params] || {}
|
1853
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1854
|
+
# HTTP header 'Accept' (if needed)
|
1855
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1856
|
+
|
1857
|
+
# form parameters
|
1858
|
+
form_params = opts[:form_params] || {}
|
1859
|
+
|
1860
|
+
# http body (model)
|
1861
|
+
post_body = opts[:debug_body]
|
1862
|
+
|
1863
|
+
# return_type
|
1864
|
+
return_type = opts[:debug_return_type]
|
1865
|
+
|
1866
|
+
# auth_names
|
1867
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1868
|
+
|
1869
|
+
new_options = opts.merge(
|
1870
|
+
:operation => :"ConversationApi.sms_unsubscribe_conversation",
|
1871
|
+
:header_params => header_params,
|
1872
|
+
:query_params => query_params,
|
1873
|
+
:form_params => form_params,
|
1874
|
+
:body => post_body,
|
1875
|
+
:auth_names => auth_names,
|
1876
|
+
:return_type => return_type
|
1877
|
+
)
|
1878
|
+
|
1879
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1880
|
+
if @api_client.config.debugging
|
1881
|
+
@api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1882
|
+
end
|
1883
|
+
return data, status_code, headers
|
1884
|
+
end
|
1885
|
+
|
1822
1886
|
# Start a conversation
|
1823
1887
|
# Start a new conversation
|
1824
1888
|
# @param start_request [ConversationStartRequest] 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: 4.0.
|
4
|
+
version: 4.0.135
|
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
|