ultracart_api 3.10.35 → 3.10.38
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/ConversationEventReadMessage.md +10 -0
- data/docs/ConversationMessage.md +1 -0
- data/docs/ConversationMessageTransportStatus.md +1 -1
- data/docs/ConversationParticipant.md +1 -0
- data/docs/ConversationWebsocketMessage.md +1 -0
- data/docs/CouponNoDiscount.md +1 -0
- data/docs/CustomerApi.md +54 -0
- data/docs/CustomerMagicLinkResponse.md +12 -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/conversation_event_read_message.rb +203 -0
- data/lib/ultracart_api/models/conversation_message.rb +11 -1
- data/lib/ultracart_api/models/conversation_message_transport_status.rb +35 -0
- data/lib/ultracart_api/models/conversation_participant.rb +13 -4
- data/lib/ultracart_api/models/conversation_websocket_message.rb +12 -3
- data/lib/ultracart_api/models/coupon_no_discount.rb +12 -2
- data/lib/ultracart_api/models/customer_magic_link_response.rb +222 -0
- 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: c9e126c9883f349713b1fd0f02b4d5567039b6d2f0f97fc4f851d41efb67fee9
|
4
|
+
data.tar.gz: 37ef0d0c9841e8370a221d8fced1ff3be1a3aac83c2c96a3851f46bf9d322dc2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f03922d07db66d388c2ab34e5957fa67e793163e84f3795ce4fa97d29ce5a987322911cf0b8e2b4333d66d8f75db3da1188896aa853a5a963995cf965d5be504
|
7
|
+
data.tar.gz: 984c0a4995aeb37f338fd6593d404454522a657ff4db1838d15b7f13bfbb997bc6520e60b119d124455bb1b95c60936f1133239f72a0133662ea4f8c4e95ff1c
|
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.38
|
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.38.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.38.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.38'
|
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
|
@@ -564,6 +566,7 @@ Class | Method | HTTP request | Description
|
|
564
566
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
565
567
|
- [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
|
566
568
|
- [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
|
569
|
+
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
567
570
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
568
571
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
569
572
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
@@ -660,6 +663,7 @@ Class | Method | HTTP request | Description
|
|
660
663
|
- [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
|
661
664
|
- [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
|
662
665
|
- [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
|
666
|
+
- [UltracartClient::CustomerMagicLinkResponse](docs/CustomerMagicLinkResponse.md)
|
663
667
|
- [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
|
664
668
|
- [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
|
665
669
|
- [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
|
@@ -1047,6 +1051,8 @@ Class | Method | HTTP request | Description
|
|
1047
1051
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
1048
1052
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
1049
1053
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
1054
|
+
- [UltracartClient::StoreFront](docs/StoreFront.md)
|
1055
|
+
- [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
|
1050
1056
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
1051
1057
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
1052
1058
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
@@ -1172,6 +1178,9 @@ Not every change is committed to every SDK.
|
|
1172
1178
|
|
1173
1179
|
| Version | Date | Comments |
|
1174
1180
|
| --: | :-: | --- |
|
1181
|
+
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
1182
|
+
| 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
1183
|
+
| 3.10.36 | 08/10/2022 | conversation event refactoring |
|
1175
1184
|
| 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
|
1176
1185
|
| 3.10.34 | 08/05/2022 | conversations query by medium and stats fixes |
|
1177
1186
|
| 3.10.33 | 08/03/2022 | conversation summary participants |
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::ConversationEventReadMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_message_uuid** | **String** | | [optional]
|
7
|
+
**message_dts** | **String** | Message date/time | [optional]
|
8
|
+
**message_epoch** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/ConversationMessage.md
CHANGED
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**media_urls** | **Array<String>** | | [optional]
|
12
12
|
**merchant_id** | **String** | | [optional]
|
13
13
|
**message_dts** | **String** | Message date/time | [optional]
|
14
|
+
**message_epoch** | **Integer** | Message epoch milliseconds | [optional]
|
14
15
|
**transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) | | [optional]
|
15
16
|
**type** | **String** | Message type | [optional]
|
16
17
|
**upload_keys** | **Array<String>** | | [optional]
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**conversation_participant_arn** | **String** | | [optional]
|
7
|
-
**status** | **String** |
|
7
|
+
**status** | **String** | The status of the message transport | [optional]
|
8
8
|
|
9
9
|
|
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
10
10
|
**last_message_dts** | **String** | Last message date/time | [optional]
|
11
11
|
**left_dts** | **String** | Left conversation date/time | [optional]
|
12
12
|
**status** | **String** | | [optional]
|
13
|
+
**unread_messages** | **Integer** | | [optional]
|
13
14
|
|
14
15
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**event_participant_update** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
|
11
11
|
**event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) | | [optional]
|
12
12
|
**event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) | | [optional]
|
13
|
+
**event_read_message** | [**ConversationEventReadMessage**](ConversationEventReadMessage.md) | | [optional]
|
13
14
|
**event_rrweb** | [**ConversationEventRRWeb**](ConversationEventRRWeb.md) | | [optional]
|
14
15
|
**event_type** | **String** | Type of event | [optional]
|
15
16
|
**event_typing** | [**ConversationEventTyping**](ConversationEventTyping.md) | | [optional]
|
data/docs/CouponNoDiscount.md
CHANGED
@@ -3,5 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**ignore_this_property** | **BOOLEAN** | This property does nothing but is included in this object to ensure the object is generated by our sdk builders. | [optional]
|
6
7
|
|
7
8
|
|
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/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
|
@@ -0,0 +1,203 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class ConversationEventReadMessage
|
17
|
+
attr_accessor :conversation_message_uuid
|
18
|
+
|
19
|
+
# Message date/time
|
20
|
+
attr_accessor :message_dts
|
21
|
+
|
22
|
+
attr_accessor :message_epoch
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'conversation_message_uuid' => :'conversation_message_uuid',
|
28
|
+
:'message_dts' => :'message_dts',
|
29
|
+
:'message_epoch' => :'message_epoch'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Attribute type mapping.
|
34
|
+
def self.swagger_types
|
35
|
+
{
|
36
|
+
:'conversation_message_uuid' => :'String',
|
37
|
+
:'message_dts' => :'String',
|
38
|
+
:'message_epoch' => :'Integer'
|
39
|
+
}
|
40
|
+
end
|
41
|
+
|
42
|
+
# Initializes the object
|
43
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
44
|
+
def initialize(attributes = {})
|
45
|
+
return unless attributes.is_a?(Hash)
|
46
|
+
|
47
|
+
# convert string to symbol for hash key
|
48
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
49
|
+
|
50
|
+
if attributes.has_key?(:'conversation_message_uuid')
|
51
|
+
self.conversation_message_uuid = attributes[:'conversation_message_uuid']
|
52
|
+
end
|
53
|
+
|
54
|
+
if attributes.has_key?(:'message_dts')
|
55
|
+
self.message_dts = attributes[:'message_dts']
|
56
|
+
end
|
57
|
+
|
58
|
+
if attributes.has_key?(:'message_epoch')
|
59
|
+
self.message_epoch = attributes[:'message_epoch']
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
64
|
+
# @return Array for valid properties with the reasons
|
65
|
+
def list_invalid_properties
|
66
|
+
invalid_properties = Array.new
|
67
|
+
invalid_properties
|
68
|
+
end
|
69
|
+
|
70
|
+
# Check to see if the all the properties in the model are valid
|
71
|
+
# @return true if the model is valid
|
72
|
+
def valid?
|
73
|
+
true
|
74
|
+
end
|
75
|
+
|
76
|
+
# Checks equality by comparing each attribute.
|
77
|
+
# @param [Object] Object to be compared
|
78
|
+
def ==(o)
|
79
|
+
return true if self.equal?(o)
|
80
|
+
self.class == o.class &&
|
81
|
+
conversation_message_uuid == o.conversation_message_uuid &&
|
82
|
+
message_dts == o.message_dts &&
|
83
|
+
message_epoch == o.message_epoch
|
84
|
+
end
|
85
|
+
|
86
|
+
# @see the `==` method
|
87
|
+
# @param [Object] Object to be compared
|
88
|
+
def eql?(o)
|
89
|
+
self == o
|
90
|
+
end
|
91
|
+
|
92
|
+
# Calculates hash code according to all attributes.
|
93
|
+
# @return [Fixnum] Hash code
|
94
|
+
def hash
|
95
|
+
[conversation_message_uuid, message_dts, message_epoch].hash
|
96
|
+
end
|
97
|
+
|
98
|
+
# Builds the object from hash
|
99
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
100
|
+
# @return [Object] Returns the model itself
|
101
|
+
def build_from_hash(attributes)
|
102
|
+
return nil unless attributes.is_a?(Hash)
|
103
|
+
self.class.swagger_types.each_pair do |key, type|
|
104
|
+
if type =~ /\AArray<(.*)>/i
|
105
|
+
# check to ensure the input is an array given that the attribute
|
106
|
+
# is documented as an array but the input is not
|
107
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
108
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
109
|
+
end
|
110
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
111
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
112
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
113
|
+
end
|
114
|
+
|
115
|
+
self
|
116
|
+
end
|
117
|
+
|
118
|
+
# Deserializes the data based on type
|
119
|
+
# @param string type Data type
|
120
|
+
# @param string value Value to be deserialized
|
121
|
+
# @return [Object] Deserialized data
|
122
|
+
def _deserialize(type, value)
|
123
|
+
case type.to_sym
|
124
|
+
when :DateTime
|
125
|
+
DateTime.parse(value)
|
126
|
+
when :Date
|
127
|
+
Date.parse(value)
|
128
|
+
when :String
|
129
|
+
value.to_s
|
130
|
+
when :Integer
|
131
|
+
value.to_i
|
132
|
+
when :Float
|
133
|
+
value.to_f
|
134
|
+
when :BOOLEAN
|
135
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
136
|
+
true
|
137
|
+
else
|
138
|
+
false
|
139
|
+
end
|
140
|
+
when :Object
|
141
|
+
# generic object (usually a Hash), return directly
|
142
|
+
value
|
143
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
144
|
+
inner_type = Regexp.last_match[:inner_type]
|
145
|
+
value.map { |v| _deserialize(inner_type, v) }
|
146
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
147
|
+
k_type = Regexp.last_match[:k_type]
|
148
|
+
v_type = Regexp.last_match[:v_type]
|
149
|
+
{}.tap do |hash|
|
150
|
+
value.each do |k, v|
|
151
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
else # model
|
155
|
+
temp_model = UltracartClient.const_get(type).new
|
156
|
+
temp_model.build_from_hash(value)
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
160
|
+
# Returns the string representation of the object
|
161
|
+
# @return [String] String presentation of the object
|
162
|
+
def to_s
|
163
|
+
to_hash.to_s
|
164
|
+
end
|
165
|
+
|
166
|
+
# to_body is an alias to to_hash (backward compatibility)
|
167
|
+
# @return [Hash] Returns the object in the form of hash
|
168
|
+
def to_body
|
169
|
+
to_hash
|
170
|
+
end
|
171
|
+
|
172
|
+
# Returns the object in the form of hash
|
173
|
+
# @return [Hash] Returns the object in the form of hash
|
174
|
+
def to_hash
|
175
|
+
hash = {}
|
176
|
+
self.class.attribute_map.each_pair do |attr, param|
|
177
|
+
value = self.send(attr)
|
178
|
+
next if value.nil?
|
179
|
+
hash[param] = _to_hash(value)
|
180
|
+
end
|
181
|
+
hash
|
182
|
+
end
|
183
|
+
|
184
|
+
# Outputs non-array value in the form of hash
|
185
|
+
# For object, use to_hash. Otherwise, just return the value
|
186
|
+
# @param [Object] value Any valid value
|
187
|
+
# @return [Hash] Returns the value in the form of hash
|
188
|
+
def _to_hash(value)
|
189
|
+
if value.is_a?(Array)
|
190
|
+
value.compact.map { |v| _to_hash(v) }
|
191
|
+
elsif value.is_a?(Hash)
|
192
|
+
{}.tap do |hash|
|
193
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
194
|
+
end
|
195
|
+
elsif value.respond_to? :to_hash
|
196
|
+
value.to_hash
|
197
|
+
else
|
198
|
+
value
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
end
|
203
|
+
end
|