ultracart_api 4.0.54.rc → 4.0.57.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 +13 -4
- data/docs/CartMarketing.md +2 -0
- data/docs/ConversationParticipant.md +2 -0
- data/docs/ConversationWebchatQueueStatusAgent.md +4 -2
- data/docs/CustomerApi.md +74 -0
- data/docs/CustomerMagicLinkResponse.md +26 -0
- data/docs/ItemReview.md +90 -0
- data/docs/ItemReviews.md +2 -0
- data/docs/OrderBilling.md +4 -0
- data/docs/OrderMarketing.md +2 -0
- data/docs/StoreFront.md +38 -0
- data/docs/StoreFrontsResponse.md +26 -0
- data/docs/StorefrontApi.md +67 -0
- data/lib/ultracart_api/api/customer_api.rb +70 -0
- data/lib/ultracart_api/api/storefront_api.rb +56 -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 +257 -0
- 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/models/store_front.rb +309 -0
- data/lib/ultracart_api/models/store_fronts_response.rb +258 -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: ee07e55d28cc155e358d34522081bb645d071fe8bfeda16dddc2fe489e9ea721
|
4
|
+
data.tar.gz: 7e06c34ed7e736e0360e94fe92598737084ffa1ded7a580c28adea3ae40773e0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ed212a1d617bb5adb14d72537d6aecbea01777353be997c45219ef280b40bba683d50f94149faee9f5c61ce9daf06564c711b6911057c22f070092783a5c7b47
|
7
|
+
data.tar.gz: 8358ed8300774d4c286063594809c636f2ab29e9af1d846cb7694cdbb4c34a5014337ab3792b893381eae6aacd6d656cfcad2958aecd932ce736ab35cedd1b24
|
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.57.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.57.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.57.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.57.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -171,6 +171,7 @@ Class | Method | HTTP request | Description
|
|
171
171
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
172
172
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
173
173
|
*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
|
174
|
+
*UltracartClient::CustomerApi* | [**get_magic_link**](docs/CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
174
175
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
175
176
|
*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
176
177
|
*UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
@@ -335,6 +336,7 @@ Class | Method | HTTP request | Description
|
|
335
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
|
336
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
|
337
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 | Get storefronts (internal use only for security reasons)
|
338
340
|
*UltracartClient::StorefrontApi* | [**get_thumbnail_parameters**](docs/StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
|
339
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
|
340
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
|
@@ -667,6 +669,7 @@ Class | Method | HTTP request | Description
|
|
667
669
|
- [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
|
668
670
|
- [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
|
669
671
|
- [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
|
672
|
+
- [UltracartClient::CustomerMagicLinkResponse](docs/CustomerMagicLinkResponse.md)
|
670
673
|
- [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
|
671
674
|
- [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
|
672
675
|
- [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
|
@@ -886,6 +889,7 @@ Class | Method | HTTP request | Description
|
|
886
889
|
- [UltracartClient::ItemRestriction](docs/ItemRestriction.md)
|
887
890
|
- [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
|
888
891
|
- [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
|
892
|
+
- [UltracartClient::ItemReview](docs/ItemReview.md)
|
889
893
|
- [UltracartClient::ItemReviews](docs/ItemReviews.md)
|
890
894
|
- [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
|
891
895
|
- [UltracartClient::ItemShipping](docs/ItemShipping.md)
|
@@ -1054,6 +1058,8 @@ Class | Method | HTTP request | Description
|
|
1054
1058
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
1055
1059
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
1056
1060
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
1061
|
+
- [UltracartClient::StoreFront](docs/StoreFront.md)
|
1062
|
+
- [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
|
1057
1063
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
1058
1064
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
1059
1065
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
@@ -1182,6 +1188,9 @@ Not every change is committed to every SDK.
|
|
1182
1188
|
|
1183
1189
|
| Version | Date | Comments |
|
1184
1190
|
| --: | :-: | --- |
|
1191
|
+
| 4.0.57-RC | 08/22/2022 | exposing individual reviews within item.review object |
|
1192
|
+
| 4.0.56-RC | 08/19/2022 | order api - added cell phone fields for sms |
|
1193
|
+
| 4.0.55-RC | 08/12/2022 | internal code to allow merchant login as customer |
|
1185
1194
|
| 4.0.54-RC | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
1186
1195
|
| 4.0.53-RC | 08/10/2022 | conversation event refactoring |
|
1187
1196
|
| 4.0.52-RC | 08/05/2022 | conversation adjustments for ES integration |
|
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
|
|
data/docs/CustomerApi.md
CHANGED
@@ -16,6 +16,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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) |
|
@@ -959,6 +960,79 @@ end
|
|
959
960
|
- **Accept**: application/json
|
960
961
|
|
961
962
|
|
963
|
+
## get_magic_link
|
964
|
+
|
965
|
+
> <CustomerMagicLinkResponse> get_magic_link(customer_profile_oid, storefront_host_name)
|
966
|
+
|
967
|
+
getMagicLink
|
968
|
+
|
969
|
+
Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
970
|
+
|
971
|
+
### Examples
|
972
|
+
|
973
|
+
```ruby
|
974
|
+
require 'time'
|
975
|
+
require 'ultracart_api'
|
976
|
+
require 'json'
|
977
|
+
require 'yaml'
|
978
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
979
|
+
|
980
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
981
|
+
# As such, this might not be the best way to use this object.
|
982
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
983
|
+
|
984
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
985
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid of the customer.
|
986
|
+
storefront_host_name = 'storefront_host_name_example' # String | The storefront to log into.
|
987
|
+
|
988
|
+
begin
|
989
|
+
# getMagicLink
|
990
|
+
result = api_instance.get_magic_link(customer_profile_oid, storefront_host_name)
|
991
|
+
p result
|
992
|
+
rescue UltracartClient::ApiError => e
|
993
|
+
puts "Error when calling CustomerApi->get_magic_link: #{e}"
|
994
|
+
end
|
995
|
+
```
|
996
|
+
|
997
|
+
#### Using the get_magic_link_with_http_info variant
|
998
|
+
|
999
|
+
This returns an Array which contains the response data, status code and headers.
|
1000
|
+
|
1001
|
+
> <Array(<CustomerMagicLinkResponse>, Integer, Hash)> get_magic_link_with_http_info(customer_profile_oid, storefront_host_name)
|
1002
|
+
|
1003
|
+
```ruby
|
1004
|
+
begin
|
1005
|
+
# getMagicLink
|
1006
|
+
data, status_code, headers = api_instance.get_magic_link_with_http_info(customer_profile_oid, storefront_host_name)
|
1007
|
+
p status_code # => 2xx
|
1008
|
+
p headers # => { ... }
|
1009
|
+
p data # => <CustomerMagicLinkResponse>
|
1010
|
+
rescue UltracartClient::ApiError => e
|
1011
|
+
puts "Error when calling CustomerApi->get_magic_link_with_http_info: #{e}"
|
1012
|
+
end
|
1013
|
+
```
|
1014
|
+
|
1015
|
+
### Parameters
|
1016
|
+
|
1017
|
+
| Name | Type | Description | Notes |
|
1018
|
+
| ---- | ---- | ----------- | ----- |
|
1019
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid of the customer. | |
|
1020
|
+
| **storefront_host_name** | **String** | The storefront to log into. | |
|
1021
|
+
|
1022
|
+
### Return type
|
1023
|
+
|
1024
|
+
[**CustomerMagicLinkResponse**](CustomerMagicLinkResponse.md)
|
1025
|
+
|
1026
|
+
### Authorization
|
1027
|
+
|
1028
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1029
|
+
|
1030
|
+
### HTTP request headers
|
1031
|
+
|
1032
|
+
- **Content-Type**: Not defined
|
1033
|
+
- **Accept**: application/json
|
1034
|
+
|
1035
|
+
|
962
1036
|
## insert_customer
|
963
1037
|
|
964
1038
|
> <CustomerResponse> insert_customer(customer, opts)
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomerMagicLinkResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **url** | **String** | URL | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::CustomerMagicLinkResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
url: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
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/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/StoreFront.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# UltracartClient::StoreFront
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **host_alias1** | **String** | | [optional] |
|
8
|
+
| **host_alias2** | **String** | | [optional] |
|
9
|
+
| **host_alias3** | **String** | | [optional] |
|
10
|
+
| **host_alias4** | **String** | | [optional] |
|
11
|
+
| **host_alias5** | **String** | | [optional] |
|
12
|
+
| **host_name** | **String** | | [optional] |
|
13
|
+
| **locked** | **Boolean** | | [optional] |
|
14
|
+
| **merchant_id** | **String** | | [optional] |
|
15
|
+
| **redirect_aliases** | **Boolean** | | [optional] |
|
16
|
+
| **storefront_oid** | **Integer** | | [optional] |
|
17
|
+
| **unlock_password** | **String** | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'ultracart_api'
|
23
|
+
|
24
|
+
instance = UltracartClient::StoreFront.new(
|
25
|
+
host_alias1: null,
|
26
|
+
host_alias2: null,
|
27
|
+
host_alias3: null,
|
28
|
+
host_alias4: null,
|
29
|
+
host_alias5: null,
|
30
|
+
host_name: null,
|
31
|
+
locked: null,
|
32
|
+
merchant_id: null,
|
33
|
+
redirect_aliases: null,
|
34
|
+
storefront_oid: null,
|
35
|
+
unlock_password: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::StoreFrontsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **store_fronts** | [**Array<StoreFront>**](StoreFront.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::StoreFrontsResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
store_fronts: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/StorefrontApi.md
CHANGED
@@ -105,6 +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 | 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 |
|
@@ -7380,6 +7381,72 @@ end
|
|
7380
7381
|
- **Accept**: application/json
|
7381
7382
|
|
7382
7383
|
|
7384
|
+
## get_store_fronts
|
7385
|
+
|
7386
|
+
> <StoreFrontsResponse> get_store_fronts
|
7387
|
+
|
7388
|
+
Get storefronts (internal use only for security reasons)
|
7389
|
+
|
7390
|
+
### Examples
|
7391
|
+
|
7392
|
+
```ruby
|
7393
|
+
require 'time'
|
7394
|
+
require 'ultracart_api'
|
7395
|
+
require 'json'
|
7396
|
+
require 'yaml'
|
7397
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
7398
|
+
|
7399
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
7400
|
+
# As such, this might not be the best way to use this object.
|
7401
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
7402
|
+
|
7403
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
7404
|
+
|
7405
|
+
begin
|
7406
|
+
# Get storefronts (internal use only for security reasons)
|
7407
|
+
result = api_instance.get_store_fronts
|
7408
|
+
p result
|
7409
|
+
rescue UltracartClient::ApiError => e
|
7410
|
+
puts "Error when calling StorefrontApi->get_store_fronts: #{e}"
|
7411
|
+
end
|
7412
|
+
```
|
7413
|
+
|
7414
|
+
#### Using the get_store_fronts_with_http_info variant
|
7415
|
+
|
7416
|
+
This returns an Array which contains the response data, status code and headers.
|
7417
|
+
|
7418
|
+
> <Array(<StoreFrontsResponse>, Integer, Hash)> get_store_fronts_with_http_info
|
7419
|
+
|
7420
|
+
```ruby
|
7421
|
+
begin
|
7422
|
+
# Get storefronts (internal use only for security reasons)
|
7423
|
+
data, status_code, headers = api_instance.get_store_fronts_with_http_info
|
7424
|
+
p status_code # => 2xx
|
7425
|
+
p headers # => { ... }
|
7426
|
+
p data # => <StoreFrontsResponse>
|
7427
|
+
rescue UltracartClient::ApiError => e
|
7428
|
+
puts "Error when calling StorefrontApi->get_store_fronts_with_http_info: #{e}"
|
7429
|
+
end
|
7430
|
+
```
|
7431
|
+
|
7432
|
+
### Parameters
|
7433
|
+
|
7434
|
+
This endpoint does not need any parameter.
|
7435
|
+
|
7436
|
+
### Return type
|
7437
|
+
|
7438
|
+
[**StoreFrontsResponse**](StoreFrontsResponse.md)
|
7439
|
+
|
7440
|
+
### Authorization
|
7441
|
+
|
7442
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
7443
|
+
|
7444
|
+
### HTTP request headers
|
7445
|
+
|
7446
|
+
- **Content-Type**: Not defined
|
7447
|
+
- **Accept**: application/json
|
7448
|
+
|
7449
|
+
|
7383
7450
|
## get_thumbnail_parameters
|
7384
7451
|
|
7385
7452
|
> <ThumbnailParametersResponse> get_thumbnail_parameters(thumbnail_parameters)
|
@@ -928,6 +928,76 @@ module UltracartClient
|
|
928
928
|
return data, status_code, headers
|
929
929
|
end
|
930
930
|
|
931
|
+
# getMagicLink
|
932
|
+
# Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
933
|
+
# @param customer_profile_oid [Integer] The customer_profile_oid of the customer.
|
934
|
+
# @param storefront_host_name [String] The storefront to log into.
|
935
|
+
# @param [Hash] opts the optional parameters
|
936
|
+
# @return [CustomerMagicLinkResponse]
|
937
|
+
def get_magic_link(customer_profile_oid, storefront_host_name, opts = {})
|
938
|
+
data, _status_code, _headers = get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts)
|
939
|
+
data
|
940
|
+
end
|
941
|
+
|
942
|
+
# getMagicLink
|
943
|
+
# Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
944
|
+
# @param customer_profile_oid [Integer] The customer_profile_oid of the customer.
|
945
|
+
# @param storefront_host_name [String] The storefront to log into.
|
946
|
+
# @param [Hash] opts the optional parameters
|
947
|
+
# @return [Array<(CustomerMagicLinkResponse, Integer, Hash)>] CustomerMagicLinkResponse data, response status code and response headers
|
948
|
+
def get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts = {})
|
949
|
+
if @api_client.config.debugging
|
950
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.get_magic_link ...'
|
951
|
+
end
|
952
|
+
# verify the required parameter 'customer_profile_oid' is set
|
953
|
+
if @api_client.config.client_side_validation && customer_profile_oid.nil?
|
954
|
+
fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_magic_link"
|
955
|
+
end
|
956
|
+
# verify the required parameter 'storefront_host_name' is set
|
957
|
+
if @api_client.config.client_side_validation && storefront_host_name.nil?
|
958
|
+
fail ArgumentError, "Missing the required parameter 'storefront_host_name' when calling CustomerApi.get_magic_link"
|
959
|
+
end
|
960
|
+
# resource path
|
961
|
+
local_var_path = '/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}'.sub('{' + 'customer_profile_oid' + '}', CGI.escape(customer_profile_oid.to_s)).sub('{' + 'storefront_host_name' + '}', CGI.escape(storefront_host_name.to_s))
|
962
|
+
|
963
|
+
# query parameters
|
964
|
+
query_params = opts[:query_params] || {}
|
965
|
+
|
966
|
+
# header parameters
|
967
|
+
header_params = opts[:header_params] || {}
|
968
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
969
|
+
# HTTP header 'Accept' (if needed)
|
970
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
971
|
+
|
972
|
+
# form parameters
|
973
|
+
form_params = opts[:form_params] || {}
|
974
|
+
|
975
|
+
# http body (model)
|
976
|
+
post_body = opts[:debug_body]
|
977
|
+
|
978
|
+
# return_type
|
979
|
+
return_type = opts[:debug_return_type] || 'CustomerMagicLinkResponse'
|
980
|
+
|
981
|
+
# auth_names
|
982
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
983
|
+
|
984
|
+
new_options = opts.merge(
|
985
|
+
:operation => :"CustomerApi.get_magic_link",
|
986
|
+
:header_params => header_params,
|
987
|
+
:query_params => query_params,
|
988
|
+
:form_params => form_params,
|
989
|
+
:body => post_body,
|
990
|
+
:auth_names => auth_names,
|
991
|
+
:return_type => return_type
|
992
|
+
)
|
993
|
+
|
994
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
995
|
+
if @api_client.config.debugging
|
996
|
+
@api_client.config.logger.debug "API called: CustomerApi#get_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
997
|
+
end
|
998
|
+
return data, status_code, headers
|
999
|
+
end
|
1000
|
+
|
931
1001
|
# Insert a customer
|
932
1002
|
# Insert a customer on the UltraCart account.
|
933
1003
|
# @param customer [Customer] Customer to insert
|