ultracart_api 4.0.55.rc → 4.0.58.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -5
- data/docs/CartMarketing.md +2 -0
- data/docs/ConversationParticipant.md +2 -0
- data/docs/ConversationWebchatQueueStatusAgent.md +4 -2
- data/docs/EmailCommseqSequenceTestRequest.md +13 -1
- data/docs/ExperimentVariation.md +2 -0
- data/docs/ExperimentVariationStat.md +2 -0
- data/docs/ItemReview.md +90 -0
- data/docs/ItemReviews.md +2 -0
- data/docs/OrderApi.md +2 -0
- data/docs/OrderBilling.md +4 -0
- data/docs/OrderMarketing.md +2 -0
- data/docs/StorefrontApi.md +1 -1
- data/lib/ultracart_api/api/order_api.rb +3 -0
- data/lib/ultracart_api/api/storefront_api.rb +1 -1
- data/lib/ultracart_api/models/cart_marketing.rb +11 -1
- data/lib/ultracart_api/models/conversation_participant.rb +10 -1
- data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +49 -4
- data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +58 -4
- data/lib/ultracart_api/models/experiment_variation.rb +11 -1
- data/lib/ultracart_api/models/experiment_variation_stat.rb +11 -1
- data/lib/ultracart_api/models/item_review.rb +545 -0
- data/lib/ultracart_api/models/item_reviews.rb +12 -1
- data/lib/ultracart_api/models/order_billing.rb +51 -1
- data/lib/ultracart_api/models/order_marketing.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 206deb75e21fb2a4d9efe7b6e189d7ea7bf68580866dcde171fa10f5757e790d
|
4
|
+
data.tar.gz: 9ed88d43c55f74363b6006df5926aa6d3012a39f314ae06d0f17176927eb9825
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 60fd4bc3266bea7a0e10f3d0b40984dff684ce8ad945c31acea17887da10fdf90182f9254413438d4e75f7e5e232f0c648c4045566518b23f50534f88dc6122b
|
7
|
+
data.tar.gz: 6cee56e4a0795664101442d6240db26c2e9bdcaa949e7e2d4efd9c64cb06cc8a02e1b04daa940c79d1bd0b3532f9f4c28582a70c65a50f2cd2acebad79e4004c
|
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.58.rc
|
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.58.rc.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.58.rc.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.58.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -336,7 +336,7 @@ Class | Method | HTTP request | Description
|
|
336
336
|
*UltracartClient::StorefrontApi* | [**get_screen_recordings_by_query**](docs/StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings
|
337
337
|
*UltracartClient::StorefrontApi* | [**get_screen_recordings_by_segment**](docs/StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment
|
338
338
|
*UltracartClient::StorefrontApi* | [**get_store_front_pricing_tiers**](docs/StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
|
339
|
-
*UltracartClient::StorefrontApi* | [**get_store_fronts**](docs/StorefrontApi.md#get_store_fronts) | **GET** /storefront
|
339
|
+
*UltracartClient::StorefrontApi* | [**get_store_fronts**](docs/StorefrontApi.md#get_store_fronts) | **GET** /storefront | Get storefronts (internal use only for security reasons)
|
340
340
|
*UltracartClient::StorefrontApi* | [**get_thumbnail_parameters**](docs/StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
|
341
341
|
*UltracartClient::StorefrontApi* | [**get_transaction_email**](docs/StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
|
342
342
|
*UltracartClient::StorefrontApi* | [**get_transaction_email_list**](docs/StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
|
@@ -889,6 +889,7 @@ Class | Method | HTTP request | Description
|
|
889
889
|
- [UltracartClient::ItemRestriction](docs/ItemRestriction.md)
|
890
890
|
- [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
|
891
891
|
- [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
|
892
|
+
- [UltracartClient::ItemReview](docs/ItemReview.md)
|
892
893
|
- [UltracartClient::ItemReviews](docs/ItemReviews.md)
|
893
894
|
- [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
|
894
895
|
- [UltracartClient::ItemShipping](docs/ItemShipping.md)
|
@@ -1187,6 +1188,9 @@ Not every change is committed to every SDK.
|
|
1187
1188
|
|
1188
1189
|
| Version | Date | Comments |
|
1189
1190
|
| --: | :-: | --- |
|
1191
|
+
| 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
|
1192
|
+
| 4.0.57-RC | 08/22/2022 | exposing individual reviews within item.review object |
|
1193
|
+
| 4.0.56-RC | 08/19/2022 | order api - added cell phone fields for sms |
|
1190
1194
|
| 4.0.55-RC | 08/12/2022 | internal code to allow merchant login as customer |
|
1191
1195
|
| 4.0.54-RC | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
1192
1196
|
| 4.0.53-RC | 08/10/2022 | conversation event refactoring |
|
data/docs/CartMarketing.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **advertising_source** | **String** | The advertising source the customer indicated | [optional] |
|
8
|
+
| **cell_phone_opt_in** | **Boolean** | True if the customer agrees to receiving marketing SMS messages | [optional] |
|
8
9
|
| **mailing_list_opt_in** | **Boolean** | True if the customer agrees to receiving marketing emails | [optional] |
|
9
10
|
|
10
11
|
## Example
|
@@ -14,6 +15,7 @@ require 'ultracart_api'
|
|
14
15
|
|
15
16
|
instance = UltracartClient::CartMarketing.new(
|
16
17
|
advertising_source: null,
|
18
|
+
cell_phone_opt_in: null,
|
17
19
|
mailing_list_opt_in: null
|
18
20
|
)
|
19
21
|
```
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **joined_dts** | **String** | Joined conversation date/time | [optional] |
|
11
11
|
| **last_message_dts** | **String** | Last message date/time | [optional] |
|
12
12
|
| **left_dts** | **String** | Left conversation date/time | [optional] |
|
13
|
+
| **profile_image_url** | **String** | | [optional] |
|
13
14
|
| **status** | **String** | | [optional] |
|
14
15
|
| **unread_messages** | **Integer** | | [optional] |
|
15
16
|
|
@@ -25,6 +26,7 @@ instance = UltracartClient::ConversationParticipant.new(
|
|
25
26
|
joined_dts: null,
|
26
27
|
last_message_dts: null,
|
27
28
|
left_dts: null,
|
29
|
+
profile_image_url: null,
|
28
30
|
status: null,
|
29
31
|
unread_messages: null
|
30
32
|
)
|
@@ -4,11 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **agent_status** | **String** |
|
7
|
+
| **agent_status** | **String** | Status of the agent | [optional] |
|
8
8
|
| **conversation_participant_arn** | **String** | | [optional] |
|
9
9
|
| **conversation_participant_name** | **String** | | [optional] |
|
10
10
|
| **last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional] |
|
11
11
|
| **next_round_robin** | **Boolean** | | [optional] |
|
12
|
+
| **profile_image_url** | **String** | Profile image URL | [optional] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = UltracartClient::ConversationWebchatQueueStatusAgent.new(
|
|
20
21
|
conversation_participant_arn: null,
|
21
22
|
conversation_participant_name: null,
|
22
23
|
last_chat_dts: null,
|
23
|
-
next_round_robin: null
|
24
|
+
next_round_robin: null,
|
25
|
+
profile_image_url: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -4,14 +4,20 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **address_1** | **String** | | [optional] |
|
8
|
+
| **address_2** | **String** | | [optional] |
|
7
9
|
| **cart_id** | **String** | | [optional] |
|
8
10
|
| **cart_item_ids** | **Array<String>** | | [optional] |
|
11
|
+
| **city** | **String** | | [optional] |
|
9
12
|
| **esp_commseq_uuid** | **String** | | [optional] |
|
13
|
+
| **mail_card** | **Boolean** | | [optional] |
|
10
14
|
| **name** | **String** | | [optional] |
|
11
15
|
| **order_id** | **String** | | [optional] |
|
12
16
|
| **please_review** | **Boolean** | | [optional] |
|
17
|
+
| **postal_code** | **String** | | [optional] |
|
13
18
|
| **send_to_email** | **String** | | [optional] |
|
14
19
|
| **send_to_logged_in_user** | **Boolean** | | [optional] |
|
20
|
+
| **state** | **String** | | [optional] |
|
15
21
|
|
16
22
|
## Example
|
17
23
|
|
@@ -19,14 +25,20 @@
|
|
19
25
|
require 'ultracart_api'
|
20
26
|
|
21
27
|
instance = UltracartClient::EmailCommseqSequenceTestRequest.new(
|
28
|
+
address_1: null,
|
29
|
+
address_2: null,
|
22
30
|
cart_id: null,
|
23
31
|
cart_item_ids: null,
|
32
|
+
city: null,
|
24
33
|
esp_commseq_uuid: null,
|
34
|
+
mail_card: null,
|
25
35
|
name: null,
|
26
36
|
order_id: null,
|
27
37
|
please_review: null,
|
38
|
+
postal_code: null,
|
28
39
|
send_to_email: null,
|
29
|
-
send_to_logged_in_user: null
|
40
|
+
send_to_logged_in_user: null,
|
41
|
+
state: null
|
30
42
|
)
|
31
43
|
```
|
32
44
|
|
data/docs/ExperimentVariation.md
CHANGED
@@ -21,6 +21,7 @@
|
|
21
21
|
| **paused** | **Boolean** | True if traffic should be paused to this variation | [optional] |
|
22
22
|
| **revenue** | **Float** | Total revenue for this variation | [optional] |
|
23
23
|
| **session_count** | **Integer** | Total sessions for this variation | [optional] |
|
24
|
+
| **sms_opt_ins** | **Integer** | SMS Opt Ins for this variation | [optional] |
|
24
25
|
| **traffic_percentage** | **Float** | Percentage of the traffic this variation is currently receiving | [optional] |
|
25
26
|
| **url** | **String** | Url of the variation if this experiment is a url experiment. | [optional] |
|
26
27
|
| **variation_name** | **String** | Name of the variation | [optional] |
|
@@ -50,6 +51,7 @@ instance = UltracartClient::ExperimentVariation.new(
|
|
50
51
|
paused: null,
|
51
52
|
revenue: null,
|
52
53
|
session_count: null,
|
54
|
+
sms_opt_ins: null,
|
53
55
|
traffic_percentage: null,
|
54
56
|
url: null,
|
55
57
|
variation_name: null,
|
@@ -14,6 +14,7 @@
|
|
14
14
|
| **page_view_count** | **Integer** | Total page view count for this variation | [optional] |
|
15
15
|
| **revenue** | **Float** | Total revenue for this variation | [optional] |
|
16
16
|
| **session_count** | **Integer** | Total sessions for this variation | [optional] |
|
17
|
+
| **sms_opt_in_count** | **Integer** | Total SMS opt in count for this variation | [optional] |
|
17
18
|
| **stat_dts** | **String** | Date/time that the statistic was created | [optional] |
|
18
19
|
|
19
20
|
## Example
|
@@ -32,6 +33,7 @@ instance = UltracartClient::ExperimentVariationStat.new(
|
|
32
33
|
page_view_count: null,
|
33
34
|
revenue: null,
|
34
35
|
session_count: null,
|
36
|
+
sms_opt_in_count: null,
|
35
37
|
stat_dts: null
|
36
38
|
)
|
37
39
|
```
|
data/docs/ItemReview.md
ADDED
@@ -0,0 +1,90 @@
|
|
1
|
+
# UltracartClient::ItemReview
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_profile_oid** | **Integer** | Customer profile object identifier | [optional] |
|
8
|
+
| **featured** | **Boolean** | | [optional] |
|
9
|
+
| **helperful_no_votes** | **Integer** | | [optional] |
|
10
|
+
| **helpful_yes_votes** | **Integer** | | [optional] |
|
11
|
+
| **order_id** | **String** | | [optional] |
|
12
|
+
| **overall** | **Float** | | [optional] |
|
13
|
+
| **rating_name1** | **String** | | [optional] |
|
14
|
+
| **rating_name10** | **String** | | [optional] |
|
15
|
+
| **rating_name2** | **String** | | [optional] |
|
16
|
+
| **rating_name3** | **String** | | [optional] |
|
17
|
+
| **rating_name4** | **String** | | [optional] |
|
18
|
+
| **rating_name5** | **String** | | [optional] |
|
19
|
+
| **rating_name6** | **String** | | [optional] |
|
20
|
+
| **rating_name7** | **String** | | [optional] |
|
21
|
+
| **rating_name8** | **String** | | [optional] |
|
22
|
+
| **rating_name9** | **String** | | [optional] |
|
23
|
+
| **rating_score1** | **Float** | | [optional] |
|
24
|
+
| **rating_score10** | **Float** | | [optional] |
|
25
|
+
| **rating_score2** | **Float** | | [optional] |
|
26
|
+
| **rating_score3** | **Float** | | [optional] |
|
27
|
+
| **rating_score4** | **Float** | | [optional] |
|
28
|
+
| **rating_score5** | **Float** | | [optional] |
|
29
|
+
| **rating_score6** | **Float** | | [optional] |
|
30
|
+
| **rating_score7** | **Float** | | [optional] |
|
31
|
+
| **rating_score8** | **Float** | | [optional] |
|
32
|
+
| **rating_score9** | **Float** | | [optional] |
|
33
|
+
| **recommend_store_to_friend** | **Integer** | | [optional] |
|
34
|
+
| **recommend_to_friend** | **Boolean** | | [optional] |
|
35
|
+
| **review** | **String** | | [optional] |
|
36
|
+
| **review_oid** | **Integer** | | [optional] |
|
37
|
+
| **reviewed_nickname** | **String** | | [optional] |
|
38
|
+
| **reviewer_email** | **String** | | [optional] |
|
39
|
+
| **reviewer_location** | **String** | | [optional] |
|
40
|
+
| **status** | **String** | | [optional] |
|
41
|
+
| **store_feedback** | **String** | | [optional] |
|
42
|
+
| **submitted_dts** | **String** | Date/time of review submission | [optional] |
|
43
|
+
| **title** | **String** | | [optional] |
|
44
|
+
|
45
|
+
## Example
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
require 'ultracart_api'
|
49
|
+
|
50
|
+
instance = UltracartClient::ItemReview.new(
|
51
|
+
customer_profile_oid: null,
|
52
|
+
featured: null,
|
53
|
+
helperful_no_votes: null,
|
54
|
+
helpful_yes_votes: null,
|
55
|
+
order_id: null,
|
56
|
+
overall: null,
|
57
|
+
rating_name1: null,
|
58
|
+
rating_name10: null,
|
59
|
+
rating_name2: null,
|
60
|
+
rating_name3: null,
|
61
|
+
rating_name4: null,
|
62
|
+
rating_name5: null,
|
63
|
+
rating_name6: null,
|
64
|
+
rating_name7: null,
|
65
|
+
rating_name8: null,
|
66
|
+
rating_name9: null,
|
67
|
+
rating_score1: null,
|
68
|
+
rating_score10: null,
|
69
|
+
rating_score2: null,
|
70
|
+
rating_score3: null,
|
71
|
+
rating_score4: null,
|
72
|
+
rating_score5: null,
|
73
|
+
rating_score6: null,
|
74
|
+
rating_score7: null,
|
75
|
+
rating_score8: null,
|
76
|
+
rating_score9: null,
|
77
|
+
recommend_store_to_friend: null,
|
78
|
+
recommend_to_friend: null,
|
79
|
+
review: null,
|
80
|
+
review_oid: null,
|
81
|
+
reviewed_nickname: null,
|
82
|
+
reviewer_email: null,
|
83
|
+
reviewer_location: null,
|
84
|
+
status: null,
|
85
|
+
store_feedback: null,
|
86
|
+
submitted_dts: null,
|
87
|
+
title: null
|
88
|
+
)
|
89
|
+
```
|
90
|
+
|
data/docs/ItemReviews.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **has_approved_review** | **Boolean** | True if the item has an approved review | [optional] |
|
8
8
|
| **has_review** | **Boolean** | True if the item has a review | [optional] |
|
9
|
+
| **individual_reviews** | [**Array<ItemReview>**](ItemReview.md) | | [optional] |
|
9
10
|
| **review_count** | **Integer** | Number of approved reviews | [optional] |
|
10
11
|
| **review_overall** | **Float** | Overall score of reviews | [optional] |
|
11
12
|
| **review_template_name** | **String** | Review template name | [optional] |
|
@@ -22,6 +23,7 @@ require 'ultracart_api'
|
|
22
23
|
instance = UltracartClient::ItemReviews.new(
|
23
24
|
has_approved_review: null,
|
24
25
|
has_review: null,
|
26
|
+
individual_reviews: null,
|
25
27
|
review_count: null,
|
26
28
|
review_overall: null,
|
27
29
|
review_template_name: null,
|
data/docs/OrderApi.md
CHANGED
@@ -1366,6 +1366,7 @@ opts = {
|
|
1366
1366
|
auto_order_cancel: true, # Boolean | Cancel associated auto orders
|
1367
1367
|
manual_refund: true, # Boolean | Consider a manual refund done externally
|
1368
1368
|
reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
|
1369
|
+
issue_store_credit: true, # Boolean | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
1369
1370
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
1370
1371
|
}
|
1371
1372
|
|
@@ -1407,6 +1408,7 @@ end
|
|
1407
1408
|
| **auto_order_cancel** | **Boolean** | Cancel associated auto orders | [optional][default to false] |
|
1408
1409
|
| **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
|
1409
1410
|
| **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
|
1411
|
+
| **issue_store_credit** | **Boolean** | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional][default to false] |
|
1410
1412
|
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
1411
1413
|
|
1412
1414
|
### Return type
|
data/docs/OrderBilling.md
CHANGED
@@ -7,6 +7,8 @@
|
|
7
7
|
| **address1** | **String** | Address line 1 | [optional] |
|
8
8
|
| **address2** | **String** | Address line 2 | [optional] |
|
9
9
|
| **cc_emails** | **Array<String>** | CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters. | [optional] |
|
10
|
+
| **cell_phone** | **String** | Cell phone | [optional] |
|
11
|
+
| **cell_phone_e164** | **String** | Cell phone (E164 format) | [optional] |
|
10
12
|
| **city** | **String** | City | [optional] |
|
11
13
|
| **company** | **String** | Company | [optional] |
|
12
14
|
| **country_code** | **String** | ISO-3166 two letter country code | [optional] |
|
@@ -30,6 +32,8 @@ instance = UltracartClient::OrderBilling.new(
|
|
30
32
|
address1: null,
|
31
33
|
address2: null,
|
32
34
|
cc_emails: null,
|
35
|
+
cell_phone: null,
|
36
|
+
cell_phone_e164: null,
|
33
37
|
city: null,
|
34
38
|
company: null,
|
35
39
|
country_code: null,
|
data/docs/OrderMarketing.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **advertising_source** | **String** | Advertising source | [optional] |
|
8
|
+
| **cell_phone_opt_in** | **Boolean** | True if the customer has opted into SMS marketing | [optional] |
|
8
9
|
| **mailing_list** | **Boolean** | True if the customer has opted into mailing list subscription | [optional] |
|
9
10
|
| **referral_code** | **String** | Referral code | [optional] |
|
10
11
|
|
@@ -15,6 +16,7 @@ require 'ultracart_api'
|
|
15
16
|
|
16
17
|
instance = UltracartClient::OrderMarketing.new(
|
17
18
|
advertising_source: null,
|
19
|
+
cell_phone_opt_in: null,
|
18
20
|
mailing_list: null,
|
19
21
|
referral_code: null
|
20
22
|
)
|
data/docs/StorefrontApi.md
CHANGED
@@ -105,7 +105,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
105
105
|
| [**get_screen_recordings_by_query**](StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings |
|
106
106
|
| [**get_screen_recordings_by_segment**](StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment |
|
107
107
|
| [**get_store_front_pricing_tiers**](StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers |
|
108
|
-
| [**get_store_fronts**](StorefrontApi.md#get_store_fronts) | **GET** /storefront
|
108
|
+
| [**get_store_fronts**](StorefrontApi.md#get_store_fronts) | **GET** /storefront | Get storefronts (internal use only for security reasons) |
|
109
109
|
| [**get_thumbnail_parameters**](StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters |
|
110
110
|
| [**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object |
|
111
111
|
| [**get_transaction_email_list**](StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names |
|
@@ -1292,6 +1292,7 @@ module UltracartClient
|
|
1292
1292
|
# @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
|
1293
1293
|
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1294
1294
|
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1295
|
+
# @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
|
1295
1296
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1296
1297
|
# @return [OrderResponse]
|
1297
1298
|
def refund_order(order_id, order, opts = {})
|
@@ -1309,6 +1310,7 @@ module UltracartClient
|
|
1309
1310
|
# @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
|
1310
1311
|
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1311
1312
|
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1313
|
+
# @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
|
1312
1314
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1313
1315
|
# @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
|
1314
1316
|
def refund_order_with_http_info(order_id, order, opts = {})
|
@@ -1333,6 +1335,7 @@ module UltracartClient
|
|
1333
1335
|
query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
|
1334
1336
|
query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
|
1335
1337
|
query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
|
1338
|
+
query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
|
1336
1339
|
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
1337
1340
|
|
1338
1341
|
# header parameters
|
@@ -6910,7 +6910,7 @@ module UltracartClient
|
|
6910
6910
|
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
|
6911
6911
|
end
|
6912
6912
|
# resource path
|
6913
|
-
local_var_path = '/storefront
|
6913
|
+
local_var_path = '/storefront'
|
6914
6914
|
|
6915
6915
|
# query parameters
|
6916
6916
|
query_params = opts[:query_params] || {}
|
@@ -18,6 +18,9 @@ module UltracartClient
|
|
18
18
|
# The advertising source the customer indicated
|
19
19
|
attr_accessor :advertising_source
|
20
20
|
|
21
|
+
# True if the customer agrees to receiving marketing SMS messages
|
22
|
+
attr_accessor :cell_phone_opt_in
|
23
|
+
|
21
24
|
# True if the customer agrees to receiving marketing emails
|
22
25
|
attr_accessor :mailing_list_opt_in
|
23
26
|
|
@@ -25,6 +28,7 @@ module UltracartClient
|
|
25
28
|
def self.attribute_map
|
26
29
|
{
|
27
30
|
:'advertising_source' => :'advertising_source',
|
31
|
+
:'cell_phone_opt_in' => :'cell_phone_opt_in',
|
28
32
|
:'mailing_list_opt_in' => :'mailing_list_opt_in'
|
29
33
|
}
|
30
34
|
end
|
@@ -38,6 +42,7 @@ module UltracartClient
|
|
38
42
|
def self.openapi_types
|
39
43
|
{
|
40
44
|
:'advertising_source' => :'String',
|
45
|
+
:'cell_phone_opt_in' => :'Boolean',
|
41
46
|
:'mailing_list_opt_in' => :'Boolean'
|
42
47
|
}
|
43
48
|
end
|
@@ -67,6 +72,10 @@ module UltracartClient
|
|
67
72
|
self.advertising_source = attributes[:'advertising_source']
|
68
73
|
end
|
69
74
|
|
75
|
+
if attributes.key?(:'cell_phone_opt_in')
|
76
|
+
self.cell_phone_opt_in = attributes[:'cell_phone_opt_in']
|
77
|
+
end
|
78
|
+
|
70
79
|
if attributes.key?(:'mailing_list_opt_in')
|
71
80
|
self.mailing_list_opt_in = attributes[:'mailing_list_opt_in']
|
72
81
|
end
|
@@ -91,6 +100,7 @@ module UltracartClient
|
|
91
100
|
return true if self.equal?(o)
|
92
101
|
self.class == o.class &&
|
93
102
|
advertising_source == o.advertising_source &&
|
103
|
+
cell_phone_opt_in == o.cell_phone_opt_in &&
|
94
104
|
mailing_list_opt_in == o.mailing_list_opt_in
|
95
105
|
end
|
96
106
|
|
@@ -103,7 +113,7 @@ module UltracartClient
|
|
103
113
|
# Calculates hash code according to all attributes.
|
104
114
|
# @return [Integer] Hash code
|
105
115
|
def hash
|
106
|
-
[advertising_source, mailing_list_opt_in].hash
|
116
|
+
[advertising_source, cell_phone_opt_in, mailing_list_opt_in].hash
|
107
117
|
end
|
108
118
|
|
109
119
|
# Builds the object from hash
|
@@ -30,6 +30,8 @@ module UltracartClient
|
|
30
30
|
# Left conversation date/time
|
31
31
|
attr_accessor :left_dts
|
32
32
|
|
33
|
+
attr_accessor :profile_image_url
|
34
|
+
|
33
35
|
attr_accessor :status
|
34
36
|
|
35
37
|
attr_accessor :unread_messages
|
@@ -43,6 +45,7 @@ module UltracartClient
|
|
43
45
|
:'joined_dts' => :'joined_dts',
|
44
46
|
:'last_message_dts' => :'last_message_dts',
|
45
47
|
:'left_dts' => :'left_dts',
|
48
|
+
:'profile_image_url' => :'profile_image_url',
|
46
49
|
:'status' => :'status',
|
47
50
|
:'unread_messages' => :'unread_messages'
|
48
51
|
}
|
@@ -62,6 +65,7 @@ module UltracartClient
|
|
62
65
|
:'joined_dts' => :'String',
|
63
66
|
:'last_message_dts' => :'String',
|
64
67
|
:'left_dts' => :'String',
|
68
|
+
:'profile_image_url' => :'String',
|
65
69
|
:'status' => :'String',
|
66
70
|
:'unread_messages' => :'Integer'
|
67
71
|
}
|
@@ -112,6 +116,10 @@ module UltracartClient
|
|
112
116
|
self.left_dts = attributes[:'left_dts']
|
113
117
|
end
|
114
118
|
|
119
|
+
if attributes.key?(:'profile_image_url')
|
120
|
+
self.profile_image_url = attributes[:'profile_image_url']
|
121
|
+
end
|
122
|
+
|
115
123
|
if attributes.key?(:'status')
|
116
124
|
self.status = attributes[:'status']
|
117
125
|
end
|
@@ -145,6 +153,7 @@ module UltracartClient
|
|
145
153
|
joined_dts == o.joined_dts &&
|
146
154
|
last_message_dts == o.last_message_dts &&
|
147
155
|
left_dts == o.left_dts &&
|
156
|
+
profile_image_url == o.profile_image_url &&
|
148
157
|
status == o.status &&
|
149
158
|
unread_messages == o.unread_messages
|
150
159
|
end
|
@@ -158,7 +167,7 @@ module UltracartClient
|
|
158
167
|
# Calculates hash code according to all attributes.
|
159
168
|
# @return [Integer] Hash code
|
160
169
|
def hash
|
161
|
-
[conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, status, unread_messages].hash
|
170
|
+
[conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, profile_image_url, status, unread_messages].hash
|
162
171
|
end
|
163
172
|
|
164
173
|
# Builds the object from hash
|
@@ -15,6 +15,7 @@ require 'time'
|
|
15
15
|
|
16
16
|
module UltracartClient
|
17
17
|
class ConversationWebchatQueueStatusAgent
|
18
|
+
# Status of the agent
|
18
19
|
attr_accessor :agent_status
|
19
20
|
|
20
21
|
attr_accessor :conversation_participant_arn
|
@@ -26,6 +27,31 @@ module UltracartClient
|
|
26
27
|
|
27
28
|
attr_accessor :next_round_robin
|
28
29
|
|
30
|
+
# Profile image URL
|
31
|
+
attr_accessor :profile_image_url
|
32
|
+
|
33
|
+
class EnumAttributeValidator
|
34
|
+
attr_reader :datatype
|
35
|
+
attr_reader :allowable_values
|
36
|
+
|
37
|
+
def initialize(datatype, allowable_values)
|
38
|
+
@allowable_values = allowable_values.map do |value|
|
39
|
+
case datatype.to_s
|
40
|
+
when /Integer/i
|
41
|
+
value.to_i
|
42
|
+
when /Float/i
|
43
|
+
value.to_f
|
44
|
+
else
|
45
|
+
value
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
def valid?(value)
|
51
|
+
!value || allowable_values.include?(value)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
29
55
|
# Attribute mapping from ruby-style variable name to JSON key.
|
30
56
|
def self.attribute_map
|
31
57
|
{
|
@@ -33,7 +59,8 @@ module UltracartClient
|
|
33
59
|
:'conversation_participant_arn' => :'conversation_participant_arn',
|
34
60
|
:'conversation_participant_name' => :'conversation_participant_name',
|
35
61
|
:'last_chat_dts' => :'last_chat_dts',
|
36
|
-
:'next_round_robin' => :'next_round_robin'
|
62
|
+
:'next_round_robin' => :'next_round_robin',
|
63
|
+
:'profile_image_url' => :'profile_image_url'
|
37
64
|
}
|
38
65
|
end
|
39
66
|
|
@@ -49,7 +76,8 @@ module UltracartClient
|
|
49
76
|
:'conversation_participant_arn' => :'String',
|
50
77
|
:'conversation_participant_name' => :'String',
|
51
78
|
:'last_chat_dts' => :'String',
|
52
|
-
:'next_round_robin' => :'Boolean'
|
79
|
+
:'next_round_robin' => :'Boolean',
|
80
|
+
:'profile_image_url' => :'String'
|
53
81
|
}
|
54
82
|
end
|
55
83
|
|
@@ -93,6 +121,10 @@ module UltracartClient
|
|
93
121
|
if attributes.key?(:'next_round_robin')
|
94
122
|
self.next_round_robin = attributes[:'next_round_robin']
|
95
123
|
end
|
124
|
+
|
125
|
+
if attributes.key?(:'profile_image_url')
|
126
|
+
self.profile_image_url = attributes[:'profile_image_url']
|
127
|
+
end
|
96
128
|
end
|
97
129
|
|
98
130
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -105,9 +137,21 @@ module UltracartClient
|
|
105
137
|
# Check to see if the all the properties in the model are valid
|
106
138
|
# @return true if the model is valid
|
107
139
|
def valid?
|
140
|
+
agent_status_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
|
141
|
+
return false unless agent_status_validator.valid?(@agent_status)
|
108
142
|
true
|
109
143
|
end
|
110
144
|
|
145
|
+
# Custom attribute writer method checking allowed values (enum).
|
146
|
+
# @param [Object] agent_status Object to be assigned
|
147
|
+
def agent_status=(agent_status)
|
148
|
+
validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
|
149
|
+
unless validator.valid?(agent_status)
|
150
|
+
fail ArgumentError, "invalid value for \"agent_status\", must be one of #{validator.allowable_values}."
|
151
|
+
end
|
152
|
+
@agent_status = agent_status
|
153
|
+
end
|
154
|
+
|
111
155
|
# Checks equality by comparing each attribute.
|
112
156
|
# @param [Object] Object to be compared
|
113
157
|
def ==(o)
|
@@ -117,7 +161,8 @@ module UltracartClient
|
|
117
161
|
conversation_participant_arn == o.conversation_participant_arn &&
|
118
162
|
conversation_participant_name == o.conversation_participant_name &&
|
119
163
|
last_chat_dts == o.last_chat_dts &&
|
120
|
-
next_round_robin == o.next_round_robin
|
164
|
+
next_round_robin == o.next_round_robin &&
|
165
|
+
profile_image_url == o.profile_image_url
|
121
166
|
end
|
122
167
|
|
123
168
|
# @see the `==` method
|
@@ -129,7 +174,7 @@ module UltracartClient
|
|
129
174
|
# Calculates hash code according to all attributes.
|
130
175
|
# @return [Integer] Hash code
|
131
176
|
def hash
|
132
|
-
[agent_status, conversation_participant_arn, conversation_participant_name, last_chat_dts, next_round_robin].hash
|
177
|
+
[agent_status, conversation_participant_arn, conversation_participant_name, last_chat_dts, next_round_robin, profile_image_url].hash
|
133
178
|
end
|
134
179
|
|
135
180
|
# Builds the object from hash
|