ultracart_api 3.10.212 → 3.10.213
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 +6 -4
- data/docs/StorefrontApi.md +51 -0
- data/docs/Twilio.md +0 -4
- data/lib/ultracart_api/api/storefront_api.rb +58 -0
- data/lib/ultracart_api/models/twilio.rb +1 -37
- 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: 131e2cb97c0feb647e076268a4bae65bd746cf25199db05266bbc5264fb0100e
|
|
4
|
+
data.tar.gz: 10dfcd42274edd174728307cde79e1a37e69e4873572d1a598bb9132486229fb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2fa23e1a646c2de8f7ba6b71aa85738cd57f268673fe617d9bbf820b92bbd6541154dd981c15800ba994ee399b390af894951613f2409b9fc67b05a79dd48359
|
|
7
|
+
data.tar.gz: a8652785a2a7844043c2fe8c2c570d602d8487f17b2ad46f09f35423ede75f7849f30fcc13f11a3598880f0dd57a9f7f96b20e8f45a27a3264f9d2ec72eab18a
|
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.213
|
|
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.213.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.213.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.213'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -494,6 +494,7 @@ Class | Method | HTTP request | Description
|
|
|
494
494
|
*UltracartClient::StorefrontApi* | [**sequence_test**](docs/StorefrontApi.md#sequence_test) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test | Sequence test
|
|
495
495
|
*UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
|
496
496
|
*UltracartClient::StorefrontApi* | [**subscribe_to_email_list**](docs/StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
|
|
497
|
+
*UltracartClient::StorefrontApi* | [**sunset_email_segment**](docs/StorefrontApi.md#sunset_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset | Sunset email segment
|
|
497
498
|
*UltracartClient::StorefrontApi* | [**unfavorite_screen_recording**](docs/StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
|
|
498
499
|
*UltracartClient::StorefrontApi* | [**update_email_campaign**](docs/StorefrontApi.md#update_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} | Update email campaign
|
|
499
500
|
*UltracartClient::StorefrontApi* | [**update_email_campaign_folder**](docs/StorefrontApi.md#update_email_campaign_folder) | **PUT** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Update email campaign folder
|
|
@@ -1509,6 +1510,7 @@ Not every change is committed to every SDK.
|
|
|
1509
1510
|
|
|
1510
1511
|
| Version | Date | Comments |
|
|
1511
1512
|
| --: | :-: | --- |
|
|
1513
|
+
| 3.10.213 | 06/24/2024 | conversation object cleanup |
|
|
1512
1514
|
| 3.10.212 | 06/14/2024 | pbx menu - add say voice property |
|
|
1513
1515
|
| 3.10.211 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
|
|
1514
1516
|
| 3.10.210 | 06/03/2024 | conversationPbxPhoneNumber - fix serialized name for phone number UUID |
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -154,6 +154,7 @@ Method | HTTP request | Description
|
|
|
154
154
|
[**sequence_test**](StorefrontApi.md#sequence_test) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test | Sequence test
|
|
155
155
|
[**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
|
156
156
|
[**subscribe_to_email_list**](StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
|
|
157
|
+
[**sunset_email_segment**](StorefrontApi.md#sunset_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset | Sunset email segment
|
|
157
158
|
[**unfavorite_screen_recording**](StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
|
|
158
159
|
[**update_email_campaign**](StorefrontApi.md#update_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} | Update email campaign
|
|
159
160
|
[**update_email_campaign_folder**](StorefrontApi.md#update_email_campaign_folder) | **PUT** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Update email campaign folder
|
|
@@ -7897,6 +7898,56 @@ Name | Type | Description | Notes
|
|
|
7897
7898
|
|
|
7898
7899
|
|
|
7899
7900
|
|
|
7901
|
+
# **sunset_email_segment**
|
|
7902
|
+
> sunset_email_segment(storefront_oid, email_segment_uuid)
|
|
7903
|
+
|
|
7904
|
+
Sunset email segment
|
|
7905
|
+
|
|
7906
|
+
### Example
|
|
7907
|
+
```ruby
|
|
7908
|
+
# load the gem
|
|
7909
|
+
require 'ultracart_api'
|
|
7910
|
+
|
|
7911
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
7912
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
7913
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
7914
|
+
|
|
7915
|
+
|
|
7916
|
+
storefront_oid = 56 # Integer |
|
|
7917
|
+
|
|
7918
|
+
email_segment_uuid = 'email_segment_uuid_example' # String |
|
|
7919
|
+
|
|
7920
|
+
|
|
7921
|
+
begin
|
|
7922
|
+
#Sunset email segment
|
|
7923
|
+
api_instance.sunset_email_segment(storefront_oid, email_segment_uuid)
|
|
7924
|
+
rescue UltracartClient::ApiError => e
|
|
7925
|
+
puts "Exception when calling StorefrontApi->sunset_email_segment: #{e}"
|
|
7926
|
+
end
|
|
7927
|
+
```
|
|
7928
|
+
|
|
7929
|
+
### Parameters
|
|
7930
|
+
|
|
7931
|
+
Name | Type | Description | Notes
|
|
7932
|
+
------------- | ------------- | ------------- | -------------
|
|
7933
|
+
**storefront_oid** | **Integer**| |
|
|
7934
|
+
**email_segment_uuid** | **String**| |
|
|
7935
|
+
|
|
7936
|
+
### Return type
|
|
7937
|
+
|
|
7938
|
+
nil (empty response body)
|
|
7939
|
+
|
|
7940
|
+
### Authorization
|
|
7941
|
+
|
|
7942
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7943
|
+
|
|
7944
|
+
### HTTP request headers
|
|
7945
|
+
|
|
7946
|
+
- **Content-Type**: application/json
|
|
7947
|
+
- **Accept**: application/json
|
|
7948
|
+
|
|
7949
|
+
|
|
7950
|
+
|
|
7900
7951
|
# **unfavorite_screen_recording**
|
|
7901
7952
|
> unfavorite_screen_recording(storefront_oid, screen_recording_uuid)
|
|
7902
7953
|
|
data/docs/Twilio.md
CHANGED
|
@@ -6,15 +6,11 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**account_sid** | **String** | | [optional]
|
|
7
7
|
**api_key_id** | **String** | | [optional]
|
|
8
8
|
**api_key_name** | **String** | | [optional]
|
|
9
|
-
**api_key_secret** | **String** | | [optional]
|
|
10
9
|
**auth_token** | **String** | | [optional]
|
|
11
10
|
**esp_twilio_uuid** | **String** | | [optional]
|
|
12
11
|
**inbound_twiml_app_sid** | **String** | | [optional]
|
|
13
12
|
**outbound_twiml_app_sid** | **String** | | [optional]
|
|
14
13
|
**phone_numbers** | **Array<String>** | | [optional]
|
|
15
|
-
**private_key_pem** | **String** | | [optional]
|
|
16
|
-
**public_key_pem** | **String** | | [optional]
|
|
17
|
-
**public_key_sid** | **String** | | [optional]
|
|
18
14
|
**twilio_workspace_sid** | **String** | | [optional]
|
|
19
15
|
|
|
20
16
|
|
|
@@ -8834,6 +8834,64 @@ module UltracartClient
|
|
|
8834
8834
|
end
|
|
8835
8835
|
return data, status_code, headers
|
|
8836
8836
|
end
|
|
8837
|
+
# Sunset email segment
|
|
8838
|
+
# @param storefront_oid
|
|
8839
|
+
# @param email_segment_uuid
|
|
8840
|
+
# @param [Hash] opts the optional parameters
|
|
8841
|
+
# @return [nil]
|
|
8842
|
+
def sunset_email_segment(storefront_oid, email_segment_uuid, opts = {})
|
|
8843
|
+
sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
|
|
8844
|
+
nil
|
|
8845
|
+
end
|
|
8846
|
+
|
|
8847
|
+
# Sunset email segment
|
|
8848
|
+
# @param storefront_oid
|
|
8849
|
+
# @param email_segment_uuid
|
|
8850
|
+
# @param [Hash] opts the optional parameters
|
|
8851
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
8852
|
+
def sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
|
|
8853
|
+
if @api_client.config.debugging
|
|
8854
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.sunset_email_segment ...'
|
|
8855
|
+
end
|
|
8856
|
+
# verify the required parameter 'storefront_oid' is set
|
|
8857
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
8858
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.sunset_email_segment"
|
|
8859
|
+
end
|
|
8860
|
+
# verify the required parameter 'email_segment_uuid' is set
|
|
8861
|
+
if @api_client.config.client_side_validation && email_segment_uuid.nil?
|
|
8862
|
+
fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.sunset_email_segment"
|
|
8863
|
+
end
|
|
8864
|
+
# resource path
|
|
8865
|
+
local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)
|
|
8866
|
+
|
|
8867
|
+
# query parameters
|
|
8868
|
+
query_params = {}
|
|
8869
|
+
|
|
8870
|
+
# header parameters
|
|
8871
|
+
header_params = {}
|
|
8872
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
8873
|
+
# HTTP header 'Accept' (if needed)
|
|
8874
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8875
|
+
# HTTP header 'Content-Type'
|
|
8876
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
8877
|
+
|
|
8878
|
+
# form parameters
|
|
8879
|
+
form_params = {}
|
|
8880
|
+
|
|
8881
|
+
# http body (model)
|
|
8882
|
+
post_body = nil
|
|
8883
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
8884
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
8885
|
+
:header_params => header_params,
|
|
8886
|
+
:query_params => query_params,
|
|
8887
|
+
:form_params => form_params,
|
|
8888
|
+
:body => post_body,
|
|
8889
|
+
:auth_names => auth_names)
|
|
8890
|
+
if @api_client.config.debugging
|
|
8891
|
+
@api_client.config.logger.debug "API called: StorefrontApi#sunset_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8892
|
+
end
|
|
8893
|
+
return data, status_code, headers
|
|
8894
|
+
end
|
|
8837
8895
|
# Remove favorite flag on screen recording
|
|
8838
8896
|
# Remove favorite flag on screen recording
|
|
8839
8897
|
# @param storefront_oid
|
|
@@ -20,8 +20,6 @@ module UltracartClient
|
|
|
20
20
|
|
|
21
21
|
attr_accessor :api_key_name
|
|
22
22
|
|
|
23
|
-
attr_accessor :api_key_secret
|
|
24
|
-
|
|
25
23
|
attr_accessor :auth_token
|
|
26
24
|
|
|
27
25
|
attr_accessor :esp_twilio_uuid
|
|
@@ -32,12 +30,6 @@ module UltracartClient
|
|
|
32
30
|
|
|
33
31
|
attr_accessor :phone_numbers
|
|
34
32
|
|
|
35
|
-
attr_accessor :private_key_pem
|
|
36
|
-
|
|
37
|
-
attr_accessor :public_key_pem
|
|
38
|
-
|
|
39
|
-
attr_accessor :public_key_sid
|
|
40
|
-
|
|
41
33
|
attr_accessor :twilio_workspace_sid
|
|
42
34
|
|
|
43
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -46,15 +38,11 @@ module UltracartClient
|
|
|
46
38
|
:'account_sid' => :'account_sid',
|
|
47
39
|
:'api_key_id' => :'api_key_id',
|
|
48
40
|
:'api_key_name' => :'api_key_name',
|
|
49
|
-
:'api_key_secret' => :'api_key_secret',
|
|
50
41
|
:'auth_token' => :'auth_token',
|
|
51
42
|
:'esp_twilio_uuid' => :'esp_twilio_uuid',
|
|
52
43
|
:'inbound_twiml_app_sid' => :'inbound_twiml_app_sid',
|
|
53
44
|
:'outbound_twiml_app_sid' => :'outbound_twiml_app_sid',
|
|
54
45
|
:'phone_numbers' => :'phone_numbers',
|
|
55
|
-
:'private_key_pem' => :'private_key_pem',
|
|
56
|
-
:'public_key_pem' => :'public_key_pem',
|
|
57
|
-
:'public_key_sid' => :'public_key_sid',
|
|
58
46
|
:'twilio_workspace_sid' => :'twilio_workspace_sid'
|
|
59
47
|
}
|
|
60
48
|
end
|
|
@@ -65,15 +53,11 @@ module UltracartClient
|
|
|
65
53
|
:'account_sid' => :'String',
|
|
66
54
|
:'api_key_id' => :'String',
|
|
67
55
|
:'api_key_name' => :'String',
|
|
68
|
-
:'api_key_secret' => :'String',
|
|
69
56
|
:'auth_token' => :'String',
|
|
70
57
|
:'esp_twilio_uuid' => :'String',
|
|
71
58
|
:'inbound_twiml_app_sid' => :'String',
|
|
72
59
|
:'outbound_twiml_app_sid' => :'String',
|
|
73
60
|
:'phone_numbers' => :'Array<String>',
|
|
74
|
-
:'private_key_pem' => :'String',
|
|
75
|
-
:'public_key_pem' => :'String',
|
|
76
|
-
:'public_key_sid' => :'String',
|
|
77
61
|
:'twilio_workspace_sid' => :'String'
|
|
78
62
|
}
|
|
79
63
|
end
|
|
@@ -98,10 +82,6 @@ module UltracartClient
|
|
|
98
82
|
self.api_key_name = attributes[:'api_key_name']
|
|
99
83
|
end
|
|
100
84
|
|
|
101
|
-
if attributes.has_key?(:'api_key_secret')
|
|
102
|
-
self.api_key_secret = attributes[:'api_key_secret']
|
|
103
|
-
end
|
|
104
|
-
|
|
105
85
|
if attributes.has_key?(:'auth_token')
|
|
106
86
|
self.auth_token = attributes[:'auth_token']
|
|
107
87
|
end
|
|
@@ -124,18 +104,6 @@ module UltracartClient
|
|
|
124
104
|
end
|
|
125
105
|
end
|
|
126
106
|
|
|
127
|
-
if attributes.has_key?(:'private_key_pem')
|
|
128
|
-
self.private_key_pem = attributes[:'private_key_pem']
|
|
129
|
-
end
|
|
130
|
-
|
|
131
|
-
if attributes.has_key?(:'public_key_pem')
|
|
132
|
-
self.public_key_pem = attributes[:'public_key_pem']
|
|
133
|
-
end
|
|
134
|
-
|
|
135
|
-
if attributes.has_key?(:'public_key_sid')
|
|
136
|
-
self.public_key_sid = attributes[:'public_key_sid']
|
|
137
|
-
end
|
|
138
|
-
|
|
139
107
|
if attributes.has_key?(:'twilio_workspace_sid')
|
|
140
108
|
self.twilio_workspace_sid = attributes[:'twilio_workspace_sid']
|
|
141
109
|
end
|
|
@@ -162,15 +130,11 @@ module UltracartClient
|
|
|
162
130
|
account_sid == o.account_sid &&
|
|
163
131
|
api_key_id == o.api_key_id &&
|
|
164
132
|
api_key_name == o.api_key_name &&
|
|
165
|
-
api_key_secret == o.api_key_secret &&
|
|
166
133
|
auth_token == o.auth_token &&
|
|
167
134
|
esp_twilio_uuid == o.esp_twilio_uuid &&
|
|
168
135
|
inbound_twiml_app_sid == o.inbound_twiml_app_sid &&
|
|
169
136
|
outbound_twiml_app_sid == o.outbound_twiml_app_sid &&
|
|
170
137
|
phone_numbers == o.phone_numbers &&
|
|
171
|
-
private_key_pem == o.private_key_pem &&
|
|
172
|
-
public_key_pem == o.public_key_pem &&
|
|
173
|
-
public_key_sid == o.public_key_sid &&
|
|
174
138
|
twilio_workspace_sid == o.twilio_workspace_sid
|
|
175
139
|
end
|
|
176
140
|
|
|
@@ -183,7 +147,7 @@ module UltracartClient
|
|
|
183
147
|
# Calculates hash code according to all attributes.
|
|
184
148
|
# @return [Fixnum] Hash code
|
|
185
149
|
def hash
|
|
186
|
-
[account_sid, api_key_id, api_key_name,
|
|
150
|
+
[account_sid, api_key_id, api_key_name, auth_token, esp_twilio_uuid, inbound_twiml_app_sid, outbound_twiml_app_sid, phone_numbers, twilio_workspace_sid].hash
|
|
187
151
|
end
|
|
188
152
|
|
|
189
153
|
# Builds the object from hash
|
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.213
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-06-
|
|
11
|
+
date: 2024-06-24 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|