ultracart_api 4.0.229 → 4.0.230
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/StorefrontApi.md +71 -0
- data/docs/Twilio.md +0 -8
- data/lib/ultracart_api/api/storefront_api.rb +68 -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: 64da9e720cbb1fd0aeff33d97b5a1a0c8c3f4ae065373aa1bd986e7d2c9dde75
|
4
|
+
data.tar.gz: db62a9e1e7f92274af6f54c78ced506d2efd3cc5cf7bfe2f4ec939fe32e71d3a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 438b55987b3a2f501d0c5d9ec36fb29ef32c6655040d0018ec3991137066235530b2ae9d49ba443b0337068014d45724ae39c56c4e4f3c2cec2a1353862cb165
|
7
|
+
data.tar.gz: ed7be2db8b408bdd0c626cfe860c26d5064cd4e2caa5004f95a3eee2d2566da662f2738e789ca6906842a57dffb811581cde61d387a702185e37b2c374c395e7
|
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.230
|
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.230.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.230.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.230'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -500,6 +500,7 @@ Class | Method | HTTP request | Description
|
|
500
500
|
*UltracartClient::StorefrontApi* | [**sequence_test**](docs/StorefrontApi.md#sequence_test) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test | Sequence test
|
501
501
|
*UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
502
502
|
*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
|
503
|
+
*UltracartClient::StorefrontApi* | [**sunset_email_segment**](docs/StorefrontApi.md#sunset_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset | Sunset email segment
|
503
504
|
*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
|
504
505
|
*UltracartClient::StorefrontApi* | [**update_email_campaign**](docs/StorefrontApi.md#update_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} | Update email campaign
|
505
506
|
*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
|
@@ -1517,6 +1518,7 @@ Not every change is committed to every SDK.
|
|
1517
1518
|
|
1518
1519
|
| Version | Date | Comments |
|
1519
1520
|
| --: | :-: | --- |
|
1521
|
+
| 4.0.230 | 06/24/2024 | conversation object cleanup |
|
1520
1522
|
| 4.0.229 | 06/14/2024 | pbx menu - add say voice property |
|
1521
1523
|
| 4.0.228 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
|
1522
1524
|
| 4.0.227 | 06/03/2024 | conversationPbxPhoneNumber - fix serialized name for phone number UUID |
|
data/docs/StorefrontApi.md
CHANGED
@@ -154,6 +154,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 |
|
@@ -10943,6 +10944,76 @@ end
|
|
10943
10944
|
- **Accept**: application/json
|
10944
10945
|
|
10945
10946
|
|
10947
|
+
## sunset_email_segment
|
10948
|
+
|
10949
|
+
> sunset_email_segment(storefront_oid, email_segment_uuid)
|
10950
|
+
|
10951
|
+
Sunset email segment
|
10952
|
+
|
10953
|
+
### Examples
|
10954
|
+
|
10955
|
+
```ruby
|
10956
|
+
require 'time'
|
10957
|
+
require 'ultracart_api'
|
10958
|
+
require 'json'
|
10959
|
+
require 'yaml'
|
10960
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
10961
|
+
|
10962
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
10963
|
+
# As such, this might not be the best way to use this object.
|
10964
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
10965
|
+
|
10966
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
10967
|
+
storefront_oid = 56 # Integer |
|
10968
|
+
email_segment_uuid = 'email_segment_uuid_example' # String |
|
10969
|
+
|
10970
|
+
begin
|
10971
|
+
# Sunset email segment
|
10972
|
+
api_instance.sunset_email_segment(storefront_oid, email_segment_uuid)
|
10973
|
+
rescue UltracartClient::ApiError => e
|
10974
|
+
puts "Error when calling StorefrontApi->sunset_email_segment: #{e}"
|
10975
|
+
end
|
10976
|
+
```
|
10977
|
+
|
10978
|
+
#### Using the sunset_email_segment_with_http_info variant
|
10979
|
+
|
10980
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
10981
|
+
|
10982
|
+
> <Array(nil, Integer, Hash)> sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid)
|
10983
|
+
|
10984
|
+
```ruby
|
10985
|
+
begin
|
10986
|
+
# Sunset email segment
|
10987
|
+
data, status_code, headers = api_instance.sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid)
|
10988
|
+
p status_code # => 2xx
|
10989
|
+
p headers # => { ... }
|
10990
|
+
p data # => nil
|
10991
|
+
rescue UltracartClient::ApiError => e
|
10992
|
+
puts "Error when calling StorefrontApi->sunset_email_segment_with_http_info: #{e}"
|
10993
|
+
end
|
10994
|
+
```
|
10995
|
+
|
10996
|
+
### Parameters
|
10997
|
+
|
10998
|
+
| Name | Type | Description | Notes |
|
10999
|
+
| ---- | ---- | ----------- | ----- |
|
11000
|
+
| **storefront_oid** | **Integer** | | |
|
11001
|
+
| **email_segment_uuid** | **String** | | |
|
11002
|
+
|
11003
|
+
### Return type
|
11004
|
+
|
11005
|
+
nil (empty response body)
|
11006
|
+
|
11007
|
+
### Authorization
|
11008
|
+
|
11009
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
11010
|
+
|
11011
|
+
### HTTP request headers
|
11012
|
+
|
11013
|
+
- **Content-Type**: Not defined
|
11014
|
+
- **Accept**: application/json
|
11015
|
+
|
11016
|
+
|
10946
11017
|
## unfavorite_screen_recording
|
10947
11018
|
|
10948
11019
|
> unfavorite_screen_recording(storefront_oid, screen_recording_uuid)
|
data/docs/Twilio.md
CHANGED
@@ -7,15 +7,11 @@
|
|
7
7
|
| **account_sid** | **String** | | [optional] |
|
8
8
|
| **api_key_id** | **String** | | [optional] |
|
9
9
|
| **api_key_name** | **String** | | [optional] |
|
10
|
-
| **api_key_secret** | **String** | | [optional] |
|
11
10
|
| **auth_token** | **String** | | [optional] |
|
12
11
|
| **esp_twilio_uuid** | **String** | | [optional] |
|
13
12
|
| **inbound_twiml_app_sid** | **String** | | [optional] |
|
14
13
|
| **outbound_twiml_app_sid** | **String** | | [optional] |
|
15
14
|
| **phone_numbers** | **Array<String>** | | [optional] |
|
16
|
-
| **private_key_pem** | **String** | | [optional] |
|
17
|
-
| **public_key_pem** | **String** | | [optional] |
|
18
|
-
| **public_key_sid** | **String** | | [optional] |
|
19
15
|
| **twilio_workspace_sid** | **String** | | [optional] |
|
20
16
|
|
21
17
|
## Example
|
@@ -27,15 +23,11 @@ instance = UltracartClient::Twilio.new(
|
|
27
23
|
account_sid: null,
|
28
24
|
api_key_id: null,
|
29
25
|
api_key_name: null,
|
30
|
-
api_key_secret: null,
|
31
26
|
auth_token: null,
|
32
27
|
esp_twilio_uuid: null,
|
33
28
|
inbound_twiml_app_sid: null,
|
34
29
|
outbound_twiml_app_sid: null,
|
35
30
|
phone_numbers: null,
|
36
|
-
private_key_pem: null,
|
37
|
-
public_key_pem: null,
|
38
|
-
public_key_sid: null,
|
39
31
|
twilio_workspace_sid: null
|
40
32
|
)
|
41
33
|
```
|
@@ -10414,6 +10414,74 @@ module UltracartClient
|
|
10414
10414
|
return data, status_code, headers
|
10415
10415
|
end
|
10416
10416
|
|
10417
|
+
# Sunset email segment
|
10418
|
+
# @param storefront_oid [Integer]
|
10419
|
+
# @param email_segment_uuid [String]
|
10420
|
+
# @param [Hash] opts the optional parameters
|
10421
|
+
# @return [nil]
|
10422
|
+
def sunset_email_segment(storefront_oid, email_segment_uuid, opts = {})
|
10423
|
+
sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
|
10424
|
+
nil
|
10425
|
+
end
|
10426
|
+
|
10427
|
+
# Sunset email segment
|
10428
|
+
# @param storefront_oid [Integer]
|
10429
|
+
# @param email_segment_uuid [String]
|
10430
|
+
# @param [Hash] opts the optional parameters
|
10431
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
10432
|
+
def sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
|
10433
|
+
if @api_client.config.debugging
|
10434
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.sunset_email_segment ...'
|
10435
|
+
end
|
10436
|
+
# verify the required parameter 'storefront_oid' is set
|
10437
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
10438
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.sunset_email_segment"
|
10439
|
+
end
|
10440
|
+
# verify the required parameter 'email_segment_uuid' is set
|
10441
|
+
if @api_client.config.client_side_validation && email_segment_uuid.nil?
|
10442
|
+
fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.sunset_email_segment"
|
10443
|
+
end
|
10444
|
+
# resource path
|
10445
|
+
local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))
|
10446
|
+
|
10447
|
+
# query parameters
|
10448
|
+
query_params = opts[:query_params] || {}
|
10449
|
+
|
10450
|
+
# header parameters
|
10451
|
+
header_params = opts[:header_params] || {}
|
10452
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
10453
|
+
# HTTP header 'Accept' (if needed)
|
10454
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10455
|
+
|
10456
|
+
# form parameters
|
10457
|
+
form_params = opts[:form_params] || {}
|
10458
|
+
|
10459
|
+
# http body (model)
|
10460
|
+
post_body = opts[:debug_body]
|
10461
|
+
|
10462
|
+
# return_type
|
10463
|
+
return_type = opts[:debug_return_type]
|
10464
|
+
|
10465
|
+
# auth_names
|
10466
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
10467
|
+
|
10468
|
+
new_options = opts.merge(
|
10469
|
+
:operation => :"StorefrontApi.sunset_email_segment",
|
10470
|
+
:header_params => header_params,
|
10471
|
+
:query_params => query_params,
|
10472
|
+
:form_params => form_params,
|
10473
|
+
:body => post_body,
|
10474
|
+
:auth_names => auth_names,
|
10475
|
+
:return_type => return_type
|
10476
|
+
)
|
10477
|
+
|
10478
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
10479
|
+
if @api_client.config.debugging
|
10480
|
+
@api_client.config.logger.debug "API called: StorefrontApi#sunset_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10481
|
+
end
|
10482
|
+
return data, status_code, headers
|
10483
|
+
end
|
10484
|
+
|
10417
10485
|
# Remove favorite flag on screen recording
|
10418
10486
|
# Remove favorite flag on screen recording
|
10419
10487
|
# @param storefront_oid [Integer]
|
@@ -21,8 +21,6 @@ module UltracartClient
|
|
21
21
|
|
22
22
|
attr_accessor :api_key_name
|
23
23
|
|
24
|
-
attr_accessor :api_key_secret
|
25
|
-
|
26
24
|
attr_accessor :auth_token
|
27
25
|
|
28
26
|
attr_accessor :esp_twilio_uuid
|
@@ -33,12 +31,6 @@ module UltracartClient
|
|
33
31
|
|
34
32
|
attr_accessor :phone_numbers
|
35
33
|
|
36
|
-
attr_accessor :private_key_pem
|
37
|
-
|
38
|
-
attr_accessor :public_key_pem
|
39
|
-
|
40
|
-
attr_accessor :public_key_sid
|
41
|
-
|
42
34
|
attr_accessor :twilio_workspace_sid
|
43
35
|
|
44
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -47,15 +39,11 @@ module UltracartClient
|
|
47
39
|
:'account_sid' => :'account_sid',
|
48
40
|
:'api_key_id' => :'api_key_id',
|
49
41
|
:'api_key_name' => :'api_key_name',
|
50
|
-
:'api_key_secret' => :'api_key_secret',
|
51
42
|
:'auth_token' => :'auth_token',
|
52
43
|
:'esp_twilio_uuid' => :'esp_twilio_uuid',
|
53
44
|
:'inbound_twiml_app_sid' => :'inbound_twiml_app_sid',
|
54
45
|
:'outbound_twiml_app_sid' => :'outbound_twiml_app_sid',
|
55
46
|
:'phone_numbers' => :'phone_numbers',
|
56
|
-
:'private_key_pem' => :'private_key_pem',
|
57
|
-
:'public_key_pem' => :'public_key_pem',
|
58
|
-
:'public_key_sid' => :'public_key_sid',
|
59
47
|
:'twilio_workspace_sid' => :'twilio_workspace_sid'
|
60
48
|
}
|
61
49
|
end
|
@@ -71,15 +59,11 @@ module UltracartClient
|
|
71
59
|
:'account_sid' => :'String',
|
72
60
|
:'api_key_id' => :'String',
|
73
61
|
:'api_key_name' => :'String',
|
74
|
-
:'api_key_secret' => :'String',
|
75
62
|
:'auth_token' => :'String',
|
76
63
|
:'esp_twilio_uuid' => :'String',
|
77
64
|
:'inbound_twiml_app_sid' => :'String',
|
78
65
|
:'outbound_twiml_app_sid' => :'String',
|
79
66
|
:'phone_numbers' => :'Array<String>',
|
80
|
-
:'private_key_pem' => :'String',
|
81
|
-
:'public_key_pem' => :'String',
|
82
|
-
:'public_key_sid' => :'String',
|
83
67
|
:'twilio_workspace_sid' => :'String'
|
84
68
|
}
|
85
69
|
end
|
@@ -117,10 +101,6 @@ module UltracartClient
|
|
117
101
|
self.api_key_name = attributes[:'api_key_name']
|
118
102
|
end
|
119
103
|
|
120
|
-
if attributes.key?(:'api_key_secret')
|
121
|
-
self.api_key_secret = attributes[:'api_key_secret']
|
122
|
-
end
|
123
|
-
|
124
104
|
if attributes.key?(:'auth_token')
|
125
105
|
self.auth_token = attributes[:'auth_token']
|
126
106
|
end
|
@@ -143,18 +123,6 @@ module UltracartClient
|
|
143
123
|
end
|
144
124
|
end
|
145
125
|
|
146
|
-
if attributes.key?(:'private_key_pem')
|
147
|
-
self.private_key_pem = attributes[:'private_key_pem']
|
148
|
-
end
|
149
|
-
|
150
|
-
if attributes.key?(:'public_key_pem')
|
151
|
-
self.public_key_pem = attributes[:'public_key_pem']
|
152
|
-
end
|
153
|
-
|
154
|
-
if attributes.key?(:'public_key_sid')
|
155
|
-
self.public_key_sid = attributes[:'public_key_sid']
|
156
|
-
end
|
157
|
-
|
158
126
|
if attributes.key?(:'twilio_workspace_sid')
|
159
127
|
self.twilio_workspace_sid = attributes[:'twilio_workspace_sid']
|
160
128
|
end
|
@@ -181,15 +149,11 @@ module UltracartClient
|
|
181
149
|
account_sid == o.account_sid &&
|
182
150
|
api_key_id == o.api_key_id &&
|
183
151
|
api_key_name == o.api_key_name &&
|
184
|
-
api_key_secret == o.api_key_secret &&
|
185
152
|
auth_token == o.auth_token &&
|
186
153
|
esp_twilio_uuid == o.esp_twilio_uuid &&
|
187
154
|
inbound_twiml_app_sid == o.inbound_twiml_app_sid &&
|
188
155
|
outbound_twiml_app_sid == o.outbound_twiml_app_sid &&
|
189
156
|
phone_numbers == o.phone_numbers &&
|
190
|
-
private_key_pem == o.private_key_pem &&
|
191
|
-
public_key_pem == o.public_key_pem &&
|
192
|
-
public_key_sid == o.public_key_sid &&
|
193
157
|
twilio_workspace_sid == o.twilio_workspace_sid
|
194
158
|
end
|
195
159
|
|
@@ -202,7 +166,7 @@ module UltracartClient
|
|
202
166
|
# Calculates hash code according to all attributes.
|
203
167
|
# @return [Integer] Hash code
|
204
168
|
def hash
|
205
|
-
[account_sid, api_key_id, api_key_name,
|
169
|
+
[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
|
206
170
|
end
|
207
171
|
|
208
172
|
# 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: 4.0.
|
4
|
+
version: 4.0.230
|
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
|