ultracart_api 3.10.37 → 3.10.40
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/CartMarketing.md +1 -0
- data/docs/ConversationParticipant.md +1 -0
- data/docs/ConversationWebchatQueueStatusAgent.md +2 -1
- data/docs/CustomerApi.md +54 -0
- data/docs/CustomerMagicLinkResponse.md +12 -0
- data/docs/ItemReview.md +44 -0
- data/docs/ItemReviews.md +1 -0
- data/docs/OrderBilling.md +2 -0
- data/docs/OrderMarketing.md +1 -0
- data/docs/StoreFront.md +18 -0
- data/docs/StoreFrontsResponse.md +12 -0
- data/docs/StorefrontApi.md +44 -0
- data/lib/ultracart_api/api/customer_api.rb +61 -0
- data/lib/ultracart_api/api/storefront_api.rb +47 -0
- 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/customer_magic_link_response.rb +222 -0
- data/lib/ultracart_api/models/item_review.rb +510 -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/models/store_front.rb +274 -0
- data/lib/ultracart_api/models/store_fronts_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f109507d36b123504da241a6e661fb776e163162b5f6a359623a06f40e949997
|
4
|
+
data.tar.gz: bf40bf5365d215b5b5658741f1f9647fd1b4397b1a6095abd72c8ef230aaeec5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8b34412e9e9bf82fb02194d134df7d7cfe8cc752d30a3908a0b9fa3670418e2cd7dfcfa19adbf2b535b957481072fe3670b7a590ae2b7b567b442820ef2d8f24
|
7
|
+
data.tar.gz: bb800367609a21b1133e261549e2839b337c171b536418e90e1ebde2cf3cb7ff11678eef39c5650d589ff5419b2e2a47fd417686756c171e6cbe7ed6facb3a04
|
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.40
|
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.40.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.40.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.40'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
165
165
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
166
166
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
167
167
|
*UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
|
168
|
+
*UltracartClient::CustomerApi* | [**get_magic_link**](docs/CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
168
169
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
169
170
|
*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
170
171
|
*UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
@@ -329,6 +330,7 @@ Class | Method | HTTP request | Description
|
|
329
330
|
*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
|
330
331
|
*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
|
331
332
|
*UltracartClient::StorefrontApi* | [**get_store_front_pricing_tiers**](docs/StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
|
333
|
+
*UltracartClient::StorefrontApi* | [**get_store_fronts**](docs/StorefrontApi.md#get_store_fronts) | **GET** /storefront | Get storefronts (internal use only for security reasons)
|
332
334
|
*UltracartClient::StorefrontApi* | [**get_thumbnail_parameters**](docs/StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
|
333
335
|
*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
|
334
336
|
*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
|
@@ -661,6 +663,7 @@ Class | Method | HTTP request | Description
|
|
661
663
|
- [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
|
662
664
|
- [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
|
663
665
|
- [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
|
666
|
+
- [UltracartClient::CustomerMagicLinkResponse](docs/CustomerMagicLinkResponse.md)
|
664
667
|
- [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
|
665
668
|
- [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
|
666
669
|
- [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
|
@@ -880,6 +883,7 @@ Class | Method | HTTP request | Description
|
|
880
883
|
- [UltracartClient::ItemRestriction](docs/ItemRestriction.md)
|
881
884
|
- [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
|
882
885
|
- [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
|
886
|
+
- [UltracartClient::ItemReview](docs/ItemReview.md)
|
883
887
|
- [UltracartClient::ItemReviews](docs/ItemReviews.md)
|
884
888
|
- [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
|
885
889
|
- [UltracartClient::ItemShipping](docs/ItemShipping.md)
|
@@ -1048,6 +1052,8 @@ Class | Method | HTTP request | Description
|
|
1048
1052
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
1049
1053
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
1050
1054
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
1055
|
+
- [UltracartClient::StoreFront](docs/StoreFront.md)
|
1056
|
+
- [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
|
1051
1057
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
1052
1058
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
1053
1059
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
@@ -1173,6 +1179,9 @@ Not every change is committed to every SDK.
|
|
1173
1179
|
|
1174
1180
|
| Version | Date | Comments |
|
1175
1181
|
| --: | :-: | --- |
|
1182
|
+
| 3.10.40 | 08/22/2022 | exposing individual reviews within item.review object |
|
1183
|
+
| 3.10.39 | 08/19/2022 | order api - added cell phone fields for sms |
|
1184
|
+
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
1176
1185
|
| 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
1177
1186
|
| 3.10.36 | 08/10/2022 | conversation event refactoring |
|
1178
1187
|
| 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
|
data/docs/CartMarketing.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**advertising_source** | **String** | The advertising source the customer indicated | [optional]
|
7
|
+
**cell_phone_opt_in** | **BOOLEAN** | True if the customer agrees to receiving marketing SMS messages | [optional]
|
7
8
|
**mailing_list_opt_in** | **BOOLEAN** | True if the customer agrees to receiving marketing emails | [optional]
|
8
9
|
|
9
10
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**joined_dts** | **String** | Joined conversation date/time | [optional]
|
10
10
|
**last_message_dts** | **String** | Last message date/time | [optional]
|
11
11
|
**left_dts** | **String** | Left conversation date/time | [optional]
|
12
|
+
**profile_image_url** | **String** | | [optional]
|
12
13
|
**status** | **String** | | [optional]
|
13
14
|
**unread_messages** | **Integer** | | [optional]
|
14
15
|
|
@@ -3,10 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**agent_status** | **String** |
|
6
|
+
**agent_status** | **String** | Status of the agent | [optional]
|
7
7
|
**conversation_participant_arn** | **String** | | [optional]
|
8
8
|
**conversation_participant_name** | **String** | | [optional]
|
9
9
|
**last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional]
|
10
10
|
**next_round_robin** | **BOOLEAN** | | [optional]
|
11
|
+
**profile_image_url** | **String** | Profile image URL | [optional]
|
11
12
|
|
12
13
|
|
data/docs/CustomerApi.md
CHANGED
@@ -16,6 +16,7 @@ Method | HTTP request | Description
|
|
16
16
|
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
17
17
|
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
18
18
|
[**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
|
19
|
+
[**get_magic_link**](CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
19
20
|
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
20
21
|
[**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
21
22
|
[**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
@@ -703,6 +704,59 @@ Name | Type | Description | Notes
|
|
703
704
|
|
704
705
|
|
705
706
|
|
707
|
+
# **get_magic_link**
|
708
|
+
> CustomerMagicLinkResponse get_magic_link(customer_profile_oid, storefront_host_name)
|
709
|
+
|
710
|
+
getMagicLink
|
711
|
+
|
712
|
+
Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
713
|
+
|
714
|
+
### Example
|
715
|
+
```ruby
|
716
|
+
# load the gem
|
717
|
+
require 'ultracart_api'
|
718
|
+
|
719
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
720
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
721
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
722
|
+
|
723
|
+
|
724
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid of the customer.
|
725
|
+
|
726
|
+
storefront_host_name = 'storefront_host_name_example' # String | The storefront to log into.
|
727
|
+
|
728
|
+
|
729
|
+
begin
|
730
|
+
#getMagicLink
|
731
|
+
result = api_instance.get_magic_link(customer_profile_oid, storefront_host_name)
|
732
|
+
p result
|
733
|
+
rescue UltracartClient::ApiError => e
|
734
|
+
puts "Exception when calling CustomerApi->get_magic_link: #{e}"
|
735
|
+
end
|
736
|
+
```
|
737
|
+
|
738
|
+
### Parameters
|
739
|
+
|
740
|
+
Name | Type | Description | Notes
|
741
|
+
------------- | ------------- | ------------- | -------------
|
742
|
+
**customer_profile_oid** | **Integer**| The customer_profile_oid of the customer. |
|
743
|
+
**storefront_host_name** | **String**| The storefront to log into. |
|
744
|
+
|
745
|
+
### Return type
|
746
|
+
|
747
|
+
[**CustomerMagicLinkResponse**](CustomerMagicLinkResponse.md)
|
748
|
+
|
749
|
+
### Authorization
|
750
|
+
|
751
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
752
|
+
|
753
|
+
### HTTP request headers
|
754
|
+
|
755
|
+
- **Content-Type**: application/json; charset=UTF-8
|
756
|
+
- **Accept**: application/json
|
757
|
+
|
758
|
+
|
759
|
+
|
706
760
|
# **insert_customer**
|
707
761
|
> CustomerResponse insert_customer(customer, opts)
|
708
762
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomerMagicLinkResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**url** | **String** | URL | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/ItemReview.md
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
# UltracartClient::ItemReview
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_profile_oid** | **Integer** | Customer profile object identifier | [optional]
|
7
|
+
**featured** | **BOOLEAN** | | [optional]
|
8
|
+
**helperful_no_votes** | **Integer** | | [optional]
|
9
|
+
**helpful_yes_votes** | **Integer** | | [optional]
|
10
|
+
**order_id** | **String** | | [optional]
|
11
|
+
**overall** | **Float** | | [optional]
|
12
|
+
**rating_name1** | **String** | | [optional]
|
13
|
+
**rating_name10** | **String** | | [optional]
|
14
|
+
**rating_name2** | **String** | | [optional]
|
15
|
+
**rating_name3** | **String** | | [optional]
|
16
|
+
**rating_name4** | **String** | | [optional]
|
17
|
+
**rating_name5** | **String** | | [optional]
|
18
|
+
**rating_name6** | **String** | | [optional]
|
19
|
+
**rating_name7** | **String** | | [optional]
|
20
|
+
**rating_name8** | **String** | | [optional]
|
21
|
+
**rating_name9** | **String** | | [optional]
|
22
|
+
**rating_score1** | **Float** | | [optional]
|
23
|
+
**rating_score10** | **Float** | | [optional]
|
24
|
+
**rating_score2** | **Float** | | [optional]
|
25
|
+
**rating_score3** | **Float** | | [optional]
|
26
|
+
**rating_score4** | **Float** | | [optional]
|
27
|
+
**rating_score5** | **Float** | | [optional]
|
28
|
+
**rating_score6** | **Float** | | [optional]
|
29
|
+
**rating_score7** | **Float** | | [optional]
|
30
|
+
**rating_score8** | **Float** | | [optional]
|
31
|
+
**rating_score9** | **Float** | | [optional]
|
32
|
+
**recommend_store_to_friend** | **Integer** | | [optional]
|
33
|
+
**recommend_to_friend** | **BOOLEAN** | | [optional]
|
34
|
+
**review** | **String** | | [optional]
|
35
|
+
**review_oid** | **Integer** | | [optional]
|
36
|
+
**reviewed_nickname** | **String** | | [optional]
|
37
|
+
**reviewer_email** | **String** | | [optional]
|
38
|
+
**reviewer_location** | **String** | | [optional]
|
39
|
+
**status** | **String** | | [optional]
|
40
|
+
**store_feedback** | **String** | | [optional]
|
41
|
+
**submitted_dts** | **String** | Date/time of review submission | [optional]
|
42
|
+
**title** | **String** | | [optional]
|
43
|
+
|
44
|
+
|
data/docs/ItemReviews.md
CHANGED
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**has_approved_review** | **BOOLEAN** | True if the item has an approved review | [optional]
|
7
7
|
**has_review** | **BOOLEAN** | True if the item has a review | [optional]
|
8
|
+
**individual_reviews** | [**Array<ItemReview>**](ItemReview.md) | | [optional]
|
8
9
|
**review_count** | **Integer** | Number of approved reviews | [optional]
|
9
10
|
**review_overall** | **Float** | Overall score of reviews | [optional]
|
10
11
|
**review_template_name** | **String** | Review template name | [optional]
|
data/docs/OrderBilling.md
CHANGED
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
**address1** | **String** | Address line 1 | [optional]
|
7
7
|
**address2** | **String** | Address line 2 | [optional]
|
8
8
|
**cc_emails** | **Array<String>** | CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters. | [optional]
|
9
|
+
**cell_phone** | **String** | Cell phone | [optional]
|
10
|
+
**cell_phone_e164** | **String** | Cell phone (E164 format) | [optional]
|
9
11
|
**city** | **String** | City | [optional]
|
10
12
|
**company** | **String** | Company | [optional]
|
11
13
|
**country_code** | **String** | ISO-3166 two letter country code | [optional]
|
data/docs/OrderMarketing.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**advertising_source** | **String** | Advertising source | [optional]
|
7
|
+
**cell_phone_opt_in** | **BOOLEAN** | True if the customer has opted into SMS marketing | [optional]
|
7
8
|
**mailing_list** | **BOOLEAN** | True if the customer has opted into mailing list subscription | [optional]
|
8
9
|
**referral_code** | **String** | Referral code | [optional]
|
9
10
|
|
data/docs/StoreFront.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::StoreFront
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**host_alias1** | **String** | | [optional]
|
7
|
+
**host_alias2** | **String** | | [optional]
|
8
|
+
**host_alias3** | **String** | | [optional]
|
9
|
+
**host_alias4** | **String** | | [optional]
|
10
|
+
**host_alias5** | **String** | | [optional]
|
11
|
+
**host_name** | **String** | | [optional]
|
12
|
+
**locked** | **BOOLEAN** | | [optional]
|
13
|
+
**merchant_id** | **String** | | [optional]
|
14
|
+
**redirect_aliases** | **BOOLEAN** | | [optional]
|
15
|
+
**storefront_oid** | **Integer** | | [optional]
|
16
|
+
**unlock_password** | **String** | | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::StoreFrontsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**store_fronts** | [**Array<StoreFront>**](StoreFront.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/StorefrontApi.md
CHANGED
@@ -105,6 +105,7 @@ Method | HTTP request | Description
|
|
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 | Get storefronts (internal use only for security reasons)
|
108
109
|
[**get_thumbnail_parameters**](StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
|
109
110
|
[**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
|
110
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
|
@@ -5324,6 +5325,49 @@ Name | Type | Description | Notes
|
|
5324
5325
|
|
5325
5326
|
|
5326
5327
|
|
5328
|
+
# **get_store_fronts**
|
5329
|
+
> StoreFrontsResponse get_store_fronts
|
5330
|
+
|
5331
|
+
Get storefronts (internal use only for security reasons)
|
5332
|
+
|
5333
|
+
### Example
|
5334
|
+
```ruby
|
5335
|
+
# load the gem
|
5336
|
+
require 'ultracart_api'
|
5337
|
+
|
5338
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
5339
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
5340
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
5341
|
+
|
5342
|
+
|
5343
|
+
|
5344
|
+
begin
|
5345
|
+
#Get storefronts (internal use only for security reasons)
|
5346
|
+
result = api_instance.get_store_fronts
|
5347
|
+
p result
|
5348
|
+
rescue UltracartClient::ApiError => e
|
5349
|
+
puts "Exception when calling StorefrontApi->get_store_fronts: #{e}"
|
5350
|
+
end
|
5351
|
+
```
|
5352
|
+
|
5353
|
+
### Parameters
|
5354
|
+
This endpoint does not need any parameter.
|
5355
|
+
|
5356
|
+
### Return type
|
5357
|
+
|
5358
|
+
[**StoreFrontsResponse**](StoreFrontsResponse.md)
|
5359
|
+
|
5360
|
+
### Authorization
|
5361
|
+
|
5362
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
5363
|
+
|
5364
|
+
### HTTP request headers
|
5365
|
+
|
5366
|
+
- **Content-Type**: application/json
|
5367
|
+
- **Accept**: application/json
|
5368
|
+
|
5369
|
+
|
5370
|
+
|
5327
5371
|
# **get_thumbnail_parameters**
|
5328
5372
|
> ThumbnailParametersResponse get_thumbnail_parameters(thumbnail_parameters)
|
5329
5373
|
|
@@ -799,6 +799,67 @@ module UltracartClient
|
|
799
799
|
end
|
800
800
|
return data, status_code, headers
|
801
801
|
end
|
802
|
+
# getMagicLink
|
803
|
+
# Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
804
|
+
# @param customer_profile_oid The customer_profile_oid of the customer.
|
805
|
+
# @param storefront_host_name The storefront to log into.
|
806
|
+
# @param [Hash] opts the optional parameters
|
807
|
+
# @return [CustomerMagicLinkResponse]
|
808
|
+
def get_magic_link(customer_profile_oid, storefront_host_name, opts = {})
|
809
|
+
data, _status_code, _headers = get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts)
|
810
|
+
data
|
811
|
+
end
|
812
|
+
|
813
|
+
# getMagicLink
|
814
|
+
# Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
815
|
+
# @param customer_profile_oid The customer_profile_oid of the customer.
|
816
|
+
# @param storefront_host_name The storefront to log into.
|
817
|
+
# @param [Hash] opts the optional parameters
|
818
|
+
# @return [Array<(CustomerMagicLinkResponse, Fixnum, Hash)>] CustomerMagicLinkResponse data, response status code and response headers
|
819
|
+
def get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts = {})
|
820
|
+
if @api_client.config.debugging
|
821
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.get_magic_link ...'
|
822
|
+
end
|
823
|
+
# verify the required parameter 'customer_profile_oid' is set
|
824
|
+
if @api_client.config.client_side_validation && customer_profile_oid.nil?
|
825
|
+
fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_magic_link"
|
826
|
+
end
|
827
|
+
# verify the required parameter 'storefront_host_name' is set
|
828
|
+
if @api_client.config.client_side_validation && storefront_host_name.nil?
|
829
|
+
fail ArgumentError, "Missing the required parameter 'storefront_host_name' when calling CustomerApi.get_magic_link"
|
830
|
+
end
|
831
|
+
# resource path
|
832
|
+
local_var_path = '/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'storefront_host_name' + '}', storefront_host_name.to_s)
|
833
|
+
|
834
|
+
# query parameters
|
835
|
+
query_params = {}
|
836
|
+
|
837
|
+
# header parameters
|
838
|
+
header_params = {}
|
839
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
840
|
+
# HTTP header 'Accept' (if needed)
|
841
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
842
|
+
# HTTP header 'Content-Type'
|
843
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
844
|
+
|
845
|
+
# form parameters
|
846
|
+
form_params = {}
|
847
|
+
|
848
|
+
# http body (model)
|
849
|
+
post_body = nil
|
850
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
851
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
852
|
+
:header_params => header_params,
|
853
|
+
:query_params => query_params,
|
854
|
+
:form_params => form_params,
|
855
|
+
:body => post_body,
|
856
|
+
:auth_names => auth_names,
|
857
|
+
:return_type => 'CustomerMagicLinkResponse')
|
858
|
+
if @api_client.config.debugging
|
859
|
+
@api_client.config.logger.debug "API called: CustomerApi#get_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
860
|
+
end
|
861
|
+
return data, status_code, headers
|
862
|
+
end
|
802
863
|
# Insert a customer
|
803
864
|
# Insert a customer on the UltraCart account.
|
804
865
|
# @param customer Customer to insert
|
@@ -5898,6 +5898,53 @@ module UltracartClient
|
|
5898
5898
|
end
|
5899
5899
|
return data, status_code, headers
|
5900
5900
|
end
|
5901
|
+
# Get storefronts (internal use only for security reasons)
|
5902
|
+
# @param [Hash] opts the optional parameters
|
5903
|
+
# @return [StoreFrontsResponse]
|
5904
|
+
def get_store_fronts(opts = {})
|
5905
|
+
data, _status_code, _headers = get_store_fronts_with_http_info(opts)
|
5906
|
+
data
|
5907
|
+
end
|
5908
|
+
|
5909
|
+
# Get storefronts (internal use only for security reasons)
|
5910
|
+
# @param [Hash] opts the optional parameters
|
5911
|
+
# @return [Array<(StoreFrontsResponse, Fixnum, Hash)>] StoreFrontsResponse data, response status code and response headers
|
5912
|
+
def get_store_fronts_with_http_info(opts = {})
|
5913
|
+
if @api_client.config.debugging
|
5914
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
|
5915
|
+
end
|
5916
|
+
# resource path
|
5917
|
+
local_var_path = '/storefront'
|
5918
|
+
|
5919
|
+
# query parameters
|
5920
|
+
query_params = {}
|
5921
|
+
|
5922
|
+
# header parameters
|
5923
|
+
header_params = {}
|
5924
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
5925
|
+
# HTTP header 'Accept' (if needed)
|
5926
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5927
|
+
# HTTP header 'Content-Type'
|
5928
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5929
|
+
|
5930
|
+
# form parameters
|
5931
|
+
form_params = {}
|
5932
|
+
|
5933
|
+
# http body (model)
|
5934
|
+
post_body = nil
|
5935
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
5936
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
5937
|
+
:header_params => header_params,
|
5938
|
+
:query_params => query_params,
|
5939
|
+
:form_params => form_params,
|
5940
|
+
:body => post_body,
|
5941
|
+
:auth_names => auth_names,
|
5942
|
+
:return_type => 'StoreFrontsResponse')
|
5943
|
+
if @api_client.config.debugging
|
5944
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_store_fronts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5945
|
+
end
|
5946
|
+
return data, status_code, headers
|
5947
|
+
end
|
5901
5948
|
# Get thumbnail parameters
|
5902
5949
|
# @param thumbnail_parameters Thumbnail Parameters
|
5903
5950
|
# @param [Hash] opts the optional parameters
|
@@ -17,6 +17,9 @@ module UltracartClient
|
|
17
17
|
# The advertising source the customer indicated
|
18
18
|
attr_accessor :advertising_source
|
19
19
|
|
20
|
+
# True if the customer agrees to receiving marketing SMS messages
|
21
|
+
attr_accessor :cell_phone_opt_in
|
22
|
+
|
20
23
|
# True if the customer agrees to receiving marketing emails
|
21
24
|
attr_accessor :mailing_list_opt_in
|
22
25
|
|
@@ -24,6 +27,7 @@ module UltracartClient
|
|
24
27
|
def self.attribute_map
|
25
28
|
{
|
26
29
|
:'advertising_source' => :'advertising_source',
|
30
|
+
:'cell_phone_opt_in' => :'cell_phone_opt_in',
|
27
31
|
:'mailing_list_opt_in' => :'mailing_list_opt_in'
|
28
32
|
}
|
29
33
|
end
|
@@ -32,6 +36,7 @@ module UltracartClient
|
|
32
36
|
def self.swagger_types
|
33
37
|
{
|
34
38
|
:'advertising_source' => :'String',
|
39
|
+
:'cell_phone_opt_in' => :'BOOLEAN',
|
35
40
|
:'mailing_list_opt_in' => :'BOOLEAN'
|
36
41
|
}
|
37
42
|
end
|
@@ -48,6 +53,10 @@ module UltracartClient
|
|
48
53
|
self.advertising_source = attributes[:'advertising_source']
|
49
54
|
end
|
50
55
|
|
56
|
+
if attributes.has_key?(:'cell_phone_opt_in')
|
57
|
+
self.cell_phone_opt_in = attributes[:'cell_phone_opt_in']
|
58
|
+
end
|
59
|
+
|
51
60
|
if attributes.has_key?(:'mailing_list_opt_in')
|
52
61
|
self.mailing_list_opt_in = attributes[:'mailing_list_opt_in']
|
53
62
|
end
|
@@ -72,6 +81,7 @@ module UltracartClient
|
|
72
81
|
return true if self.equal?(o)
|
73
82
|
self.class == o.class &&
|
74
83
|
advertising_source == o.advertising_source &&
|
84
|
+
cell_phone_opt_in == o.cell_phone_opt_in &&
|
75
85
|
mailing_list_opt_in == o.mailing_list_opt_in
|
76
86
|
end
|
77
87
|
|
@@ -84,7 +94,7 @@ module UltracartClient
|
|
84
94
|
# Calculates hash code according to all attributes.
|
85
95
|
# @return [Fixnum] Hash code
|
86
96
|
def hash
|
87
|
-
[advertising_source, mailing_list_opt_in].hash
|
97
|
+
[advertising_source, cell_phone_opt_in, mailing_list_opt_in].hash
|
88
98
|
end
|
89
99
|
|
90
100
|
# Builds the object from hash
|
@@ -29,6 +29,8 @@ module UltracartClient
|
|
29
29
|
# Left conversation date/time
|
30
30
|
attr_accessor :left_dts
|
31
31
|
|
32
|
+
attr_accessor :profile_image_url
|
33
|
+
|
32
34
|
attr_accessor :status
|
33
35
|
|
34
36
|
attr_accessor :unread_messages
|
@@ -42,6 +44,7 @@ module UltracartClient
|
|
42
44
|
:'joined_dts' => :'joined_dts',
|
43
45
|
:'last_message_dts' => :'last_message_dts',
|
44
46
|
:'left_dts' => :'left_dts',
|
47
|
+
:'profile_image_url' => :'profile_image_url',
|
45
48
|
:'status' => :'status',
|
46
49
|
:'unread_messages' => :'unread_messages'
|
47
50
|
}
|
@@ -56,6 +59,7 @@ module UltracartClient
|
|
56
59
|
:'joined_dts' => :'String',
|
57
60
|
:'last_message_dts' => :'String',
|
58
61
|
:'left_dts' => :'String',
|
62
|
+
:'profile_image_url' => :'String',
|
59
63
|
:'status' => :'String',
|
60
64
|
:'unread_messages' => :'Integer'
|
61
65
|
}
|
@@ -93,6 +97,10 @@ module UltracartClient
|
|
93
97
|
self.left_dts = attributes[:'left_dts']
|
94
98
|
end
|
95
99
|
|
100
|
+
if attributes.has_key?(:'profile_image_url')
|
101
|
+
self.profile_image_url = attributes[:'profile_image_url']
|
102
|
+
end
|
103
|
+
|
96
104
|
if attributes.has_key?(:'status')
|
97
105
|
self.status = attributes[:'status']
|
98
106
|
end
|
@@ -126,6 +134,7 @@ module UltracartClient
|
|
126
134
|
joined_dts == o.joined_dts &&
|
127
135
|
last_message_dts == o.last_message_dts &&
|
128
136
|
left_dts == o.left_dts &&
|
137
|
+
profile_image_url == o.profile_image_url &&
|
129
138
|
status == o.status &&
|
130
139
|
unread_messages == o.unread_messages
|
131
140
|
end
|
@@ -139,7 +148,7 @@ module UltracartClient
|
|
139
148
|
# Calculates hash code according to all attributes.
|
140
149
|
# @return [Fixnum] Hash code
|
141
150
|
def hash
|
142
|
-
[conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, status, unread_messages].hash
|
151
|
+
[conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, profile_image_url, status, unread_messages].hash
|
143
152
|
end
|
144
153
|
|
145
154
|
# Builds the object from hash
|